fix(cdk/stepper): exported injection token referring to Material (#14339)

Fixes the `cdk/stepper` package exporting a symbol that is referring to Material.
This commit is contained in:
Kristiyan Kostadinov
2018-12-04 00:32:38 +01:00
committed by mmalerba
parent f1761191b7
commit b584888909
7 changed files with 32 additions and 19 deletions
+10 -3
View File
@@ -79,8 +79,15 @@ export const STEP_STATE = {
};
/** InjectionToken that can be used to specify the global stepper options. */
export const MAT_STEPPER_GLOBAL_OPTIONS =
new InjectionToken<StepperOptions>('mat-stepper-global-options');
export const STEPPER_GLOBAL_OPTIONS =
new InjectionToken<StepperOptions>('STEPPER_GLOBAL_OPTIONS');
/**
* InjectionToken that can be used to specify the global stepper options.
* @deprecated Use `STEPPER_GLOBAL_OPTIONS` instead.
* @breaking-change 8.0.0.
*/
export const MAT_STEPPER_GLOBAL_OPTIONS = STEPPER_GLOBAL_OPTIONS;
/** Configurable options for stepper. */
export interface StepperOptions {
@@ -188,7 +195,7 @@ export class CdkStep implements OnChanges {
/** @breaking-change 8.0.0 remove the `?` after `stepperOptions` */
constructor(
@Inject(forwardRef(() => CdkStepper)) private _stepper: CdkStepper,
@Optional() @Inject(MAT_STEPPER_GLOBAL_OPTIONS) stepperOptions?: StepperOptions) {
@Optional() @Inject(STEPPER_GLOBAL_OPTIONS) stepperOptions?: StepperOptions) {
this._stepperOptions = stepperOptions ? stepperOptions : {};
this._displayDefaultIndicatorType = this._stepperOptions.displayDefaultIndicatorType !== false;
this._showError = !!this._stepperOptions.showError;
+11 -7
View File
@@ -41,7 +41,8 @@ For more complex labels, add a template with the `matStepLabel` directive inside
```
#### Label position
For `mat-horizontal-stepper` it's possible to define the position of the label. `end` is the default value, while `bottom` will place it under the step icon instead of at its side.
For `mat-horizontal-stepper` it's possible to define the position of the label. `end` is the
default value, while `bottom` will place it under the step icon instead of at its side.
This behaviour is controlled by `labelPosition` property.
<!-- example(stepper-label-position-bottom) -->
@@ -163,7 +164,8 @@ by placing a `matStepperIcon` for each of the icons that you want to override. T
Note that you aren't limited to using the `mat-icon` component when providing custom icons.
#### Step States
You can set the state of a step to whatever you want. The given state by default maps to an icon. However, it can be overridden the same way as mentioned above.
You can set the state of a step to whatever you want. The given state by default maps to an icon.
However, it can be overridden the same way as mentioned above.
```html
<mat-horizontal-stepper>
@@ -194,14 +196,15 @@ You can set the state of a step to whatever you want. The given state by default
</mat-horizontal-stepper>
```
In order to use the custom step states, you must add the `displayDefaultIndicatorType` option to the global default stepper options which can be specified by providing a value for
`MAT_STEPPER_GLOBAL_OPTIONS` in your application's root module.
In order to use the custom step states, you must add the `displayDefaultIndicatorType` option to
the global default stepper options which can be specified by providing a value for
`STEPPER_GLOBAL_OPTIONS` in your application's root module.
```ts
@NgModule({
providers: [
{
provide: MAT_STEPPER_GLOBAL_OPTIONS,
provide: STEPPER_GLOBAL_OPTIONS,
useValue: { displayDefaultIndicatorType: false }
}
]
@@ -212,13 +215,14 @@ In order to use the custom step states, you must add the `displayDefaultIndicato
### Error State
The stepper can now show error states by simply providing the `showError` option to the `MAT_STEPPER_GLOBAL_OPTIONS` in your application's root module as mentioned above.
The stepper can now show error states by simply providing the `showError` option to the
`STEPPER_GLOBAL_OPTIONS` in your application's root module as mentioned above.
```ts
@NgModule({
providers: [
{
provide: MAT_STEPPER_GLOBAL_OPTIONS,
provide: STEPPER_GLOBAL_OPTIONS,
useValue: { showError: true }
}
]
+3 -3
View File
@@ -9,7 +9,7 @@ import {
SPACE,
UP_ARROW,
} from '@angular/cdk/keycodes';
import {StepperOrientation, MAT_STEPPER_GLOBAL_OPTIONS, STEP_STATE} from '@angular/cdk/stepper';
import {StepperOrientation, STEPPER_GLOBAL_OPTIONS, STEP_STATE} from '@angular/cdk/stepper';
import {dispatchKeyboardEvent, createKeyboardEvent, dispatchEvent} from '@angular/cdk/testing';
import {Component, DebugElement, EventEmitter, OnInit, Type, Provider} from '@angular/core';
import {ComponentFixture, fakeAsync, flush, inject, TestBed} from '@angular/core/testing';
@@ -918,7 +918,7 @@ describe('MatStepper', () => {
fixture = createComponent(
MatHorizontalStepperWithErrorsApp,
[{
provide: MAT_STEPPER_GLOBAL_OPTIONS,
provide: STEPPER_GLOBAL_OPTIONS,
useValue: {showError: true}
}],
[MatFormFieldModule, MatInputModule]
@@ -949,7 +949,7 @@ describe('MatStepper', () => {
fixture = createComponent(
MatHorizontalStepperWithErrorsApp,
[{
provide: MAT_STEPPER_GLOBAL_OPTIONS,
provide: STEPPER_GLOBAL_OPTIONS,
useValue: {displayDefaultIndicatorType: false}
}],
[MatFormFieldModule, MatInputModule]
+2 -2
View File
@@ -11,7 +11,7 @@ import {
CdkStep,
CdkStepper,
StepContentPositionState,
MAT_STEPPER_GLOBAL_OPTIONS,
STEPPER_GLOBAL_OPTIONS,
StepperOptions
} from '@angular/cdk/stepper';
import {AnimationEvent} from '@angular/animations';
@@ -63,7 +63,7 @@ export class MatStep extends CdkStep implements ErrorStateMatcher {
/** @breaking-change 8.0.0 remove the `?` after `stepperOptions` */
constructor(@Inject(forwardRef(() => MatStepper)) stepper: MatStepper,
@SkipSelf() private _errorStateMatcher: ErrorStateMatcher,
@Optional() @Inject(MAT_STEPPER_GLOBAL_OPTIONS) stepperOptions?: StepperOptions) {
@Optional() @Inject(STEPPER_GLOBAL_OPTIONS) stepperOptions?: StepperOptions) {
super(stepper, stepperOptions);
}
@@ -1,6 +1,6 @@
import {Component, OnInit} from '@angular/core';
import {FormBuilder, FormGroup, Validators} from '@angular/forms';
import {MAT_STEPPER_GLOBAL_OPTIONS} from '@angular/cdk/stepper';
import {STEPPER_GLOBAL_OPTIONS} from '@angular/cdk/stepper';
/**
* @title Stepper that displays errors in the steps
@@ -10,7 +10,7 @@ import {MAT_STEPPER_GLOBAL_OPTIONS} from '@angular/cdk/stepper';
templateUrl: 'stepper-errors-example.html',
styleUrls: ['stepper-errors-example.css'],
providers: [{
provide: MAT_STEPPER_GLOBAL_OPTIONS, useValue: {showError: true}
provide: STEPPER_GLOBAL_OPTIONS, useValue: {showError: true}
}]
})
export class StepperErrorsExample implements OnInit {
@@ -1,6 +1,6 @@
import {Component, OnInit} from '@angular/core';
import {FormBuilder, FormGroup, Validators} from '@angular/forms';
import {MAT_STEPPER_GLOBAL_OPTIONS} from '@angular/cdk/stepper';
import {STEPPER_GLOBAL_OPTIONS} from '@angular/cdk/stepper';
/**
* @title Stepper with customized states
@@ -10,7 +10,7 @@ import {MAT_STEPPER_GLOBAL_OPTIONS} from '@angular/cdk/stepper';
templateUrl: 'stepper-states-example.html',
styleUrls: ['stepper-states-example.css'],
providers: [{
provide: MAT_STEPPER_GLOBAL_OPTIONS, useValue: {displayDefaultIndicatorType: false}
provide: STEPPER_GLOBAL_OPTIONS, useValue: {displayDefaultIndicatorType: false}
}]
})
export class StepperStatesExample implements OnInit {
+2
View File
@@ -82,6 +82,8 @@ export declare const STEP_STATE: {
export declare type StepContentPositionState = 'previous' | 'current' | 'next';
export declare const STEPPER_GLOBAL_OPTIONS: InjectionToken<StepperOptions>;
export interface StepperOptions {
displayDefaultIndicatorType?: boolean;
showError?: boolean;