@skyux/progress-indicator 12.22.0 → 13.0.0-alpha.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (31) hide show
  1. package/fesm2022/skyux-progress-indicator-testing.mjs.map +1 -1
  2. package/fesm2022/skyux-progress-indicator.mjs +35 -35
  3. package/fesm2022/skyux-progress-indicator.mjs.map +1 -1
  4. package/index.d.ts +373 -15
  5. package/package.json +9 -9
  6. package/testing/index.d.ts +87 -3
  7. package/lib/modules/progress-indicator/progress-indicator-item/progress-indicator-item.component.d.ts +0 -49
  8. package/lib/modules/progress-indicator/progress-indicator-nav-button/progress-indicator-nav-button-class.pipe.d.ts +0 -7
  9. package/lib/modules/progress-indicator/progress-indicator-nav-button/progress-indicator-nav-button-disabled.pipe.d.ts +0 -9
  10. package/lib/modules/progress-indicator/progress-indicator-nav-button/progress-indicator-nav-button.component.d.ts +0 -51
  11. package/lib/modules/progress-indicator/progress-indicator-reset-button/progress-indicator-reset-button.component.d.ts +0 -32
  12. package/lib/modules/progress-indicator/progress-indicator-status-marker/progress-indicator-status-marker-class.pipe.d.ts +0 -8
  13. package/lib/modules/progress-indicator/progress-indicator-status-marker/progress-indicator-status-marker.component.d.ts +0 -20
  14. package/lib/modules/progress-indicator/progress-indicator-title/progress-indicator-title.component.d.ts +0 -8
  15. package/lib/modules/progress-indicator/progress-indicator.component.d.ts +0 -62
  16. package/lib/modules/progress-indicator/progress-indicator.module.d.ts +0 -21
  17. package/lib/modules/progress-indicator/types/progress-indicator-action-click-args.d.ts +0 -14
  18. package/lib/modules/progress-indicator/types/progress-indicator-action-click-progress-handler.d.ts +0 -12
  19. package/lib/modules/progress-indicator/types/progress-indicator-change.d.ts +0 -15
  20. package/lib/modules/progress-indicator/types/progress-indicator-display-mode-type.d.ts +0 -1
  21. package/lib/modules/progress-indicator/types/progress-indicator-item-status.d.ts +0 -18
  22. package/lib/modules/progress-indicator/types/progress-indicator-message-type.d.ts +0 -26
  23. package/lib/modules/progress-indicator/types/progress-indicator-message.d.ts +0 -15
  24. package/lib/modules/progress-indicator/types/progress-indicator-mode.d.ts +0 -14
  25. package/lib/modules/progress-indicator/types/progress-indicator-nav-button-type.d.ts +0 -4
  26. package/lib/modules/shared/sky-progress-indicator-resources.module.d.ts +0 -10
  27. package/testing/modules/progress-indicator/progress-indicator-harness-filters.d.ts +0 -6
  28. package/testing/modules/progress-indicator/progress-indicator-harness.d.ts +0 -40
  29. package/testing/modules/progress-indicator/progress-indicator-item-harness-filters.d.ts +0 -6
  30. package/testing/modules/progress-indicator/progress-indicator-item-harness.d.ts +0 -38
  31. package/testing/public-api.d.ts +0 -4
package/index.d.ts CHANGED
@@ -1,15 +1,373 @@
1
- export { SkyProgressIndicatorModule } from './lib/modules/progress-indicator/progress-indicator.module';
2
- export { SkyProgressIndicatorActionClickArgs } from './lib/modules/progress-indicator/types/progress-indicator-action-click-args';
3
- export { SkyProgressIndicatorActionClickProgressHandler } from './lib/modules/progress-indicator/types/progress-indicator-action-click-progress-handler';
4
- export { SkyProgressIndicatorChange } from './lib/modules/progress-indicator/types/progress-indicator-change';
5
- export { SkyProgressIndicatorDisplayModeType } from './lib/modules/progress-indicator/types/progress-indicator-display-mode-type';
6
- export { SkyProgressIndicatorItemStatus } from './lib/modules/progress-indicator/types/progress-indicator-item-status';
7
- export { SkyProgressIndicatorMessage } from './lib/modules/progress-indicator/types/progress-indicator-message';
8
- export { SkyProgressIndicatorMessageType } from './lib/modules/progress-indicator/types/progress-indicator-message-type';
9
- export { SkyProgressIndicatorDisplayMode } from './lib/modules/progress-indicator/types/progress-indicator-mode';
10
- export { SkyProgressIndicatorNavButtonType } from './lib/modules/progress-indicator/types/progress-indicator-nav-button-type';
11
- export { SkyProgressIndicatorItemComponent as λ1 } from './lib/modules/progress-indicator/progress-indicator-item/progress-indicator-item.component';
12
- export { SkyProgressIndicatorNavButtonComponent as λ3 } from './lib/modules/progress-indicator/progress-indicator-nav-button/progress-indicator-nav-button.component';
13
- export { SkyProgressIndicatorResetButtonComponent as λ4 } from './lib/modules/progress-indicator/progress-indicator-reset-button/progress-indicator-reset-button.component';
14
- export { SkyProgressIndicatorTitleComponent as λ5 } from './lib/modules/progress-indicator/progress-indicator-title/progress-indicator-title.component';
15
- export { SkyProgressIndicatorComponent as λ2 } from './lib/modules/progress-indicator/progress-indicator.component';
1
+ import * as i0 from '@angular/core';
2
+ import { OnInit, TemplateRef, ChangeDetectorRef, AfterContentInit, OnDestroy, EventEmitter, QueryList, PipeTransform, AfterViewInit } from '@angular/core';
3
+ import * as i15 from '@skyux/core';
4
+ import { SkyAppWindowRef, SkyLogService } from '@skyux/core';
5
+ import { Subject } from 'rxjs';
6
+ import * as i14 from '@skyux/theme';
7
+ import { SkyThemeService } from '@skyux/theme';
8
+ import * as i10 from '@angular/common';
9
+ import * as i11 from '@skyux/help-inline';
10
+ import * as i12 from '@skyux/icon';
11
+ import * as i1 from '@skyux/i18n';
12
+
13
+ declare enum SkyProgressIndicatorItemStatus {
14
+ /**
15
+ * The item is active.
16
+ */
17
+ Active = 0,
18
+ /**
19
+ * The item is complete.
20
+ */
21
+ Complete = 1,
22
+ /**
23
+ * The item is incomplete.
24
+ */
25
+ Incomplete = 2,
26
+ /**
27
+ * The item is pending.
28
+ */
29
+ Pending = 3
30
+ }
31
+
32
+ /**
33
+ * Specifies a step to include in the progress indicator. Each step requires a label,
34
+ * and you can also specify step details within the `sky-progress-indicator-item` element.
35
+ */
36
+ declare class SkyProgressIndicatorItemComponent implements OnInit {
37
+ #private;
38
+ /**
39
+ * The step label for the step in the progress indicator.
40
+ * @required
41
+ */
42
+ set title(value: string | undefined);
43
+ get title(): string | undefined;
44
+ /**
45
+ * A help key that identifies the global help content to display. When specified along with `title`, a [help inline](https://developer.blackbaud.com/skyux/components/help-inline) button is
46
+ * placed beside the progress indicator item label. Clicking the button invokes global help as configured by the application.
47
+ * This property only applies when `title` is also specified.
48
+ */
49
+ helpKey: string | undefined;
50
+ /**
51
+ * The content of the help popover. When specified along with `title`, a [help inline](https://developer.blackbaud.com/skyux/components/help-inline)
52
+ * button is added to the progress indicator item label. The help inline button displays a [popover](https://developer.blackbaud.com/skyux/components/popover)
53
+ * when clicked using the specified content and optional title. This property only applies when `title` is also specified.
54
+ */
55
+ helpPopoverContent: string | TemplateRef<unknown> | undefined;
56
+ /**
57
+ * The title of the help popover. This property only applies when `helpPopoverContent` is
58
+ * also specified.
59
+ */
60
+ helpPopoverTitle: string | undefined;
61
+ set status(value: SkyProgressIndicatorItemStatus | undefined);
62
+ get status(): SkyProgressIndicatorItemStatus;
63
+ formattedTitle: string | undefined;
64
+ set isVisible(value: boolean | undefined);
65
+ get isVisible(): boolean;
66
+ set showStatusMarker(value: boolean | undefined);
67
+ get showStatusMarker(): boolean;
68
+ set showTitle(value: boolean | undefined);
69
+ get showTitle(): boolean;
70
+ statusName: string;
71
+ constructor(changeDetector: ChangeDetectorRef);
72
+ ngOnInit(): void;
73
+ showStepNumber(step: number): void;
74
+ hideStepNumber(): void;
75
+ static ɵfac: i0.ɵɵFactoryDeclaration<SkyProgressIndicatorItemComponent, never>;
76
+ static ɵcmp: i0.ɵɵComponentDeclaration<SkyProgressIndicatorItemComponent, "sky-progress-indicator-item", never, { "title": { "alias": "title"; "required": false; }; "helpKey": { "alias": "helpKey"; "required": false; }; "helpPopoverContent": { "alias": "helpPopoverContent"; "required": false; }; "helpPopoverTitle": { "alias": "helpPopoverTitle"; "required": false; }; }, {}, never, [".sky-control-help", "*"], false, never>;
77
+ }
78
+
79
+ interface SkyProgressIndicatorChange {
80
+ /**
81
+ * The active item.
82
+ */
83
+ activeIndex?: number;
84
+ /**
85
+ * Whether the progress indicator is complete.
86
+ */
87
+ isComplete?: boolean;
88
+ /**
89
+ * The array with the status of each item.
90
+ */
91
+ itemStatuses?: SkyProgressIndicatorItemStatus[];
92
+ }
93
+
94
+ type SkyProgressIndicatorDisplayModeType = 0 | 1 | 'vertical' | 'horizontal';
95
+
96
+ declare enum SkyProgressIndicatorMessageType {
97
+ /**
98
+ * The current step is complete.
99
+ * This completes the active item and moves to the next item.
100
+ */
101
+ Progress = 0,
102
+ /**
103
+ * Returns progress to the previous step.
104
+ * This moves from the active item to the item that precedes it.
105
+ */
106
+ Regress = 1,
107
+ /**
108
+ * Progress is incomplete.
109
+ * This marks all items as incomplete and sets the first item as the active item.
110
+ */
111
+ Reset = 2,
112
+ /**
113
+ * Progress is complete.
114
+ * This marks all items as complete and sets the last item as the active item.
115
+ */
116
+ Finish = 3,
117
+ /**
118
+ * Moves progress to the item indicated by the `data.activeIndex` property.
119
+ */
120
+ GoTo = 4
121
+ }
122
+
123
+ interface SkyProgressIndicatorMessage {
124
+ /**
125
+ * The type of state change for the progress indicator.
126
+ */
127
+ type: SkyProgressIndicatorMessageType;
128
+ /**
129
+ * Used in conjunction with SkyProgressIndicatorMessageType.GoTo
130
+ * to travel to a specific step by specifying an index number on the `data.activeIndex` property.
131
+ */
132
+ data?: {
133
+ activeIndex?: number;
134
+ [key: string]: any;
135
+ };
136
+ }
137
+
138
+ declare class SkyProgressIndicatorComponent implements OnInit, AfterContentInit, OnDestroy {
139
+ #private;
140
+ /**
141
+ * The orientation of the progress indicator, which can be vertical or horizontal.
142
+ * For [passive progress indicators](https://developer.blackbaud.com/skyux-progress-indicator/docs/passive-indicator)
143
+ * and [waterfall progress indicators](https://developer.blackbaud.com/skyux/components/progress-indicator/waterfall-progress-indicator),
144
+ * use the vertical display mode. For [modal wizards](https://developer.blackbaud.com/skyux/components/wizard),
145
+ * use the horizontal display mode.
146
+ * @deprecated The property was designed to create wizards by setting `displayMode="horizontal"` on progress indicators in modals,
147
+ * but this wizard implementation was replaced by the
148
+ * [Wizard (Tabs) component](https://developer.blackbaud.com/skyux/components/progress-indicator).
149
+ * @default "vertical"
150
+ */
151
+ set displayMode(value: SkyProgressIndicatorDisplayModeType | undefined);
152
+ get displayMode(): SkyProgressIndicatorDisplayModeType;
153
+ /**
154
+ * Whether the progress indicator is passive. Passive progress indicators inform users of
155
+ * progress that concerns them but that they are not responsible for, and they must use the vertical display mode.
156
+ * @default false
157
+ */
158
+ set isPassive(value: boolean | undefined);
159
+ get isPassive(): boolean | undefined;
160
+ /**
161
+ * The observable of `SkyProgressIndicatorMessage` that determines the status to
162
+ * display for items in the progress indicator. The message stream is a queue of
163
+ * commanding messages to change the state of the progress indicator based on the message type.
164
+ */
165
+ set messageStream(value: Subject<SkyProgressIndicatorMessage | SkyProgressIndicatorMessageType> | undefined);
166
+ /**
167
+ * The index for the item to make active when the progress indicator
168
+ * loads. All steps that precede the active item are marked as complete, and all steps
169
+ * that follow the active item are marked as incomplete.
170
+ */
171
+ set startingIndex(value: number | undefined);
172
+ get startingIndex(): number;
173
+ /**
174
+ * Fires when the progress indicator changes the status of an item.
175
+ */
176
+ progressChanges: EventEmitter<SkyProgressIndicatorChange>;
177
+ get hasFinishButton(): boolean | undefined;
178
+ set hasFinishButton(value: boolean | undefined);
179
+ itemComponents: QueryList<SkyProgressIndicatorItemComponent> | undefined;
180
+ cssClassNames: string[];
181
+ itemStatuses: SkyProgressIndicatorItemStatus[];
182
+ constructor(changeDetector: ChangeDetectorRef, windowRef: SkyAppWindowRef, logger: SkyLogService);
183
+ ngOnInit(): void;
184
+ ngAfterContentInit(): void;
185
+ ngOnDestroy(): void;
186
+ sendMessage(message: SkyProgressIndicatorMessage): void;
187
+ static ɵfac: i0.ɵɵFactoryDeclaration<SkyProgressIndicatorComponent, never>;
188
+ static ɵcmp: i0.ɵɵComponentDeclaration<SkyProgressIndicatorComponent, "sky-progress-indicator", never, { "displayMode": { "alias": "displayMode"; "required": false; }; "isPassive": { "alias": "isPassive"; "required": false; }; "messageStream": { "alias": "messageStream"; "required": false; }; "startingIndex": { "alias": "startingIndex"; "required": false; }; }, { "progressChanges": "progressChanges"; }, ["itemComponents"], ["*"], false, never>;
189
+ }
190
+
191
+ declare class SkyProgressIndicatorMarkerClassPipe implements PipeTransform {
192
+ transform(displayMode: string, status: SkyProgressIndicatorItemStatus): string;
193
+ static ɵfac: i0.ɵɵFactoryDeclaration<SkyProgressIndicatorMarkerClassPipe, never>;
194
+ static ɵpipe: i0.ɵɵPipeDeclaration<SkyProgressIndicatorMarkerClassPipe, "skyProgressIndicatorMarkerClass", false>;
195
+ }
196
+
197
+ declare class SkyProgressIndicatorNavButtonClass implements PipeTransform {
198
+ transform(buttonType: string): string[];
199
+ static ɵfac: i0.ɵɵFactoryDeclaration<SkyProgressIndicatorNavButtonClass, never>;
200
+ static ɵpipe: i0.ɵɵPipeDeclaration<SkyProgressIndicatorNavButtonClass, "skyProgressIndicatorNavButtonClass", false>;
201
+ }
202
+
203
+ /**
204
+ * The nav button type.
205
+ */
206
+ type SkyProgressIndicatorNavButtonType = 'finish' | 'next' | 'previous' | 'reset';
207
+
208
+ declare class SkyProgressIndicatorNavButtonDisabledPipe implements PipeTransform {
209
+ transform(disabled: boolean | undefined, buttonType: SkyProgressIndicatorNavButtonType, activeIndex: number | undefined, itemStatuses: SkyProgressIndicatorItemStatus[] | undefined): boolean | undefined;
210
+ static ɵfac: i0.ɵɵFactoryDeclaration<SkyProgressIndicatorNavButtonDisabledPipe, never>;
211
+ static ɵpipe: i0.ɵɵPipeDeclaration<SkyProgressIndicatorNavButtonDisabledPipe, "skyProgressIndicatorNavButtonDisabled", false>;
212
+ }
213
+
214
+ /**
215
+ * Allows the consumer to decide whether the button's action should be completed successfully.
216
+ * The handler is provided with all nav button types.
217
+ */
218
+ declare class SkyProgressIndicatorActionClickProgressHandler {
219
+ readonly advance: () => void;
220
+ /**
221
+ *
222
+ * @param advance Advances the progress indicator to the next step.
223
+ */
224
+ constructor(advance: () => void);
225
+ }
226
+
227
+ /**
228
+ * The arguments passed to the `actionClick` event handler.
229
+ */
230
+ interface SkyProgressIndicatorActionClickArgs {
231
+ /**
232
+ * The progress handler object that allows consumers to trigger step advancement manually.
233
+ */
234
+ progressHandler: SkyProgressIndicatorActionClickProgressHandler;
235
+ /**
236
+ * The mouse event from the user click.
237
+ */
238
+ event: MouseEvent;
239
+ }
240
+
241
+ /**
242
+ * Displays a button to navigate the steps in modal wizards. We recommend against using it in
243
+ * passive progress indicators and waterfall progress indicators.
244
+ */
245
+ declare class SkyProgressIndicatorNavButtonComponent implements AfterViewInit, OnDestroy {
246
+ #private;
247
+ /**
248
+ * The label to display on the nav button.
249
+ * @default "Next"
250
+ */
251
+ buttonText: string | undefined;
252
+ /**
253
+ * The type of nav button to include.
254
+ * @default "next"
255
+ */
256
+ set buttonType(value: SkyProgressIndicatorNavButtonType | undefined);
257
+ get buttonType(): SkyProgressIndicatorNavButtonType;
258
+ /**
259
+ * Whether to disable the nav button.
260
+ * @default false
261
+ */
262
+ set disabled(value: boolean | undefined);
263
+ get disabled(): boolean | undefined;
264
+ /**
265
+ * The progress indicator component to associate with the nav button.
266
+ * @required
267
+ */
268
+ set progressIndicator(value: SkyProgressIndicatorComponent | undefined);
269
+ get progressIndicator(): SkyProgressIndicatorComponent | undefined;
270
+ /**
271
+ * Fires when users select the nav button and emits a `SkyProgressIndicatorActionClickArgs`
272
+ * object that is passed into the callback function to allow consumers to decide whether
273
+ * the button’s action should complete successfully.
274
+ */
275
+ actionClick: EventEmitter<SkyProgressIndicatorActionClickArgs>;
276
+ set isVisible(value: boolean | undefined);
277
+ get isVisible(): boolean | undefined;
278
+ lastProgressChange: SkyProgressIndicatorChange | undefined;
279
+ constructor(changeDetector: ChangeDetectorRef, parentComponent?: SkyProgressIndicatorComponent);
280
+ ngAfterViewInit(): void;
281
+ ngOnDestroy(): void;
282
+ onClick(event: MouseEvent): void;
283
+ static ɵfac: i0.ɵɵFactoryDeclaration<SkyProgressIndicatorNavButtonComponent, [null, { optional: true; }]>;
284
+ static ɵcmp: i0.ɵɵComponentDeclaration<SkyProgressIndicatorNavButtonComponent, "sky-progress-indicator-nav-button", never, { "buttonText": { "alias": "buttonText"; "required": false; }; "buttonType": { "alias": "buttonType"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; "progressIndicator": { "alias": "progressIndicator"; "required": false; }; }, { "actionClick": "actionClick"; }, never, never, false, never>;
285
+ }
286
+
287
+ /**
288
+ * Displays a button to mark all items in the progress indicator as incomplete and set the
289
+ * first item as the active item. The steps after the active item remain incomplete until
290
+ * users reach them in their sequential order.
291
+ */
292
+ declare class SkyProgressIndicatorResetButtonComponent implements OnDestroy {
293
+ #private;
294
+ /**
295
+ * Whether to disable the reset button.
296
+ * @default false
297
+ */
298
+ set disabled(value: boolean | undefined);
299
+ get disabled(): boolean | undefined;
300
+ /**
301
+ * The progress indicator component to associate with the reset button.
302
+ * @required
303
+ */
304
+ progressIndicator: SkyProgressIndicatorComponent | undefined;
305
+ /**
306
+ * Fires when users select the reset button that marks all items as incomplete and sets the
307
+ * first item as the active item.
308
+ */
309
+ resetClick: EventEmitter<void>;
310
+ constructor(changeDetector: ChangeDetectorRef);
311
+ ngOnDestroy(): void;
312
+ onClick(): void;
313
+ static ɵfac: i0.ɵɵFactoryDeclaration<SkyProgressIndicatorResetButtonComponent, never>;
314
+ static ɵcmp: i0.ɵɵComponentDeclaration<SkyProgressIndicatorResetButtonComponent, "sky-progress-indicator-reset-button", never, { "disabled": { "alias": "disabled"; "required": false; }; "progressIndicator": { "alias": "progressIndicator"; "required": false; }; }, { "resetClick": "resetClick"; }, never, ["*"], false, never>;
315
+ }
316
+
317
+ /**
318
+ * Specifies the content to display in the status marker.
319
+ * @internal
320
+ */
321
+ declare class SkyProgressIndicatorStatusMarkerComponent implements OnDestroy {
322
+ #private;
323
+ set displayMode(value: 'vertical' | 'horizontal');
324
+ get displayMode(): 'vertical' | 'horizontal';
325
+ set status(value: SkyProgressIndicatorItemStatus);
326
+ get status(): SkyProgressIndicatorItemStatus;
327
+ isComplete: boolean;
328
+ constructor(changeDetector: ChangeDetectorRef, themeSvc?: SkyThemeService);
329
+ ngOnDestroy(): void;
330
+ static ɵfac: i0.ɵɵFactoryDeclaration<SkyProgressIndicatorStatusMarkerComponent, [null, { optional: true; }]>;
331
+ static ɵcmp: i0.ɵɵComponentDeclaration<SkyProgressIndicatorStatusMarkerComponent, "sky-progress-indicator-status-marker", never, { "displayMode": { "alias": "displayMode"; "required": false; }; "status": { "alias": "status"; "required": false; }; }, {}, never, never, false, never>;
332
+ }
333
+
334
+ /**
335
+ * Specifies a header to display above the progress indicator.
336
+ */
337
+ declare class SkyProgressIndicatorTitleComponent {
338
+ static ɵfac: i0.ɵɵFactoryDeclaration<SkyProgressIndicatorTitleComponent, never>;
339
+ static ɵcmp: i0.ɵɵComponentDeclaration<SkyProgressIndicatorTitleComponent, "sky-progress-indicator-title", never, {}, {}, never, ["*"], false, never>;
340
+ }
341
+
342
+ /**
343
+ * Import into any component library module that needs to use resource strings.
344
+ */
345
+ declare class SkyProgressIndicatorResourcesModule {
346
+ static ɵfac: i0.ɵɵFactoryDeclaration<SkyProgressIndicatorResourcesModule, never>;
347
+ static ɵmod: i0.ɵɵNgModuleDeclaration<SkyProgressIndicatorResourcesModule, never, never, [typeof i1.SkyI18nModule]>;
348
+ static ɵinj: i0.ɵɵInjectorDeclaration<SkyProgressIndicatorResourcesModule>;
349
+ }
350
+
351
+ declare class SkyProgressIndicatorModule {
352
+ static ɵfac: i0.ɵɵFactoryDeclaration<SkyProgressIndicatorModule, never>;
353
+ static ɵmod: i0.ɵɵNgModuleDeclaration<SkyProgressIndicatorModule, [typeof SkyProgressIndicatorComponent, typeof SkyProgressIndicatorItemComponent, typeof SkyProgressIndicatorMarkerClassPipe, typeof SkyProgressIndicatorNavButtonClass, typeof SkyProgressIndicatorNavButtonDisabledPipe, typeof SkyProgressIndicatorNavButtonComponent, typeof SkyProgressIndicatorResetButtonComponent, typeof SkyProgressIndicatorStatusMarkerComponent, typeof SkyProgressIndicatorTitleComponent], [typeof i10.CommonModule, typeof i11.SkyHelpInlineModule, typeof i12.SkyIconModule, typeof SkyProgressIndicatorResourcesModule, typeof i14.SkyThemeModule, typeof i15.SkyTrimModule], [typeof SkyProgressIndicatorComponent, typeof SkyProgressIndicatorItemComponent, typeof SkyProgressIndicatorNavButtonComponent, typeof SkyProgressIndicatorResetButtonComponent, typeof SkyProgressIndicatorTitleComponent]>;
354
+ static ɵinj: i0.ɵɵInjectorDeclaration<SkyProgressIndicatorModule>;
355
+ }
356
+
357
+ /**
358
+ * @deprecated Use `SkyProgressIndicatorDisplayModeType` instead.
359
+ * @internal
360
+ */
361
+ declare enum SkyProgressIndicatorDisplayMode {
362
+ /**
363
+ * The vertical layout for the progress indicator.
364
+ */
365
+ Vertical = 0,
366
+ /**
367
+ * The horizontal layout for the progress indicator.
368
+ */
369
+ Horizontal = 1
370
+ }
371
+
372
+ export { SkyProgressIndicatorActionClickProgressHandler, SkyProgressIndicatorDisplayMode, SkyProgressIndicatorItemStatus, SkyProgressIndicatorMessageType, SkyProgressIndicatorModule, SkyProgressIndicatorItemComponent as λ1, SkyProgressIndicatorComponent as λ2, SkyProgressIndicatorNavButtonComponent as λ3, SkyProgressIndicatorResetButtonComponent as λ4, SkyProgressIndicatorTitleComponent as λ5 };
373
+ export type { SkyProgressIndicatorActionClickArgs, SkyProgressIndicatorChange, SkyProgressIndicatorDisplayModeType, SkyProgressIndicatorMessage, SkyProgressIndicatorNavButtonType };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@skyux/progress-indicator",
3
- "version": "12.22.0",
3
+ "version": "13.0.0-alpha.0",
4
4
  "author": "Blackbaud, Inc.",
5
5
  "keywords": [
6
6
  "blackbaud",
@@ -16,14 +16,14 @@
16
16
  },
17
17
  "homepage": "https://github.com/blackbaud/skyux#readme",
18
18
  "peerDependencies": {
19
- "@angular/cdk": "^19.2.10",
20
- "@angular/common": "^19.2.7",
21
- "@angular/core": "^19.2.7",
22
- "@skyux/core": "12.22.0",
23
- "@skyux/help-inline": "12.22.0",
24
- "@skyux/i18n": "12.22.0",
25
- "@skyux/icon": "12.22.0",
26
- "@skyux/theme": "12.22.0"
19
+ "@angular/cdk": "^20.0.4",
20
+ "@angular/common": "^20.0.5",
21
+ "@angular/core": "^20.0.5",
22
+ "@skyux/core": "13.0.0-alpha.0",
23
+ "@skyux/help-inline": "13.0.0-alpha.0",
24
+ "@skyux/i18n": "13.0.0-alpha.0",
25
+ "@skyux/icon": "13.0.0-alpha.0",
26
+ "@skyux/theme": "13.0.0-alpha.0"
27
27
  },
28
28
  "dependencies": {
29
29
  "tslib": "^2.8.1"
@@ -1,5 +1,89 @@
1
+ import { SkyHarnessFilters, SkyComponentHarness } from '@skyux/core/testing';
2
+ import { HarnessPredicate } from '@angular/cdk/testing';
3
+
1
4
  /**
2
- * Generated bundle index. Do not edit.
5
+ * A set of criteria that can be used to filter a list of `SkyProgressIndicatorHarness` instances.
3
6
  */
4
- /// <amd-module name="@skyux/progress-indicator/testing" />
5
- export * from './public-api';
7
+ interface SkyProgressIndicatorFilters extends SkyHarnessFilters {
8
+ }
9
+
10
+ /**
11
+ * A set of criteria that can be used to filter a list of `SkyProgressIndicatorItemHarness` instances.
12
+ */
13
+ interface SkyProgressIndicatorItemFilters extends SkyHarnessFilters {
14
+ }
15
+
16
+ /**
17
+ * Harness for interacting with a progress indicator item component in tests.
18
+ */
19
+ declare class SkyProgressIndicatorItemHarness extends SkyComponentHarness {
20
+ #private;
21
+ /**
22
+ * @internal
23
+ */
24
+ static hostSelector: string;
25
+ /**
26
+ * Gets a `HarnessPredicate` that can be used to search for a
27
+ * `SkyProgressIndicatorItemHarness` that meets certain criteria
28
+ */
29
+ static with(filters: SkyProgressIndicatorItemFilters): HarnessPredicate<SkyProgressIndicatorItemHarness>;
30
+ /**
31
+ * Clicks the help inline button.
32
+ */
33
+ clickHelpInline(): Promise<void>;
34
+ /**
35
+ * Gets the help inline popover content.
36
+ */
37
+ getHelpPopoverContent(): Promise<string | undefined>;
38
+ /**
39
+ * Gets the help inline popover title.
40
+ */
41
+ getHelpPopoverTitle(): Promise<string | undefined>;
42
+ /**
43
+ * Gets the progress indicator item's title text.
44
+ */
45
+ getTitle(): Promise<string>;
46
+ /**
47
+ * Whether the indicator item step is completed.
48
+ */
49
+ isCompleted(): Promise<boolean>;
50
+ }
51
+
52
+ /**
53
+ * Harness for interacting with a progress indicator component in tests.
54
+ */
55
+ declare class SkyProgressIndicatorHarness extends SkyComponentHarness {
56
+ #private;
57
+ /**
58
+ * @internal
59
+ */
60
+ static hostSelector: string;
61
+ /**
62
+ * Gets a `HarnessPredicate` that can be used to search for a
63
+ * `SkyProgressIndicatorHarness` that meets certain criteria.
64
+ */
65
+ static with(filters: SkyProgressIndicatorFilters): HarnessPredicate<SkyProgressIndicatorHarness>;
66
+ /**
67
+ * Clicks the reset button.
68
+ */
69
+ clickResetButton(): Promise<void>;
70
+ /**
71
+ * Gets a specific progress indicator item that meets certain criteria.
72
+ */
73
+ getItem(filter: SkyProgressIndicatorItemFilters): Promise<SkyProgressIndicatorItemHarness>;
74
+ /**
75
+ * Gets an array of all progress indicator items.
76
+ */
77
+ getItems(filters?: SkyProgressIndicatorItemFilters): Promise<SkyProgressIndicatorItemHarness[]>;
78
+ /**
79
+ * Gets the progress indicator title.
80
+ */
81
+ getTitle(): Promise<string>;
82
+ /**
83
+ * Whether the progress indicator is passive.
84
+ */
85
+ isPassive(): Promise<boolean>;
86
+ }
87
+
88
+ export { SkyProgressIndicatorHarness, SkyProgressIndicatorItemHarness };
89
+ export type { SkyProgressIndicatorFilters, SkyProgressIndicatorItemFilters };
@@ -1,49 +0,0 @@
1
- import { ChangeDetectorRef, OnInit, TemplateRef } from '@angular/core';
2
- import { SkyProgressIndicatorItemStatus } from '../types/progress-indicator-item-status';
3
- import * as i0 from "@angular/core";
4
- /**
5
- * Specifies a step to include in the progress indicator. Each step requires a label,
6
- * and you can also specify step details within the `sky-progress-indicator-item` element.
7
- */
8
- export declare class SkyProgressIndicatorItemComponent implements OnInit {
9
- #private;
10
- /**
11
- * The step label for the step in the progress indicator.
12
- * @required
13
- */
14
- set title(value: string | undefined);
15
- get title(): string | undefined;
16
- /**
17
- * A help key that identifies the global help content to display. When specified along with `title`, a [help inline](https://developer.blackbaud.com/skyux/components/help-inline) button is
18
- * placed beside the progress indicator item label. Clicking the button invokes global help as configured by the application.
19
- * This property only applies when `title` is also specified.
20
- */
21
- helpKey: string | undefined;
22
- /**
23
- * The content of the help popover. When specified along with `title`, a [help inline](https://developer.blackbaud.com/skyux/components/help-inline)
24
- * button is added to the progress indicator item label. The help inline button displays a [popover](https://developer.blackbaud.com/skyux/components/popover)
25
- * when clicked using the specified content and optional title. This property only applies when `title` is also specified.
26
- */
27
- helpPopoverContent: string | TemplateRef<unknown> | undefined;
28
- /**
29
- * The title of the help popover. This property only applies when `helpPopoverContent` is
30
- * also specified.
31
- */
32
- helpPopoverTitle: string | undefined;
33
- set status(value: SkyProgressIndicatorItemStatus | undefined);
34
- get status(): SkyProgressIndicatorItemStatus;
35
- formattedTitle: string | undefined;
36
- set isVisible(value: boolean | undefined);
37
- get isVisible(): boolean;
38
- set showStatusMarker(value: boolean | undefined);
39
- get showStatusMarker(): boolean;
40
- set showTitle(value: boolean | undefined);
41
- get showTitle(): boolean;
42
- statusName: string;
43
- constructor(changeDetector: ChangeDetectorRef);
44
- ngOnInit(): void;
45
- showStepNumber(step: number): void;
46
- hideStepNumber(): void;
47
- static ɵfac: i0.ɵɵFactoryDeclaration<SkyProgressIndicatorItemComponent, never>;
48
- static ɵcmp: i0.ɵɵComponentDeclaration<SkyProgressIndicatorItemComponent, "sky-progress-indicator-item", never, { "title": { "alias": "title"; "required": false; }; "helpKey": { "alias": "helpKey"; "required": false; }; "helpPopoverContent": { "alias": "helpPopoverContent"; "required": false; }; "helpPopoverTitle": { "alias": "helpPopoverTitle"; "required": false; }; }, {}, never, [".sky-control-help", "*"], false, never>;
49
- }
@@ -1,7 +0,0 @@
1
- import { PipeTransform } from '@angular/core';
2
- import * as i0 from "@angular/core";
3
- export declare class SkyProgressIndicatorNavButtonClass implements PipeTransform {
4
- transform(buttonType: string): string[];
5
- static ɵfac: i0.ɵɵFactoryDeclaration<SkyProgressIndicatorNavButtonClass, never>;
6
- static ɵpipe: i0.ɵɵPipeDeclaration<SkyProgressIndicatorNavButtonClass, "skyProgressIndicatorNavButtonClass", false>;
7
- }
@@ -1,9 +0,0 @@
1
- import { PipeTransform } from '@angular/core';
2
- import { SkyProgressIndicatorItemStatus } from '../types/progress-indicator-item-status';
3
- import { SkyProgressIndicatorNavButtonType } from '../types/progress-indicator-nav-button-type';
4
- import * as i0 from "@angular/core";
5
- export declare class SkyProgressIndicatorNavButtonDisabledPipe implements PipeTransform {
6
- transform(disabled: boolean | undefined, buttonType: SkyProgressIndicatorNavButtonType, activeIndex: number | undefined, itemStatuses: SkyProgressIndicatorItemStatus[] | undefined): boolean | undefined;
7
- static ɵfac: i0.ɵɵFactoryDeclaration<SkyProgressIndicatorNavButtonDisabledPipe, never>;
8
- static ɵpipe: i0.ɵɵPipeDeclaration<SkyProgressIndicatorNavButtonDisabledPipe, "skyProgressIndicatorNavButtonDisabled", false>;
9
- }
@@ -1,51 +0,0 @@
1
- import { AfterViewInit, ChangeDetectorRef, EventEmitter, OnDestroy } from '@angular/core';
2
- import { SkyProgressIndicatorComponent } from '../progress-indicator.component';
3
- import { SkyProgressIndicatorActionClickArgs } from '../types/progress-indicator-action-click-args';
4
- import { SkyProgressIndicatorChange } from '../types/progress-indicator-change';
5
- import { SkyProgressIndicatorNavButtonType } from '../types/progress-indicator-nav-button-type';
6
- import * as i0 from "@angular/core";
7
- /**
8
- * Displays a button to navigate the steps in modal wizards. We recommend against using it in
9
- * passive progress indicators and waterfall progress indicators.
10
- */
11
- export declare class SkyProgressIndicatorNavButtonComponent implements AfterViewInit, OnDestroy {
12
- #private;
13
- /**
14
- * The label to display on the nav button.
15
- * @default "Next"
16
- */
17
- buttonText: string | undefined;
18
- /**
19
- * The type of nav button to include.
20
- * @default "next"
21
- */
22
- set buttonType(value: SkyProgressIndicatorNavButtonType | undefined);
23
- get buttonType(): SkyProgressIndicatorNavButtonType;
24
- /**
25
- * Whether to disable the nav button.
26
- * @default false
27
- */
28
- set disabled(value: boolean | undefined);
29
- get disabled(): boolean | undefined;
30
- /**
31
- * The progress indicator component to associate with the nav button.
32
- * @required
33
- */
34
- set progressIndicator(value: SkyProgressIndicatorComponent | undefined);
35
- get progressIndicator(): SkyProgressIndicatorComponent | undefined;
36
- /**
37
- * Fires when users select the nav button and emits a `SkyProgressIndicatorActionClickArgs`
38
- * object that is passed into the callback function to allow consumers to decide whether
39
- * the button’s action should complete successfully.
40
- */
41
- actionClick: EventEmitter<SkyProgressIndicatorActionClickArgs>;
42
- set isVisible(value: boolean | undefined);
43
- get isVisible(): boolean | undefined;
44
- lastProgressChange: SkyProgressIndicatorChange | undefined;
45
- constructor(changeDetector: ChangeDetectorRef, parentComponent?: SkyProgressIndicatorComponent);
46
- ngAfterViewInit(): void;
47
- ngOnDestroy(): void;
48
- onClick(event: MouseEvent): void;
49
- static ɵfac: i0.ɵɵFactoryDeclaration<SkyProgressIndicatorNavButtonComponent, [null, { optional: true; }]>;
50
- static ɵcmp: i0.ɵɵComponentDeclaration<SkyProgressIndicatorNavButtonComponent, "sky-progress-indicator-nav-button", never, { "buttonText": { "alias": "buttonText"; "required": false; }; "buttonType": { "alias": "buttonType"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; "progressIndicator": { "alias": "progressIndicator"; "required": false; }; }, { "actionClick": "actionClick"; }, never, never, false, never>;
51
- }