step-header.d.ts 2.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051
  1. /**
  2. * @license
  3. * Copyright Google LLC All Rights Reserved.
  4. *
  5. * Use of this source code is governed by an MIT-style license that can be
  6. * found in the LICENSE file at https://angular.io/license
  7. */
  8. import { FocusMonitor } from '@angular/cdk/a11y';
  9. import { ChangeDetectorRef, ElementRef, OnDestroy, TemplateRef } from '@angular/core';
  10. import { MatStepLabel } from './step-label';
  11. import { MatStepperIntl } from './stepper-intl';
  12. import { MatStepperIconContext } from './stepper-icon';
  13. import { CdkStepHeader, StepState } from '@angular/cdk/stepper';
  14. export declare class MatStepHeader extends CdkStepHeader implements OnDestroy {
  15. _intl: MatStepperIntl;
  16. private _focusMonitor;
  17. private _intlSubscription;
  18. /** State of the given step. */
  19. state: StepState;
  20. /** Label of the given step. */
  21. label: MatStepLabel | string;
  22. /** Error message to display when there's an error. */
  23. errorMessage: string;
  24. /** Overrides for the header icons, passed in via the stepper. */
  25. iconOverrides: {
  26. [key: string]: TemplateRef<MatStepperIconContext>;
  27. };
  28. /** Index of the given step. */
  29. index: number;
  30. /** Whether the given step is selected. */
  31. selected: boolean;
  32. /** Whether the given step label is active. */
  33. active: boolean;
  34. /** Whether the given step is optional. */
  35. optional: boolean;
  36. /** Whether the ripple should be disabled. */
  37. disableRipple: boolean;
  38. constructor(_intl: MatStepperIntl, _focusMonitor: FocusMonitor, _elementRef: ElementRef<HTMLElement>, changeDetectorRef: ChangeDetectorRef);
  39. ngOnDestroy(): void;
  40. /** Focuses the step header. */
  41. focus(): void;
  42. /** Returns string label of given step if it is a text label. */
  43. _stringLabel(): string | null;
  44. /** Returns MatStepLabel if the label of given step is a template label. */
  45. _templateLabel(): MatStepLabel | null;
  46. /** Returns the host HTML element. */
  47. _getHostElement(): HTMLElement;
  48. /** Template context variables that are exposed to the `matStepperIcon` instances. */
  49. _getIconContext(): MatStepperIconContext;
  50. _getDefaultTextForState(state: StepState): string;
  51. }