Merge pull request #4845 from robertbaker/patch-5

Updated Typings to 10.1 RC1
2026-09-09 11:13:57 +08:00 · 2015-07-09 08:03:46 +10:00
parent 304a251979 3580621879
commit 9a4ddc59cd
3 changed files with 286 additions and 63 deletions
@@ -0,0 +1,204 @@
+// Type definitions for Angular Material 0.9.0-rc1+ (angular.material module)
+// Project: https://github.com/angular/material
+// Definitions by: Matt Traynham <https://github.com/mtraynham>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+/// <reference path="../angularjs/angular.d.ts" />
+declare module angular.material {
+
+    interface MDBottomSheetOptions {
+        templateUrl?: string;
+        template?: string;
+        scope?: angular.IScope; // default: new child scope
+        preserveScope?: boolean; // default: false
+        controller?: string|Function;
+        locals?: {[index: string]: any};
+        targetEvent?: MouseEvent;
+        resolve?: {[index: string]: angular.IPromise<any>}
+        controllerAs?: string;
+        parent?: string|Element|JQuery; // default: root node
+        disableParentScroll?: boolean; // default: true
+    }
+
+    interface MDBottomSheetService {
+        show(options: MDBottomSheetOptions): angular.IPromise<any>;
+        hide(response?: any): void;
+        cancel(response?: any): void;
+    }
+
+    interface MDPresetDialog<T> {
+        title(title: string): T;
+        content(content: string): T;
+        ok(ok: string): T;
+        theme(theme: string): T;
+    }
+
+    interface MDAlertDialog extends MDPresetDialog<MDAlertDialog> {
+    }
+
+    interface MDConfirmDialog extends MDPresetDialog<MDConfirmDialog> {
+        cancel(cancel: string): MDConfirmDialog;
+    }
+
+    interface MDDialogOptions {
+        templateUrl?: string;
+        template?: string;
+        targetEvent?: MouseEvent;
+        scope?: angular.IScope; // default: new child scope
+        preserveScope?: boolean; // default: false
+        disableParentScroll?: boolean; // default: true
+        hasBackdrop?: boolean // default: true
+        clickOutsideToClose?: boolean; // default: false
+        escapeToClose?: boolean; // default: true
+        focusOnOpen?: boolean; // default: true
+        controller?: string|Function;
+        locals?: {[index: string]: any};
+        bindToController?: boolean; // default: false
+        resolve?: {[index: string]: angular.IPromise<any>}
+        controllerAs?: string;
+        parent?: string|Element|JQuery; // default: root node
+        onComplete?: Function;
+    }
+
+    interface MDDialogService {
+        show(dialog: MDDialogOptions|MDAlertDialog|MDConfirmDialog): angular.IPromise<any>;
+        confirm(): MDConfirmDialog;
+        alert(): MDAlertDialog;
+        hide(response?: any): void;
+        cancel(response?: any): void;
+    }
+
+    interface MDIcon {
+        (id: string): angular.IPromise<Element>; // id is a unique ID or URL
+    }
+
+    interface MDIconProvider {
+        icon(id: string, url: string, iconSize?: string): MDIconProvider; // iconSize default: '24px'
+        iconSet(id: string, url: string, iconSize?: string): MDIconProvider; // iconSize default: '24px'
+        defaultIconSet(url: string, iconSize?: string): MDIconProvider; // iconSize default: '24px'
+        defaultIconSize(iconSize: string): MDIconProvider; // default: '24px'
+    }
+
+    interface MDMedia {
+        (media: string): boolean;
+    }
+
+    interface MDSidenavObject {
+        toggle(): angular.IPromise<void>;
+        open(): angular.IPromise<void>;
+        close(): angular.IPromise<void>;
+        isOpen(): boolean;
+        isLockedOpen(): boolean;
+    }
+
+    interface MDSidenavService {
+        (component: string): MDSidenavObject;
+    }
+
+    interface MDToastPreset<T> {
+        content(content: string): T;
+        action(action: string): T;
+        highlightAction(highlightAction: boolean): T;
+        capsule(capsule: boolean): T;
+        theme(theme: string): T;
+        hideDelay(delay: number): T;
+        position(position: string): T;
+    }
+
+    interface MDSimpleToastPreset extends MDToastPreset<MDSimpleToastPreset> {
+    }
+
+    interface MDToastOptions {
+        templateUrl?: string;
+        template?: string;
+        scope?: angular.IScope; // default: new child scope
+        preserveScope?: boolean; // default: false
+        hideDelay?: number; // default (ms): 3000
+        position?: string; // any combination of 'bottom'/'left'/'top'/'right'/'fit'; default: 'bottom left'
+        controller?: string|Function;
+        locals?: {[index: string]: any};
+        bindToController?: boolean; // default: false
+        resolve?: {[index: string]: angular.IPromise<any>}
+        controllerAs?: string;
+        parent?: string|Element|JQuery; // default: root node
+    }
+
+    interface MDToastService {
+        show(optionsOrPreset: MDToastOptions|MDToastPreset<any>): angular.IPromise<any>;
+        showSimple(): angular.IPromise<any>;
+        simple(): MDSimpleToastPreset;
+        build(): MDToastPreset<any>;
+        updateContent(): void;
+        hide(response?: any): void;
+        cancel(response?: any): void;
+    }
+
+    interface MDPalette {
+        0?: string;
+        50?: string;
+        100?: string;
+        200?: string;
+        300?: string;
+        400?: string;
+        500?: string;
+        600?: string;
+        700?: string;
+        800?: string;
+        900?: string;
+        A100?: string;
+        A200?: string;
+        A400?: string;
+        A700?: string;
+        contrastDefaultColor?: string;
+        contrastDarkColors?: string;
+        contrastStrongLightColors?: string;
+    }
+
+    interface MDThemeHues {
+        default?: string;
+        'hue-1'?: string;
+        'hue-2'?: string;
+        'hue-3'?: string;
+    }
+
+    interface MDThemePalette {
+        name: string;
+        hues: MDThemeHues;
+    }
+
+    interface MDThemeColors {
+        accent: MDThemePalette;
+        background: MDThemePalette;
+        primary: MDThemePalette;
+        warn: MDThemePalette;
+    }
+
+    interface MDThemeGrayScalePalette {
+        1: string;
+        2: string;
+        3: string;
+        4: string;
+        name: string;
+    }
+
+    interface MDTheme {
+        name: string;
+        isDark: boolean;
+        colors: MDThemeColors;
+        foregroundPalette: MDThemeGrayScalePalette;
+        foregroundShadow: string;
+        accentPalette(name: string, hues?: MDThemeHues): MDTheme;
+        primaryPalette(name: string, hues?: MDThemeHues): MDTheme;
+        warnPalette(name: string, hues?: MDThemeHues): MDTheme;
+        backgroundPalette(name: string, hues?: MDThemeHues): MDTheme;
+        dark(isDark?: boolean): MDTheme;
+    }
+
+    interface MDThemingProvider {
+        theme(name: string, inheritFrom?: string): MDTheme;
+        definePalette(name: string, palette: MDPalette): MDThemingProvider;
+        extendPalette(name: string, palette: MDPalette): MDPalette;
+        setDefaultTheme(theme: string): void;
+        alwaysWatchTheme(alwaysWatch: boolean): void;
+    }
+}
@@ -3,11 +3,11 @@
 var myApp = angular.module('testModule', ['ngMaterial']);

 myApp.config((
-    $mdThemingProvider: ng.material.MDThemingProvider,
-    $mdIconProvider: ng.material.MDIconProvider) => {
+    $mdThemingProvider: ng.material.IThemingProvider,
+    $mdIconProvider: ng.material.IIconProvider) => {

    $mdThemingProvider.alwaysWatchTheme(true);
-    var neonRedMap: ng.material.MDPalette = $mdThemingProvider.extendPalette('red', {
+    var neonRedMap: ng.material.IPalette = $mdThemingProvider.extendPalette('red', {
        '500': 'ff0000'
    });
    // Register the new color palette map with the name <code>neonRed</code>
@@ -27,7 +27,7 @@ myApp.config((
        .icon('work:chair', 'my/app/chair.svg');  // Register icon in a specific set
 });

-myApp.controller('BottomSheetController', ($scope: ng.IScope, $mdBottomSheet: ng.material.MDBottomSheetService) => {
+myApp.controller('BottomSheetController', ($scope: ng.IScope, $mdBottomSheet: ng.material.IBottomSheetService) => {
    $scope['openBottomSheet'] = () => {
        $mdBottomSheet.show({
            template: '<md-bottom-sheet>Hello!</md-bottom-sheet>'
@@ -37,7 +37,7 @@ myApp.controller('BottomSheetController', ($scope: ng.IScope, $mdBottomSheet: ng
    $scope['cancelBottomSheet'] = $mdBottomSheet.cancel.bind($mdBottomSheet, 'cancel');
 });

-myApp.controller('DialogController', ($scope: ng.IScope, $mdDialog: ng.material.MDDialogService) => {
+myApp.controller('DialogController', ($scope: ng.IScope, $mdDialog: ng.material.IDialogService) => {
    $scope['openDialog'] = () => {
        $mdDialog.show({
            template: '<md-dialog>Hello!</md-dialog>'
@@ -55,8 +55,8 @@ myApp.controller('DialogController', ($scope: ng.IScope, $mdDialog: ng.material.

 class IconDirective implements ng.IDirective {

-    private $mdIcon: ng.material.MDIcon;
-    constructor($mdIcon: ng.material.MDIcon) {
+    private $mdIcon: ng.material.IIcon;
+    constructor($mdIcon: ng.material.IIcon) {
        this.$mdIcon = $mdIcon;
    }

@@ -69,9 +69,9 @@ class IconDirective implements ng.IDirective {
        });
    }
 }
-myApp.directive('icon-directive', ($mdIcon: ng.material.MDIcon) => new IconDirective($mdIcon));
+myApp.directive('icon-directive', ($mdIcon: ng.material.IIcon) => new IconDirective($mdIcon));

-myApp.controller('MediaController', ($scope: ng.IScope, $mdMedia: ng.material.MDMedia) => {
+myApp.controller('MediaController', ($scope: ng.IScope, $mdMedia: ng.material.IMedia) => {
    $scope.$watch(() => $mdMedia('lg'), (big: boolean) => {
        $scope['bigScreen'] = big;
    });
@@ -80,7 +80,7 @@ myApp.controller('MediaController', ($scope: ng.IScope, $mdMedia: ng.material.MD
    $scope['anotherCustom'] = $mdMedia('max-width: 300px');
 });

-myApp.controller('SidenavController', ($scope: ng.IScope, $mdSidenav: ng.material.MDSidenavService) => {
+myApp.controller('SidenavController', ($scope: ng.IScope, $mdSidenav: ng.material.ISidenavService) => {
    var componentId = 'left';
    $scope['toggle'] = () => $mdSidenav(componentId).toggle();
    $scope['open'] = () => $mdSidenav(componentId).open();
@@ -89,6 +89,6 @@ myApp.controller('SidenavController', ($scope: ng.IScope, $mdSidenav: ng.materia
    $scope['isLockedOpen'] = $mdSidenav(componentId).isLockedOpen();
 });

-myApp.controller('ToastController', ($scope: ng.IScope, $mdToast: ng.material.MDToastService) => {
+myApp.controller('ToastController', ($scope: ng.IScope, $mdToast: ng.material.IToastService) => {
    $scope['openToast'] = () => $mdToast.show($mdToast.simple().content('Hello!'));
 });
@@ -1,4 +1,4 @@
-// Type definitions for Angular Material 0.9.0-rc1+ (angular.material module)
+// Type definitions for Angular Material 0.10.1-rc1+ (angular.material module)
 // Project: https://github.com/angular/material
 // Definitions by: Matt Traynham <https://github.com/mtraynham>
 // Definitions: https://github.com/borisyankov/DefinitelyTyped
@@ -6,7 +6,7 @@
 /// <reference path="../angularjs/angular.d.ts" />
 declare module angular.material {

-    interface MDBottomSheetOptions {
+    interface IBottomSheetOptions {
        templateUrl?: string;
        template?: string;
        scope?: angular.IScope; // default: new child scope
@@ -20,27 +20,45 @@ declare module angular.material {
        disableParentScroll?: boolean; // default: true
    }

-    interface MDBottomSheetService {
-        show(options: MDBottomSheetOptions): angular.IPromise<any>;
+    interface IBottomSheetService {
+        show(options: IBottomSheetOptions): angular.IPromise<any>;
        hide(response?: any): void;
        cancel(response?: any): void;
    }

-    interface MDPresetDialog<T> {
+    interface IPresetDialog<T> {
        title(title: string): T;
        content(content: string): T;
        ok(ok: string): T;
        theme(theme: string): T;
+        templateUrl(templateUrl?: string): T;
+        template(template?: string): T;
+        targetEvent(targetEvent?: MouseEvent): T;
+        scope(scope?: angular.IScope): T; // default: new child scope
+        preserveScope(preserveScope?: boolean): T; // default: false
+        disableParentScroll(disableParentScroll?: boolean): T; // default: true
+        hasBackdrop(hasBackdrop?: boolean): T; // default: true
+        clickOutsideToClose(clickOutsideToClose?: boolean): T; // default: false
+        escapeToClose(escapeToClose?: boolean): T; // default: true
+        focusOnOpen(focusOnOpen?: boolean): T; // default: true
+        controller(controller?: string|Function): T;
+        locals(locals?: {[index: string]: any}): T;
+        bindToController(bindToController?: boolean): T; // default: false
+        resolve(resolve?: {[index: string]: angular.IPromise<any>}): T;
+        controllerAs(controllerAs?: string): T;
+        parent(parent?: string|Element|JQuery): T; // default: root node
+        onComplete(onComplete?: Function): T;
+        ariaLabel(ariaLabel: string): T;
    }

-    interface MDAlertDialog extends MDPresetDialog<MDAlertDialog> {
+    interface IAlertDialog extends IPresetDialog<IAlertDialog> {
    }

-    interface MDConfirmDialog extends MDPresetDialog<MDConfirmDialog> {
-        cancel(cancel: string): MDConfirmDialog;
+    interface IConfirmDialog extends IPresetDialog<IConfirmDialog> {
+        cancel(cancel: string): IConfirmDialog;
    }

-    interface MDDialogOptions {
+    interface IDialogOptions {
        templateUrl?: string;
        template?: string;
        targetEvent?: MouseEvent;
@@ -60,30 +78,31 @@ declare module angular.material {
        onComplete?: Function;
    }

-    interface MDDialogService {
-        show(dialog: MDDialogOptions|MDAlertDialog|MDConfirmDialog): angular.IPromise<any>;
-        confirm(): MDConfirmDialog;
-        alert(): MDAlertDialog;
+    interface IDialogService {
+        show(dialog: IDialogOptions|IAlertDialog|IConfirmDialog): angular.IPromise<any>;
+        confirm(): IConfirmDialog;
+        alert(): IAlertDialog;
        hide(response?: any): void;
        cancel(response?: any): void;
    }

-    interface MDIcon {
+    interface IIcon {
        (id: string): angular.IPromise<Element>; // id is a unique ID or URL
    }

-    interface MDIconProvider {
-        icon(id: string, url: string, iconSize?: string): MDIconProvider; // iconSize default: '24px'
-        iconSet(id: string, url: string, iconSize?: string): MDIconProvider; // iconSize default: '24px'
-        defaultIconSet(url: string, iconSize?: string): MDIconProvider; // iconSize default: '24px'
-        defaultIconSize(iconSize: string): MDIconProvider; // default: '24px'
+    interface IIconProvider {
+        icon(id: string, url: string, viewBoxSize?: number): IIconProvider; // viewBoxSize default: 24
+        iconSet(id: string, url: string, viewBoxSize?: number): IIconProvider; // viewBoxSize default: 24
+        defaultIconSet(url: string, viewBoxSize?: number): IIconProvider; // viewBoxSize default: 24
+        defaultViewBoxSize(viewBoxSize: number): IIconProvider; // default: 24
+        defaultFontSet(name: string): IIconProvider;
    }

-    interface MDMedia {
+    interface IMedia {
        (media: string): boolean;
    }

-    interface MDSidenavObject {
+    interface ISidenavObject {
        toggle(): angular.IPromise<void>;
        open(): angular.IPromise<void>;
        close(): angular.IPromise<void>;
@@ -91,11 +110,11 @@ declare module angular.material {
        isLockedOpen(): boolean;
    }

-    interface MDSidenavService {
-        (component: string): MDSidenavObject;
+    interface ISidenavService {
+        (component: string): ISidenavObject;
    }

-    interface MDToastPreset<T> {
+    interface IToastPreset<T> {
        content(content: string): T;
        action(action: string): T;
        highlightAction(highlightAction: boolean): T;
@@ -105,10 +124,10 @@ declare module angular.material {
        position(position: string): T;
    }

-    interface MDSimpleToastPreset extends MDToastPreset<MDSimpleToastPreset> {
+    interface ISimpleToastPreset extends IToastPreset<ISimpleToastPreset> {
    }

-    interface MDToastOptions {
+    interface IToastOptions {
        templateUrl?: string;
        template?: string;
        scope?: angular.IScope; // default: new child scope
@@ -123,17 +142,17 @@ declare module angular.material {
        parent?: string|Element|JQuery; // default: root node
    }

-    interface MDToastService {
-        show(optionsOrPreset: MDToastOptions|MDToastPreset<any>): angular.IPromise<any>;
+    interface IToastService {
+        show(optionsOrPreset: IToastOptions|IToastPreset<any>): angular.IPromise<any>;
        showSimple(): angular.IPromise<any>;
-        simple(): MDSimpleToastPreset;
-        build(): MDToastPreset<any>;
+        simple(): ISimpleToastPreset;
+        build(): IToastPreset<any>;
        updateContent(): void;
        hide(response?: any): void;
        cancel(response?: any): void;
    }

-    interface MDPalette {
+    interface IPalette {
        0?: string;
        50?: string;
        100?: string;
@@ -154,26 +173,26 @@ declare module angular.material {
        contrastLightColors?: string|string[];
    }

-    interface MDThemeHues {
+    interface IThemeHues {
        default?: string;
        'hue-1'?: string;
        'hue-2'?: string;
        'hue-3'?: string;
    }

-    interface MDThemePalette {
+    interface IThemePalette {
        name: string;
-        hues: MDThemeHues;
+        hues: IThemeHues;
    }

-    interface MDThemeColors {
-        accent: MDThemePalette;
-        background: MDThemePalette;
-        primary: MDThemePalette;
-        warn: MDThemePalette;
+    interface IThemeColors {
+        accent: IThemePalette;
+        background: IThemePalette;
+        primary: IThemePalette;
+        warn: IThemePalette;
    }

-    interface MDThemeGrayScalePalette {
+    interface IThemeGrayScalePalette {
        1: string;
        2: string;
        3: string;
@@ -181,23 +200,23 @@ declare module angular.material {
        name: string;
    }

-    interface MDTheme {
+    interface ITheme {
        name: string;
        isDark: boolean;
-        colors: MDThemeColors;
-        foregroundPalette: MDThemeGrayScalePalette;
+        colors: IThemeColors;
+        foregroundPalette: IThemeGrayScalePalette;
        foregroundShadow: string;
-        accentPalette(name: string, hues?: MDThemeHues): MDTheme;
-        primaryPalette(name: string, hues?: MDThemeHues): MDTheme;
-        warnPalette(name: string, hues?: MDThemeHues): MDTheme;
-        backgroundPalette(name: string, hues?: MDThemeHues): MDTheme;
-        dark(isDark?: boolean): MDTheme;
+        accentPalette(name: string, hues?: IThemeHues): ITheme;
+        primaryPalette(name: string, hues?: IThemeHues): ITheme;
+        warnPalette(name: string, hues?: IThemeHues): ITheme;
+        backgroundPalette(name: string, hues?: IThemeHues): ITheme;
+        dark(isDark?: boolean): ITheme;
    }

-    interface MDThemingProvider {
-        theme(name: string, inheritFrom?: string): MDTheme;
-        definePalette(name: string, palette: MDPalette): MDThemingProvider;
-        extendPalette(name: string, palette: MDPalette): MDPalette;
+    interface IThemingProvider {
+        theme(name: string, inheritFrom?: string): ITheme;
+        definePalette(name: string, palette: IPalette): IThemingProvider;
+        extendPalette(name: string, palette: IPalette): IPalette;
        setDefaultTheme(theme: string): void;
        alwaysWatchTheme(alwaysWatch: boolean): void;
    }