@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
@@ -1,32 +0,0 @@
1
- import { ChangeDetectorRef, EventEmitter, OnDestroy } from '@angular/core';
2
- import { SkyProgressIndicatorComponent } from '../progress-indicator.component';
3
- import * as i0 from "@angular/core";
4
- /**
5
- * Displays a button to mark all items in the progress indicator as incomplete and set the
6
- * first item as the active item. The steps after the active item remain incomplete until
7
- * users reach them in their sequential order.
8
- */
9
- export declare class SkyProgressIndicatorResetButtonComponent implements OnDestroy {
10
- #private;
11
- /**
12
- * Whether to disable the reset button.
13
- * @default false
14
- */
15
- set disabled(value: boolean | undefined);
16
- get disabled(): boolean | undefined;
17
- /**
18
- * The progress indicator component to associate with the reset button.
19
- * @required
20
- */
21
- progressIndicator: SkyProgressIndicatorComponent | undefined;
22
- /**
23
- * Fires when users select the reset button that marks all items as incomplete and sets the
24
- * first item as the active item.
25
- */
26
- resetClick: EventEmitter<void>;
27
- constructor(changeDetector: ChangeDetectorRef);
28
- ngOnDestroy(): void;
29
- onClick(): void;
30
- static ɵfac: i0.ɵɵFactoryDeclaration<SkyProgressIndicatorResetButtonComponent, never>;
31
- 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>;
32
- }
@@ -1,8 +0,0 @@
1
- import { PipeTransform } from '@angular/core';
2
- import { SkyProgressIndicatorItemStatus } from '../types/progress-indicator-item-status';
3
- import * as i0 from "@angular/core";
4
- export declare class SkyProgressIndicatorMarkerClassPipe implements PipeTransform {
5
- transform(displayMode: string, status: SkyProgressIndicatorItemStatus): string;
6
- static ɵfac: i0.ɵɵFactoryDeclaration<SkyProgressIndicatorMarkerClassPipe, never>;
7
- static ɵpipe: i0.ɵɵPipeDeclaration<SkyProgressIndicatorMarkerClassPipe, "skyProgressIndicatorMarkerClass", false>;
8
- }
@@ -1,20 +0,0 @@
1
- import { ChangeDetectorRef, OnDestroy } from '@angular/core';
2
- import { SkyThemeService } from '@skyux/theme';
3
- import { SkyProgressIndicatorItemStatus } from '../types/progress-indicator-item-status';
4
- import * as i0 from "@angular/core";
5
- /**
6
- * Specifies the content to display in the status marker.
7
- * @internal
8
- */
9
- export declare class SkyProgressIndicatorStatusMarkerComponent implements OnDestroy {
10
- #private;
11
- set displayMode(value: 'vertical' | 'horizontal');
12
- get displayMode(): 'vertical' | 'horizontal';
13
- set status(value: SkyProgressIndicatorItemStatus);
14
- get status(): SkyProgressIndicatorItemStatus;
15
- isComplete: boolean;
16
- constructor(changeDetector: ChangeDetectorRef, themeSvc?: SkyThemeService);
17
- ngOnDestroy(): void;
18
- static ɵfac: i0.ɵɵFactoryDeclaration<SkyProgressIndicatorStatusMarkerComponent, [null, { optional: true; }]>;
19
- 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>;
20
- }
@@ -1,8 +0,0 @@
1
- import * as i0 from "@angular/core";
2
- /**
3
- * Specifies a header to display above the progress indicator.
4
- */
5
- export declare class SkyProgressIndicatorTitleComponent {
6
- static ɵfac: i0.ɵɵFactoryDeclaration<SkyProgressIndicatorTitleComponent, never>;
7
- static ɵcmp: i0.ɵɵComponentDeclaration<SkyProgressIndicatorTitleComponent, "sky-progress-indicator-title", never, {}, {}, never, ["*"], false, never>;
8
- }
@@ -1,62 +0,0 @@
1
- import { AfterContentInit, ChangeDetectorRef, EventEmitter, OnDestroy, OnInit, QueryList } from '@angular/core';
2
- import { SkyAppWindowRef, SkyLogService } from '@skyux/core';
3
- import { Subject } from 'rxjs';
4
- import { SkyProgressIndicatorItemComponent } from './progress-indicator-item/progress-indicator-item.component';
5
- import { SkyProgressIndicatorChange } from './types/progress-indicator-change';
6
- import { SkyProgressIndicatorDisplayModeType } from './types/progress-indicator-display-mode-type';
7
- import { SkyProgressIndicatorItemStatus } from './types/progress-indicator-item-status';
8
- import { SkyProgressIndicatorMessage } from './types/progress-indicator-message';
9
- import { SkyProgressIndicatorMessageType } from './types/progress-indicator-message-type';
10
- import * as i0 from "@angular/core";
11
- export declare class SkyProgressIndicatorComponent implements OnInit, AfterContentInit, OnDestroy {
12
- #private;
13
- /**
14
- * The orientation of the progress indicator, which can be vertical or horizontal.
15
- * For [passive progress indicators](https://developer.blackbaud.com/skyux-progress-indicator/docs/passive-indicator)
16
- * and [waterfall progress indicators](https://developer.blackbaud.com/skyux/components/progress-indicator/waterfall-progress-indicator),
17
- * use the vertical display mode. For [modal wizards](https://developer.blackbaud.com/skyux/components/wizard),
18
- * use the horizontal display mode.
19
- * @deprecated The property was designed to create wizards by setting `displayMode="horizontal"` on progress indicators in modals,
20
- * but this wizard implementation was replaced by the
21
- * [Wizard (Tabs) component](https://developer.blackbaud.com/skyux/components/progress-indicator).
22
- * @default "vertical"
23
- */
24
- set displayMode(value: SkyProgressIndicatorDisplayModeType | undefined);
25
- get displayMode(): SkyProgressIndicatorDisplayModeType;
26
- /**
27
- * Whether the progress indicator is passive. Passive progress indicators inform users of
28
- * progress that concerns them but that they are not responsible for, and they must use the vertical display mode.
29
- * @default false
30
- */
31
- set isPassive(value: boolean | undefined);
32
- get isPassive(): boolean | undefined;
33
- /**
34
- * The observable of `SkyProgressIndicatorMessage` that determines the status to
35
- * display for items in the progress indicator. The message stream is a queue of
36
- * commanding messages to change the state of the progress indicator based on the message type.
37
- */
38
- set messageStream(value: Subject<SkyProgressIndicatorMessage | SkyProgressIndicatorMessageType> | undefined);
39
- /**
40
- * The index for the item to make active when the progress indicator
41
- * loads. All steps that precede the active item are marked as complete, and all steps
42
- * that follow the active item are marked as incomplete.
43
- */
44
- set startingIndex(value: number | undefined);
45
- get startingIndex(): number;
46
- /**
47
- * Fires when the progress indicator changes the status of an item.
48
- */
49
- progressChanges: EventEmitter<SkyProgressIndicatorChange>;
50
- get hasFinishButton(): boolean | undefined;
51
- set hasFinishButton(value: boolean | undefined);
52
- itemComponents: QueryList<SkyProgressIndicatorItemComponent> | undefined;
53
- cssClassNames: string[];
54
- itemStatuses: SkyProgressIndicatorItemStatus[];
55
- constructor(changeDetector: ChangeDetectorRef, windowRef: SkyAppWindowRef, logger: SkyLogService);
56
- ngOnInit(): void;
57
- ngAfterContentInit(): void;
58
- ngOnDestroy(): void;
59
- sendMessage(message: SkyProgressIndicatorMessage): void;
60
- static ɵfac: i0.ɵɵFactoryDeclaration<SkyProgressIndicatorComponent, never>;
61
- 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>;
62
- }
@@ -1,21 +0,0 @@
1
- import * as i0 from "@angular/core";
2
- import * as i1 from "./progress-indicator.component";
3
- import * as i2 from "./progress-indicator-item/progress-indicator-item.component";
4
- import * as i3 from "./progress-indicator-status-marker/progress-indicator-status-marker-class.pipe";
5
- import * as i4 from "./progress-indicator-nav-button/progress-indicator-nav-button-class.pipe";
6
- import * as i5 from "./progress-indicator-nav-button/progress-indicator-nav-button-disabled.pipe";
7
- import * as i6 from "./progress-indicator-nav-button/progress-indicator-nav-button.component";
8
- import * as i7 from "./progress-indicator-reset-button/progress-indicator-reset-button.component";
9
- import * as i8 from "./progress-indicator-status-marker/progress-indicator-status-marker.component";
10
- import * as i9 from "./progress-indicator-title/progress-indicator-title.component";
11
- import * as i10 from "@angular/common";
12
- import * as i11 from "@skyux/help-inline";
13
- import * as i12 from "@skyux/icon";
14
- import * as i13 from "../shared/sky-progress-indicator-resources.module";
15
- import * as i14 from "@skyux/theme";
16
- import * as i15 from "@skyux/core";
17
- export declare class SkyProgressIndicatorModule {
18
- static ɵfac: i0.ɵɵFactoryDeclaration<SkyProgressIndicatorModule, never>;
19
- static ɵmod: i0.ɵɵNgModuleDeclaration<SkyProgressIndicatorModule, [typeof i1.SkyProgressIndicatorComponent, typeof i2.SkyProgressIndicatorItemComponent, typeof i3.SkyProgressIndicatorMarkerClassPipe, typeof i4.SkyProgressIndicatorNavButtonClass, typeof i5.SkyProgressIndicatorNavButtonDisabledPipe, typeof i6.SkyProgressIndicatorNavButtonComponent, typeof i7.SkyProgressIndicatorResetButtonComponent, typeof i8.SkyProgressIndicatorStatusMarkerComponent, typeof i9.SkyProgressIndicatorTitleComponent], [typeof i10.CommonModule, typeof i11.SkyHelpInlineModule, typeof i12.SkyIconModule, typeof i13.SkyProgressIndicatorResourcesModule, typeof i14.SkyThemeModule, typeof i15.SkyTrimModule], [typeof i1.SkyProgressIndicatorComponent, typeof i2.SkyProgressIndicatorItemComponent, typeof i6.SkyProgressIndicatorNavButtonComponent, typeof i7.SkyProgressIndicatorResetButtonComponent, typeof i9.SkyProgressIndicatorTitleComponent]>;
20
- static ɵinj: i0.ɵɵInjectorDeclaration<SkyProgressIndicatorModule>;
21
- }
@@ -1,14 +0,0 @@
1
- import { SkyProgressIndicatorActionClickProgressHandler } from './progress-indicator-action-click-progress-handler';
2
- /**
3
- * The arguments passed to the `actionClick` event handler.
4
- */
5
- export interface SkyProgressIndicatorActionClickArgs {
6
- /**
7
- * The progress handler object that allows consumers to trigger step advancement manually.
8
- */
9
- progressHandler: SkyProgressIndicatorActionClickProgressHandler;
10
- /**
11
- * The mouse event from the user click.
12
- */
13
- event: MouseEvent;
14
- }
@@ -1,12 +0,0 @@
1
- /**
2
- * Allows the consumer to decide whether the button's action should be completed successfully.
3
- * The handler is provided with all nav button types.
4
- */
5
- export declare class SkyProgressIndicatorActionClickProgressHandler {
6
- readonly advance: () => void;
7
- /**
8
- *
9
- * @param advance Advances the progress indicator to the next step.
10
- */
11
- constructor(advance: () => void);
12
- }
@@ -1,15 +0,0 @@
1
- import { SkyProgressIndicatorItemStatus } from './progress-indicator-item-status';
2
- export interface SkyProgressIndicatorChange {
3
- /**
4
- * The active item.
5
- */
6
- activeIndex?: number;
7
- /**
8
- * Whether the progress indicator is complete.
9
- */
10
- isComplete?: boolean;
11
- /**
12
- * The array with the status of each item.
13
- */
14
- itemStatuses?: SkyProgressIndicatorItemStatus[];
15
- }
@@ -1 +0,0 @@
1
- export type SkyProgressIndicatorDisplayModeType = 0 | 1 | 'vertical' | 'horizontal';
@@ -1,18 +0,0 @@
1
- export declare enum SkyProgressIndicatorItemStatus {
2
- /**
3
- * The item is active.
4
- */
5
- Active = 0,
6
- /**
7
- * The item is complete.
8
- */
9
- Complete = 1,
10
- /**
11
- * The item is incomplete.
12
- */
13
- Incomplete = 2,
14
- /**
15
- * The item is pending.
16
- */
17
- Pending = 3
18
- }
@@ -1,26 +0,0 @@
1
- export declare enum SkyProgressIndicatorMessageType {
2
- /**
3
- * The current step is complete.
4
- * This completes the active item and moves to the next item.
5
- */
6
- Progress = 0,
7
- /**
8
- * Returns progress to the previous step.
9
- * This moves from the active item to the item that precedes it.
10
- */
11
- Regress = 1,
12
- /**
13
- * Progress is incomplete.
14
- * This marks all items as incomplete and sets the first item as the active item.
15
- */
16
- Reset = 2,
17
- /**
18
- * Progress is complete.
19
- * This marks all items as complete and sets the last item as the active item.
20
- */
21
- Finish = 3,
22
- /**
23
- * Moves progress to the item indicated by the `data.activeIndex` property.
24
- */
25
- GoTo = 4
26
- }
@@ -1,15 +0,0 @@
1
- import { SkyProgressIndicatorMessageType } from './progress-indicator-message-type';
2
- export interface SkyProgressIndicatorMessage {
3
- /**
4
- * The type of state change for the progress indicator.
5
- */
6
- type: SkyProgressIndicatorMessageType;
7
- /**
8
- * Used in conjunction with SkyProgressIndicatorMessageType.GoTo
9
- * to travel to a specific step by specifying an index number on the `data.activeIndex` property.
10
- */
11
- data?: {
12
- activeIndex?: number;
13
- [key: string]: any;
14
- };
15
- }
@@ -1,14 +0,0 @@
1
- /**
2
- * @deprecated Use `SkyProgressIndicatorDisplayModeType` instead.
3
- * @internal
4
- */
5
- export declare enum SkyProgressIndicatorDisplayMode {
6
- /**
7
- * The vertical layout for the progress indicator.
8
- */
9
- Vertical = 0,
10
- /**
11
- * The horizontal layout for the progress indicator.
12
- */
13
- Horizontal = 1
14
- }
@@ -1,4 +0,0 @@
1
- /**
2
- * The nav button type.
3
- */
4
- export type SkyProgressIndicatorNavButtonType = 'finish' | 'next' | 'previous' | 'reset';
@@ -1,10 +0,0 @@
1
- import * as i0 from "@angular/core";
2
- import * as i1 from "@skyux/i18n";
3
- /**
4
- * Import into any component library module that needs to use resource strings.
5
- */
6
- export declare class SkyProgressIndicatorResourcesModule {
7
- static ɵfac: i0.ɵɵFactoryDeclaration<SkyProgressIndicatorResourcesModule, never>;
8
- static ɵmod: i0.ɵɵNgModuleDeclaration<SkyProgressIndicatorResourcesModule, never, never, [typeof i1.SkyI18nModule]>;
9
- static ɵinj: i0.ɵɵInjectorDeclaration<SkyProgressIndicatorResourcesModule>;
10
- }
@@ -1,6 +0,0 @@
1
- import { SkyHarnessFilters } from '@skyux/core/testing';
2
- /**
3
- * A set of criteria that can be used to filter a list of `SkyProgressIndicatorHarness` instances.
4
- */
5
- export interface SkyProgressIndicatorFilters extends SkyHarnessFilters {
6
- }
@@ -1,40 +0,0 @@
1
- import { HarnessPredicate } from '@angular/cdk/testing';
2
- import { SkyComponentHarness } from '@skyux/core/testing';
3
- import { SkyProgressIndicatorFilters } from './progress-indicator-harness-filters';
4
- import { SkyProgressIndicatorItemHarness } from './progress-indicator-item-harness';
5
- import { SkyProgressIndicatorItemFilters } from './progress-indicator-item-harness-filters';
6
- /**
7
- * Harness for interacting with a progress indicator component in tests.
8
- */
9
- export declare class SkyProgressIndicatorHarness extends SkyComponentHarness {
10
- #private;
11
- /**
12
- * @internal
13
- */
14
- static hostSelector: string;
15
- /**
16
- * Gets a `HarnessPredicate` that can be used to search for a
17
- * `SkyProgressIndicatorHarness` that meets certain criteria.
18
- */
19
- static with(filters: SkyProgressIndicatorFilters): HarnessPredicate<SkyProgressIndicatorHarness>;
20
- /**
21
- * Clicks the reset button.
22
- */
23
- clickResetButton(): Promise<void>;
24
- /**
25
- * Gets a specific progress indicator item that meets certain criteria.
26
- */
27
- getItem(filter: SkyProgressIndicatorItemFilters): Promise<SkyProgressIndicatorItemHarness>;
28
- /**
29
- * Gets an array of all progress indicator items.
30
- */
31
- getItems(filters?: SkyProgressIndicatorItemFilters): Promise<SkyProgressIndicatorItemHarness[]>;
32
- /**
33
- * Gets the progress indicator title.
34
- */
35
- getTitle(): Promise<string>;
36
- /**
37
- * Whether the progress indicator is passive.
38
- */
39
- isPassive(): Promise<boolean>;
40
- }
@@ -1,6 +0,0 @@
1
- import { SkyHarnessFilters } from '@skyux/core/testing';
2
- /**
3
- * A set of criteria that can be used to filter a list of `SkyProgressIndicatorItemHarness` instances.
4
- */
5
- export interface SkyProgressIndicatorItemFilters extends SkyHarnessFilters {
6
- }
@@ -1,38 +0,0 @@
1
- import { HarnessPredicate } from '@angular/cdk/testing';
2
- import { SkyComponentHarness } from '@skyux/core/testing';
3
- import { SkyProgressIndicatorItemFilters } from './progress-indicator-item-harness-filters';
4
- /**
5
- * Harness for interacting with a progress indicator item component in tests.
6
- */
7
- export declare class SkyProgressIndicatorItemHarness extends SkyComponentHarness {
8
- #private;
9
- /**
10
- * @internal
11
- */
12
- static hostSelector: string;
13
- /**
14
- * Gets a `HarnessPredicate` that can be used to search for a
15
- * `SkyProgressIndicatorItemHarness` that meets certain criteria
16
- */
17
- static with(filters: SkyProgressIndicatorItemFilters): HarnessPredicate<SkyProgressIndicatorItemHarness>;
18
- /**
19
- * Clicks the help inline button.
20
- */
21
- clickHelpInline(): Promise<void>;
22
- /**
23
- * Gets the help inline popover content.
24
- */
25
- getHelpPopoverContent(): Promise<string | undefined>;
26
- /**
27
- * Gets the help inline popover title.
28
- */
29
- getHelpPopoverTitle(): Promise<string | undefined>;
30
- /**
31
- * Gets the progress indicator item's title text.
32
- */
33
- getTitle(): Promise<string>;
34
- /**
35
- * Whether the indicator item step is completed.
36
- */
37
- isCompleted(): Promise<boolean>;
38
- }
@@ -1,4 +0,0 @@
1
- export { SkyProgressIndicatorFilters } from './modules/progress-indicator/progress-indicator-harness-filters';
2
- export { SkyProgressIndicatorHarness } from './modules/progress-indicator/progress-indicator-harness';
3
- export { SkyProgressIndicatorItemFilters } from './modules/progress-indicator/progress-indicator-item-harness-filters';
4
- export { SkyProgressIndicatorItemHarness } from './modules/progress-indicator/progress-indicator-item-harness';