Merge pull request #6173 from wcomartin/master

add angular-dialog-service typescript definitions
2026-09-07 16:30:12 +08:00 · 2015-10-27 00:21:08 +09:00
parent 2f630736c9 0078ccfafc
commit 7b706b9013
2 changed files with 98 additions and 0 deletions
@@ -0,0 +1,16 @@
+/// <reference path="angular-dialog-service.d.ts" />
+
+
+var options : angular.dialogservice.IDialogOptions = {};
+options.animation = true;
+options.backdrop = true;
+options.keyboard = true;
+options.backdropClass = "some-css-class";
+options.windowClass = "some-css-class";
+options.size = 'md';
+
+var dialogs : angular.dialogservice.IDialogService;
+dialogs.error('Error','An unknown error occurred preventing the completion of the requested action.');
+dialogs.wait('Creating User','Please wait while we attempt to create user "Michael Conroy."<br><br>This should only take a moment.',50);
+dialogs.notify('Something Happened','Something happened at this point in the application that I wish to let you know about');
+dialogs.create('url/to/a/template','ctrlrToUse',{},{});
@@ -0,0 +1,82 @@
+// Type definitions for Angular Dialog Service 5.2.8
+// Project: https://github.com/m-e-conroy/angular-dialog-service
+// Definitions by: William Comartin <https://github.com/wcomartin>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+/// <reference path="../angularjs/angular.d.ts"/>
+/// <reference path="../angular-ui-bootstrap/angular-ui-bootstrap.d.ts"/>
+
+declare module angular.dialogservice {
+
+  interface IDialogOptions {
+    /**
+     * Set to false to disable animations on new modal/backdrop. Does not toggle animations for modals/backdrops that are already displayed.
+     *
+     * @default false
+     */
+    animation?: boolean;
+
+    /**
+     * controls the presence of a backdrop
+     * Allowed values:
+     *   - true (default)
+     *   - false (no backdrop)
+     *   - 'static' backdrop is present but modal window is not closed when clicking outside of the modal window
+     *
+     * @default true
+     */
+    backdrop?: boolean | string;
+
+    /**
+     * indicates whether the dialog should be closable by hitting the ESC key
+     *
+     * @default true
+     */
+    keyboard?: boolean;
+
+    /**
+     * additional CSS class(es) to be added to a modal backdrop template
+     *
+     * @default 'dialogs-backdrop-default'
+     */
+    backdropClass?: string;
+
+    /**
+     * additional CSS class(es) to be added to a modal window template
+     *
+     * @default 'dialogs-default'
+     */
+    windowClass?: string;
+
+    /**
+     * Optional suffix of modal window class. The value used is appended to the `modal-` class, i.e. a value of `sm` gives `modal-sm`.
+     *
+     * @default 'lg'
+     */
+    size?: string;
+  }
+
+  interface IDialogService {
+    /**
+     * Opens a new error modal instance.
+     */
+    error(header: string, msg: string, opts?: IDialogOptions): ng.ui.bootstrap.IModalServiceInstance
+    /**
+     * Opens a new wait modal instance.
+     */
+    wait(header: string, msg: string, progress: number, opts?: IDialogOptions): ng.ui.bootstrap.IModalServiceInstance
+    /**
+     * Opens a new notify modal instance.
+     */
+    notify(header: string, msg: string, opts?: IDialogOptions): ng.ui.bootstrap.IModalServiceInstance
+    /**
+     * Opens a new confirm modal instance.
+     */
+    confirm(header: string, msg: string, opts?: IDialogOptions): ng.ui.bootstrap.IModalServiceInstance
+    /**
+     * Opens a new custom modal instance.
+     */
+    create(url: string, ctrlr: string, data: any, opts?: IDialogOptions): ng.ui.bootstrap.IModalServiceInstance
+  }
+
+}