mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2026-08-13 05:20:25 +00:00
- extend the typings reading the official docs of ngDialog
This commit is contained in:
Michael Wittwer
@@ -39,7 +39,7 @@ class DialogTestController {
|
||||
|
||||
class LoginDialogController {
|
||||
|
||||
constructor($scope: angular.dialog.IDialogScope) {
|
||||
constructor($scope:angular.dialog.IDialogOpenScope) {
|
||||
|
||||
$scope.closeThisDialog("bye");
|
||||
}
|
||||
|
||||
Vendored
+222
-87
@@ -7,104 +7,239 @@
|
||||
|
||||
declare module angular.dialog {
|
||||
|
||||
interface IDialogService {
|
||||
getDefaults(): IDialogOptions;
|
||||
open(options: IDialogOpenOptions): IDialogOpenResult;
|
||||
openConfirm(options: IDialogOpenOptions): IPromise<any>;
|
||||
/*
|
||||
* Everytime ngDialog is opened or closed we're broadcasting three events
|
||||
* (dispatching events downwards to all child scopes):
|
||||
*
|
||||
* for more info see: https://github.com/likeastore/ngDialog#events
|
||||
*/
|
||||
export const EVENT_OPENEND:string = 'ngDialog.opened';
|
||||
export const EVENT_CLOSING:string = 'ngDialog.closing';
|
||||
export const EVENT_CLOSED:string = 'ngDialog.closed';
|
||||
|
||||
/**
|
||||
* Determine whether the specified dialog is open or not.
|
||||
* @param id Dialog id to check for.
|
||||
* @returns {boolean} Indicating whether it exists or not.
|
||||
*/
|
||||
isOpen(id: string): boolean;
|
||||
close(id: string, value?: any): void;
|
||||
closeAll(value?: any): void;
|
||||
getOpenDialogs(): string[];
|
||||
}
|
||||
|
||||
interface IDialogOpenResult {
|
||||
id: string;
|
||||
close: (value?: string) => void;
|
||||
closePromise: IPromise<IDialogClosePromise>;
|
||||
}
|
||||
interface IDialogService {
|
||||
getDefaults(): IDialogOptions;
|
||||
open(options:IDialogOpenOptions): IDialogOpenResult;
|
||||
openConfirm(options:IDialogOpenConfirmOptions): IPromise<any>;
|
||||
|
||||
interface IDialogClosePromise {
|
||||
id: string;
|
||||
value: any;
|
||||
}
|
||||
/**
|
||||
* Determine whether the specified dialog is open or not.
|
||||
* @param id Dialog id to check for.
|
||||
* @returns {boolean} Indicating whether it exists or not.
|
||||
*/
|
||||
isOpen(id:string): boolean;
|
||||
close(id:string, value?:any): void;
|
||||
closeAll(value?:any): void;
|
||||
getOpenDialogs(): string[];
|
||||
}
|
||||
|
||||
interface IDialogProvider extends angular.IServiceProvider {
|
||||
/**
|
||||
* Default options for the dialogs.
|
||||
* @param defaultOptions
|
||||
* @returns {}
|
||||
*/
|
||||
setDefaults(defaultOptions: IDialogOptions): void;
|
||||
}
|
||||
interface IDialogOpenResult {
|
||||
id: string;
|
||||
close: (value?:any) => void;
|
||||
closePromise: IPromise<IDialogClosePromise>;
|
||||
}
|
||||
|
||||
/**
|
||||
* Dialog Scope which extends the $scope.
|
||||
*/
|
||||
interface IDialogScope extends angular.IScope {
|
||||
/**
|
||||
* This allows you to close dialog straight from handler in a popup element.
|
||||
* @param value Any value passed to this function will be attached to the object which resolves on the close promise for this dialog.
|
||||
* For dialogs opened with the openConfirm() method the value is used as the reject reason.
|
||||
*/
|
||||
closeThisDialog(value?: any): void;
|
||||
}
|
||||
interface IDialogClosePromise {
|
||||
id: string;
|
||||
value: any;
|
||||
}
|
||||
|
||||
interface IDialogOptions {
|
||||
/**
|
||||
* This option allows you to control the dialog's look, you can use built-in themes or create your own styled modals.
|
||||
* It will be appended with the "ngdialog" class e.g. className is "default-theme flat-ui" it will be class="ngdialog default-theme flat-ui".
|
||||
*/
|
||||
className?: string;
|
||||
/**
|
||||
* If false it allows to hide overlay div behind the modals, default true.
|
||||
*/
|
||||
overlay?: boolean;
|
||||
interface IDialogProvider extends angular.IServiceProvider {
|
||||
/**
|
||||
* Default options for the dialogs.
|
||||
* @param defaultOptions
|
||||
* @returns {}
|
||||
*/
|
||||
setDefaults(defaultOptions:IDialogOptions): void;
|
||||
|
||||
/**
|
||||
* If false it allows to hide close button on modals, default true.
|
||||
*/
|
||||
showClose?: boolean;
|
||||
/**
|
||||
* Adds an additional listener on every $locationChangeSuccess event and gets update version of html into dialog.
|
||||
* May be useful in some rare cases when you're dependant on DOM changes, defaults to false.
|
||||
* @param {boolean} force
|
||||
*/
|
||||
setForceHtmlReload(force:boolean) : void;
|
||||
|
||||
/**
|
||||
* It allows to close modals by clicking Esc button, default true.
|
||||
* This will close all open modals if there several of them open at the same time.
|
||||
*/
|
||||
closeByEscape?: boolean;
|
||||
/**
|
||||
* Adds additional listener on every $locationChangeSuccess event and gets updated version of body into dialog.
|
||||
* Maybe useful in some rare cases when you're dependant on DOM changes, defaults to false. Use it in module's
|
||||
* config as provider instance:
|
||||
* @param {boolean} force
|
||||
*/
|
||||
setForceBodyReload(force:boolean) : void;
|
||||
}
|
||||
|
||||
/**
|
||||
* It allows to close modals by clicking on overlay background, default true. If @see Hammer.js is loaded, it will listen for tap instead of click.
|
||||
*/
|
||||
closeByDocument?: boolean;
|
||||
/**
|
||||
* Dialog Scope which extends the $scope.
|
||||
*/
|
||||
interface IDialogOpenScope extends angular.IScope {
|
||||
/**
|
||||
* This allows you to close dialog straight from handler in a popup element.
|
||||
* @param value Any value passed to this function will be attached to the object which resolves on the close promise for this dialog.
|
||||
* For dialogs opened with the openConfirm() method the value is used as the reject reason.
|
||||
*/
|
||||
closeThisDialog(value?:any): void;
|
||||
}
|
||||
|
||||
/**
|
||||
* If true allows to use plain string as template, default false.
|
||||
*/
|
||||
plain?: boolean;
|
||||
interface IDialogOpenConfirmScope extends IDialogOpenScope {
|
||||
/**
|
||||
* Use this method to close the dialog and resolve the promise that was returned when opening the modal.
|
||||
*
|
||||
* The function accepts a single optional parameter which is used as the value of the resolved promise.
|
||||
* @param {any} [value] - The value with which the promise will resolve
|
||||
*/
|
||||
confirm(value?:any)
|
||||
}
|
||||
|
||||
/**
|
||||
* Give a name for a dialog instance. It is useful for identifying specific dialog if there are multiple dialog boxes opened.
|
||||
*/
|
||||
name?: string | number;
|
||||
interface IDialogOptions {
|
||||
/**
|
||||
* This option allows you to control the dialog's look, you can use built-in themes or create your own styled modals.
|
||||
* It will be appended with the "ngdialog" class e.g. className is "default-theme flat-ui" it will be class="ngdialog default-theme flat-ui".
|
||||
*/
|
||||
className?: string;
|
||||
|
||||
preCloseCallback?: string|Function;
|
||||
}
|
||||
/**
|
||||
* If true then animation for the dialog will be disabled, default false.
|
||||
*/
|
||||
disableAnimation?: boolean;
|
||||
|
||||
/**
|
||||
* Options which are provided to open a dialog.
|
||||
*/
|
||||
interface IDialogOpenOptions extends IDialogOptions {
|
||||
template: string;
|
||||
controller?: string|any;
|
||||
controllerAs?: string;
|
||||
/**
|
||||
* Scope object that will be passed to dialog. If you use controller with separate $scope service this object will be passed to $scope.$parent param.
|
||||
*/
|
||||
scope?: ng.IScope;
|
||||
}
|
||||
/**
|
||||
* If false it allows to hide overlay div behind the modals, default true.
|
||||
*/
|
||||
overlay?: boolean;
|
||||
|
||||
/**
|
||||
* If false it allows to hide close button on modals, default true.
|
||||
*/
|
||||
showClose?: boolean;
|
||||
|
||||
/**
|
||||
* It allows to close modals by clicking Esc button, default true.
|
||||
* This will close all open modals if there several of them open at the same time.
|
||||
*/
|
||||
closeByEscape?: boolean;
|
||||
|
||||
/**
|
||||
* It allows to close modals by clicking on overlay background, default true. If @see Hammer.js is loaded, it will listen for tap instead of click.
|
||||
*/
|
||||
closeByDocument?: boolean;
|
||||
|
||||
/**
|
||||
* default : false
|
||||
*/
|
||||
closeByNavigation?: boolean;
|
||||
|
||||
|
||||
/**
|
||||
* If true allows to use plain string as template, default false.
|
||||
*/
|
||||
plain?: boolean;
|
||||
|
||||
/**
|
||||
* Give a name for a dialog instance. It is useful for identifying specific dialog if there are multiple dialog boxes opened.
|
||||
*/
|
||||
name?: string | number;
|
||||
|
||||
/**
|
||||
* Provide either the name of a function or a function to be called before the dialog is closed.
|
||||
* If the callback function specified in the option returns false then the dialog will not be closed.
|
||||
* Alternatively, if the callback function returns a promise that gets resolved the dialog will be closed.
|
||||
*
|
||||
* more: https://github.com/likeastore/ngDialog#preclosecallback-string--function
|
||||
*/
|
||||
preCloseCallback?: string|Function;
|
||||
|
||||
/**
|
||||
* Pass false to disable template caching. Useful for developing purposes, default is true.
|
||||
*/
|
||||
cache? : boolean;
|
||||
|
||||
/**
|
||||
* Specify your element where to append dialog instance, accepts selector string (e.g. #yourId, .yourClass).
|
||||
* If not specified appends dialog to body as default behavior.
|
||||
*/
|
||||
appendTo? : string;
|
||||
|
||||
/**
|
||||
* When true, ensures that the focused element remains within the dialog to conform to accessibility recommendations.
|
||||
* Default value is true
|
||||
*/
|
||||
trapFocus?: boolean;
|
||||
|
||||
/**
|
||||
* When true, closing the dialog restores focus to the element that launched it. Designed to improve keyboard
|
||||
* accessibility. Default value is true
|
||||
*/
|
||||
preserveFocus? : boolean;
|
||||
|
||||
/**
|
||||
* When true, automatically selects appropriate values for any unspecified accessibility attributes. Default value is true
|
||||
*/
|
||||
ariaAuto? : boolean;
|
||||
|
||||
/**
|
||||
* Specifies the value for the role attribute that should be applied to the dialog element. Default value is null (unspecified)
|
||||
*/
|
||||
ariaRole? : string;
|
||||
|
||||
/**
|
||||
* Specifies the value for the aria-labelledby attribute that should be applied to the dialog element.
|
||||
* Default value is null (unspecified)
|
||||
*
|
||||
* If specified, the value is not validated against the DOM
|
||||
*/
|
||||
ariaLabelledById?: string;
|
||||
|
||||
/**
|
||||
* Specifies the CSS selector for the element to be referenced by the aria-labelledby attribute on the dialog element. Default value is null (unspecified)
|
||||
*
|
||||
* If specified, the first matching element is used.
|
||||
*/
|
||||
ariaLabelledBySelector?: string;
|
||||
|
||||
/**
|
||||
* Specifies the value for the aria-describedby attribute that should be applied to the dialog element. Default value is null (unspecified)
|
||||
*
|
||||
* If specified, the value is not validated against the DOM.
|
||||
*/
|
||||
ariaDescribedById?: string;
|
||||
|
||||
/**
|
||||
* Specifies the CSS selector for the element to be referenced by the aria-describedby attribute on the dialog element. Default value is null (unspecified)
|
||||
*
|
||||
* If specified, the first matching element is used.
|
||||
*/
|
||||
ariaDescribedBySelector?: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Options which are provided to open a dialog.
|
||||
*/
|
||||
interface IDialogOpenOptions extends IDialogOptions {
|
||||
template: string;
|
||||
controller?: string| any[] | any;
|
||||
controllerAs?: string;
|
||||
|
||||
/**
|
||||
* Scope object that will be passed to dialog. If you use controller with separate $scope service this object will be passed to $scope.$parent param.
|
||||
*/
|
||||
scope?: IDialogOpenScope;
|
||||
|
||||
/**
|
||||
* An optional map of dependencies which should be injected into the controller. If any of these dependencies
|
||||
* are promises, ngDialog will wait for them all to be resolved or one to be rejected before the controller
|
||||
* is instantiated.
|
||||
*/
|
||||
resolve? : {[key : string] : string | Function};
|
||||
|
||||
/**
|
||||
* Any serializable data that you want to be stored in the controller's dialog scope. ($scope.ngDialogData).
|
||||
* From version 0.3.6 $scope.ngDialogData keeps references to the objects instead of copying them.
|
||||
*/
|
||||
data? : string | {} | any[];
|
||||
}
|
||||
|
||||
interface IDialogOpenConfirmOptions extends IDialogOpenOptions {
|
||||
scope? : IDialogOpenConfirmScope;
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user