index.d.ts 9.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189
  1. import { _AbstractConstructor } from '@angular/material/core';
  2. import { AfterContentInit } from '@angular/core';
  3. import { BooleanInput } from '@angular/cdk/coercion';
  4. import { CanColor } from '@angular/material/core';
  5. import { CanDisable } from '@angular/material/core';
  6. import { CanDisableRipple } from '@angular/material/core';
  7. import { ChangeDetectorRef } from '@angular/core';
  8. import { CheckboxRequiredValidator } from '@angular/forms';
  9. import { _Constructor } from '@angular/material/core';
  10. import { ControlValueAccessor } from '@angular/forms';
  11. import { ElementRef } from '@angular/core';
  12. import { EventEmitter } from '@angular/core';
  13. import { FocusMonitor } from '@angular/cdk/a11y';
  14. import { FocusOrigin } from '@angular/cdk/a11y';
  15. import { HasTabIndex } from '@angular/material/core';
  16. import * as i0 from '@angular/core';
  17. import * as i3 from '@angular/material/core';
  18. import * as i4 from '@angular/common';
  19. import { InjectionToken } from '@angular/core';
  20. import { OnDestroy } from '@angular/core';
  21. import { Provider } from '@angular/core';
  22. import { ThemePalette } from '@angular/material/core';
  23. import { Type } from '@angular/core';
  24. declare namespace i1 {
  25. export {
  26. MAT_SLIDE_TOGGLE_REQUIRED_VALIDATOR,
  27. MatSlideToggleRequiredValidator
  28. }
  29. }
  30. declare namespace i2 {
  31. export {
  32. MAT_SLIDE_TOGGLE_VALUE_ACCESSOR,
  33. MatSlideToggleChange,
  34. _MatSlideToggleBase,
  35. MatSlideToggle
  36. }
  37. }
  38. /** Injection token to be used to override the default options for `mat-slide-toggle`. */
  39. export declare const MAT_SLIDE_TOGGLE_DEFAULT_OPTIONS: InjectionToken<MatSlideToggleDefaultOptions>;
  40. export declare const MAT_SLIDE_TOGGLE_REQUIRED_VALIDATOR: Provider;
  41. /** @docs-private */
  42. export declare const MAT_SLIDE_TOGGLE_VALUE_ACCESSOR: {
  43. provide: InjectionToken<readonly ControlValueAccessor[]>;
  44. useExisting: Type<any>;
  45. multi: boolean;
  46. };
  47. export declare class MatSlideToggle extends _MatSlideToggleBase<MatSlideToggleChange> {
  48. /** Unique ID for the label element. */
  49. _labelId: string;
  50. /** Returns the unique id for the visual hidden button. */
  51. get buttonId(): string;
  52. /** Reference to the MDC switch element. */
  53. _switchElement: ElementRef<HTMLElement>;
  54. constructor(elementRef: ElementRef, focusMonitor: FocusMonitor, changeDetectorRef: ChangeDetectorRef, tabIndex: string, defaults: MatSlideToggleDefaultOptions, animationMode?: string);
  55. /** Method being called whenever the underlying button is clicked. */
  56. _handleClick(): void;
  57. /** Focuses the slide-toggle. */
  58. focus(): void;
  59. protected _createChangeEvent(isChecked: boolean): MatSlideToggleChange;
  60. _getAriaLabelledBy(): string | null;
  61. static ɵfac: i0.ɵɵFactoryDeclaration<MatSlideToggle, [null, null, null, { attribute: "tabindex"; }, null, { optional: true; }]>;
  62. static ɵcmp: i0.ɵɵComponentDeclaration<MatSlideToggle, "mat-slide-toggle", ["matSlideToggle"], { "disabled": { "alias": "disabled"; "required": false; }; "disableRipple": { "alias": "disableRipple"; "required": false; }; "color": { "alias": "color"; "required": false; }; "tabIndex": { "alias": "tabIndex"; "required": false; }; }, {}, never, ["*"], false, never>;
  63. }
  64. export declare abstract class _MatSlideToggleBase<T> extends _MatSlideToggleMixinBase implements OnDestroy, AfterContentInit, ControlValueAccessor, CanDisable, CanColor, HasTabIndex, CanDisableRipple {
  65. protected _focusMonitor: FocusMonitor;
  66. protected _changeDetectorRef: ChangeDetectorRef;
  67. defaults: MatSlideToggleDefaultOptions;
  68. protected _onChange: (_: any) => void;
  69. private _onTouched;
  70. protected _uniqueId: string;
  71. private _required;
  72. private _checked;
  73. protected abstract _createChangeEvent(isChecked: boolean): T;
  74. abstract focus(options?: FocusOptions, origin?: FocusOrigin): void;
  75. /** Whether noop animations are enabled. */
  76. _noopAnimations: boolean;
  77. /** Whether the slide toggle is currently focused. */
  78. _focused: boolean;
  79. /** Name value will be applied to the input element if present. */
  80. name: string | null;
  81. /** A unique id for the slide-toggle input. If none is supplied, it will be auto-generated. */
  82. id: string;
  83. /** Whether the label should appear after or before the slide-toggle. Defaults to 'after'. */
  84. labelPosition: 'before' | 'after';
  85. /** Used to set the aria-label attribute on the underlying input element. */
  86. ariaLabel: string | null;
  87. /** Used to set the aria-labelledby attribute on the underlying input element. */
  88. ariaLabelledby: string | null;
  89. /** Used to set the aria-describedby attribute on the underlying input element. */
  90. ariaDescribedby: string;
  91. /** Whether the slide-toggle is required. */
  92. get required(): boolean;
  93. set required(value: BooleanInput);
  94. /** Whether the slide-toggle element is checked or not. */
  95. get checked(): boolean;
  96. set checked(value: BooleanInput);
  97. /** An event will be dispatched each time the slide-toggle changes its value. */
  98. readonly change: EventEmitter<T>;
  99. /**
  100. * An event will be dispatched each time the slide-toggle input is toggled.
  101. * This event is always emitted when the user toggles the slide toggle, but this does not mean
  102. * the slide toggle's value has changed.
  103. */
  104. readonly toggleChange: EventEmitter<void>;
  105. /** Returns the unique id for the visual hidden input. */
  106. get inputId(): string;
  107. constructor(elementRef: ElementRef, _focusMonitor: FocusMonitor, _changeDetectorRef: ChangeDetectorRef, tabIndex: string, defaults: MatSlideToggleDefaultOptions, animationMode: string | undefined, idPrefix: string);
  108. ngAfterContentInit(): void;
  109. ngOnDestroy(): void;
  110. /** Implemented as part of ControlValueAccessor. */
  111. writeValue(value: any): void;
  112. /** Implemented as part of ControlValueAccessor. */
  113. registerOnChange(fn: any): void;
  114. /** Implemented as part of ControlValueAccessor. */
  115. registerOnTouched(fn: any): void;
  116. /** Implemented as a part of ControlValueAccessor. */
  117. setDisabledState(isDisabled: boolean): void;
  118. /** Toggles the checked state of the slide-toggle. */
  119. toggle(): void;
  120. /**
  121. * Emits a change event on the `change` output. Also notifies the FormControl about the change.
  122. */
  123. protected _emitChangeEvent(): void;
  124. static ɵfac: i0.ɵɵFactoryDeclaration<_MatSlideToggleBase<any>, never>;
  125. static ɵdir: i0.ɵɵDirectiveDeclaration<_MatSlideToggleBase<any>, never, never, { "name": { "alias": "name"; "required": false; }; "id": { "alias": "id"; "required": false; }; "labelPosition": { "alias": "labelPosition"; "required": false; }; "ariaLabel": { "alias": "aria-label"; "required": false; }; "ariaLabelledby": { "alias": "aria-labelledby"; "required": false; }; "ariaDescribedby": { "alias": "aria-describedby"; "required": false; }; "required": { "alias": "required"; "required": false; }; "checked": { "alias": "checked"; "required": false; }; }, { "change": "change"; "toggleChange": "toggleChange"; }, never, never, false, never>;
  126. }
  127. /** Change event object emitted by a slide toggle. */
  128. export declare class MatSlideToggleChange {
  129. /** The source slide toggle of the event. */
  130. source: MatSlideToggle;
  131. /** The new `checked` value of the slide toggle. */
  132. checked: boolean;
  133. constructor(
  134. /** The source slide toggle of the event. */
  135. source: MatSlideToggle,
  136. /** The new `checked` value of the slide toggle. */
  137. checked: boolean);
  138. }
  139. /** Default `mat-slide-toggle` options that can be overridden. */
  140. export declare interface MatSlideToggleDefaultOptions {
  141. /** Whether toggle action triggers value changes in slide toggle. */
  142. disableToggleValue?: boolean;
  143. /** Default color for slide toggles. */
  144. color?: ThemePalette;
  145. }
  146. /** @docs-private */
  147. declare const _MatSlideToggleMixinBase: _Constructor<HasTabIndex> & _AbstractConstructor<HasTabIndex> & _Constructor<CanColor> & _AbstractConstructor<CanColor> & _Constructor<CanDisableRipple> & _AbstractConstructor<CanDisableRipple> & _Constructor<CanDisable> & _AbstractConstructor<CanDisable> & {
  148. new (_elementRef: ElementRef): {
  149. _elementRef: ElementRef;
  150. };
  151. };
  152. export declare class MatSlideToggleModule {
  153. static ɵfac: i0.ɵɵFactoryDeclaration<MatSlideToggleModule, never>;
  154. static ɵmod: i0.ɵɵNgModuleDeclaration<MatSlideToggleModule, [typeof i2.MatSlideToggle], [typeof _MatSlideToggleRequiredValidatorModule, typeof i3.MatCommonModule, typeof i3.MatRippleModule, typeof i4.CommonModule], [typeof _MatSlideToggleRequiredValidatorModule, typeof i2.MatSlideToggle, typeof i3.MatCommonModule]>;
  155. static ɵinj: i0.ɵɵInjectorDeclaration<MatSlideToggleModule>;
  156. }
  157. /**
  158. * Validator for Material slide-toggle components with the required attribute in a
  159. * template-driven form. The default validator for required form controls asserts
  160. * that the control value is not undefined but that is not appropriate for a slide-toggle
  161. * where the value is always defined.
  162. *
  163. * Required slide-toggle form controls are valid when checked.
  164. */
  165. export declare class MatSlideToggleRequiredValidator extends CheckboxRequiredValidator {
  166. static ɵfac: i0.ɵɵFactoryDeclaration<MatSlideToggleRequiredValidator, never>;
  167. static ɵdir: i0.ɵɵDirectiveDeclaration<MatSlideToggleRequiredValidator, "mat-slide-toggle[required][formControlName], mat-slide-toggle[required][formControl], mat-slide-toggle[required][ngModel]", never, {}, {}, never, never, false, never>;
  168. }
  169. /** This module is used by both original and MDC-based slide-toggle implementations. */
  170. export declare class _MatSlideToggleRequiredValidatorModule {
  171. static ɵfac: i0.ɵɵFactoryDeclaration<_MatSlideToggleRequiredValidatorModule, never>;
  172. static ɵmod: i0.ɵɵNgModuleDeclaration<_MatSlideToggleRequiredValidatorModule, [typeof i1.MatSlideToggleRequiredValidator], never, [typeof i1.MatSlideToggleRequiredValidator]>;
  173. static ɵinj: i0.ɵɵInjectorDeclaration<_MatSlideToggleRequiredValidatorModule>;
  174. }
  175. export { }