@skyux/progress-indicator 7.4.2 → 7.6.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.
- package/documentation.json +405 -303
- package/esm2020/lib/modules/progress-indicator/progress-indicator-item/progress-indicator-item.component.mjs +29 -7
- package/esm2020/lib/modules/progress-indicator/progress-indicator-nav-button/progress-indicator-nav-button.component.mjs +4 -5
- package/esm2020/lib/modules/progress-indicator/progress-indicator-reset-button/progress-indicator-reset-button.component.mjs +2 -2
- package/esm2020/lib/modules/progress-indicator/progress-indicator.component.mjs +5 -5
- package/esm2020/lib/modules/progress-indicator/types/progress-indicator-change.mjs +1 -1
- package/esm2020/lib/modules/progress-indicator/types/progress-indicator-item-status.mjs +5 -5
- package/esm2020/lib/modules/progress-indicator/types/progress-indicator-message-type.mjs +6 -6
- package/esm2020/lib/modules/progress-indicator/types/progress-indicator-message.mjs +1 -1
- package/esm2020/lib/modules/progress-indicator/types/progress-indicator-mode.mjs +3 -3
- package/esm2020/lib/modules/progress-indicator/types/progress-indicator-nav-button-type.mjs +1 -1
- package/fesm2015/skyux-progress-indicator.mjs +47 -26
- package/fesm2015/skyux-progress-indicator.mjs.map +1 -1
- package/fesm2020/skyux-progress-indicator.mjs +47 -26
- package/fesm2020/skyux-progress-indicator.mjs.map +1 -1
- package/lib/modules/progress-indicator/progress-indicator-item/progress-indicator-item.component.d.ts +7 -4
- package/lib/modules/progress-indicator/progress-indicator-nav-button/progress-indicator-nav-button.component.d.ts +4 -5
- package/lib/modules/progress-indicator/progress-indicator-reset-button/progress-indicator-reset-button.component.d.ts +2 -2
- package/lib/modules/progress-indicator/progress-indicator.component.d.ts +4 -4
- package/lib/modules/progress-indicator/types/progress-indicator-change.d.ts +3 -3
- package/lib/modules/progress-indicator/types/progress-indicator-item-status.d.ts +4 -4
- package/lib/modules/progress-indicator/types/progress-indicator-message-type.d.ts +5 -5
- package/lib/modules/progress-indicator/types/progress-indicator-message.d.ts +1 -1
- package/lib/modules/progress-indicator/types/progress-indicator-mode.d.ts +2 -2
- package/lib/modules/progress-indicator/types/progress-indicator-nav-button-type.d.ts +1 -1
- package/package.json +5 -5
|
@@ -8,7 +8,7 @@ import * as i0 from "@angular/core";
|
|
|
8
8
|
export declare class SkyProgressIndicatorItemComponent implements OnInit {
|
|
9
9
|
#private;
|
|
10
10
|
/**
|
|
11
|
-
*
|
|
11
|
+
* The step label for the step in the progress indicator.
|
|
12
12
|
* @required
|
|
13
13
|
*/
|
|
14
14
|
set title(value: string | undefined);
|
|
@@ -16,9 +16,12 @@ export declare class SkyProgressIndicatorItemComponent implements OnInit {
|
|
|
16
16
|
set status(value: SkyProgressIndicatorItemStatus | undefined);
|
|
17
17
|
get status(): SkyProgressIndicatorItemStatus;
|
|
18
18
|
formattedTitle: string | undefined;
|
|
19
|
-
isVisible: boolean;
|
|
20
|
-
|
|
21
|
-
|
|
19
|
+
set isVisible(value: boolean | undefined);
|
|
20
|
+
get isVisible(): boolean;
|
|
21
|
+
set showStatusMarker(value: boolean | undefined);
|
|
22
|
+
get showStatusMarker(): boolean;
|
|
23
|
+
set showTitle(value: boolean | undefined);
|
|
24
|
+
get showTitle(): boolean;
|
|
22
25
|
statusName: string;
|
|
23
26
|
constructor(changeDetector: ChangeDetectorRef);
|
|
24
27
|
ngOnInit(): void;
|
|
@@ -11,25 +11,24 @@ import * as i0 from "@angular/core";
|
|
|
11
11
|
export declare class SkyProgressIndicatorNavButtonComponent implements AfterViewInit, OnDestroy {
|
|
12
12
|
#private;
|
|
13
13
|
/**
|
|
14
|
-
*
|
|
14
|
+
* The label to display on the nav button.
|
|
15
15
|
* @default "Next"
|
|
16
16
|
*/
|
|
17
17
|
buttonText: string | undefined;
|
|
18
18
|
/**
|
|
19
|
-
*
|
|
20
|
-
* The valid options are `"finish"`, `"next"`, `"previous"`, and `"reset"`.
|
|
19
|
+
* The type of nav button to include.
|
|
21
20
|
* @default "next"
|
|
22
21
|
*/
|
|
23
22
|
set buttonType(value: SkyProgressIndicatorNavButtonType | undefined);
|
|
24
23
|
get buttonType(): SkyProgressIndicatorNavButtonType;
|
|
25
24
|
/**
|
|
26
|
-
*
|
|
25
|
+
* Whether to disable the nav button.
|
|
27
26
|
* @default false
|
|
28
27
|
*/
|
|
29
28
|
set disabled(value: boolean | undefined);
|
|
30
29
|
get disabled(): boolean | undefined;
|
|
31
30
|
/**
|
|
32
|
-
*
|
|
31
|
+
* The progress indicator component to associate with the nav button.
|
|
33
32
|
* @required
|
|
34
33
|
*/
|
|
35
34
|
set progressIndicator(value: SkyProgressIndicatorComponent | undefined);
|
|
@@ -9,13 +9,13 @@ import * as i0 from "@angular/core";
|
|
|
9
9
|
export declare class SkyProgressIndicatorResetButtonComponent implements OnDestroy {
|
|
10
10
|
#private;
|
|
11
11
|
/**
|
|
12
|
-
*
|
|
12
|
+
* Whether to disable the reset button.
|
|
13
13
|
* @default false
|
|
14
14
|
*/
|
|
15
15
|
set disabled(value: boolean | undefined);
|
|
16
16
|
get disabled(): boolean | undefined;
|
|
17
17
|
/**
|
|
18
|
-
*
|
|
18
|
+
* The progress indicator component to associate with the reset button.
|
|
19
19
|
* @required
|
|
20
20
|
*/
|
|
21
21
|
progressIndicator: SkyProgressIndicatorComponent | undefined;
|
|
@@ -11,7 +11,7 @@ import * as i0 from "@angular/core";
|
|
|
11
11
|
export declare class SkyProgressIndicatorComponent implements OnInit, AfterContentInit, OnDestroy {
|
|
12
12
|
#private;
|
|
13
13
|
/**
|
|
14
|
-
*
|
|
14
|
+
* The orientation of the progress indicator, which can be vertical or horizontal.
|
|
15
15
|
* For [passive progress indicators](https://developer.blackbaud.com/skyux-progress-indicator/docs/passive-indicator)
|
|
16
16
|
* and [waterfall progress indicators](https://developer.blackbaud.com/skyux/components/progress-indicator/waterfall-progress-indicator),
|
|
17
17
|
* use the vertical display mode. For [modal wizards](https://developer.blackbaud.com/skyux/components/wizard),
|
|
@@ -24,20 +24,20 @@ export declare class SkyProgressIndicatorComponent implements OnInit, AfterConte
|
|
|
24
24
|
set displayMode(value: SkyProgressIndicatorDisplayModeType | undefined);
|
|
25
25
|
get displayMode(): SkyProgressIndicatorDisplayModeType;
|
|
26
26
|
/**
|
|
27
|
-
*
|
|
27
|
+
* Whether the progress indicator is passive. Passive progress indicators inform users of
|
|
28
28
|
* progress that concerns them but that they are not responsible for, and they must use the vertical display mode.
|
|
29
29
|
* @default false
|
|
30
30
|
*/
|
|
31
31
|
set isPassive(value: boolean | undefined);
|
|
32
32
|
get isPassive(): boolean | undefined;
|
|
33
33
|
/**
|
|
34
|
-
*
|
|
34
|
+
* The observable of `SkyProgressIndicatorMessage` that determines the status to
|
|
35
35
|
* display for items in the progress indicator. The message stream is a queue of
|
|
36
36
|
* commanding messages to change the state of the progress indicator based on the message type.
|
|
37
37
|
*/
|
|
38
38
|
set messageStream(value: Subject<SkyProgressIndicatorMessage | SkyProgressIndicatorMessageType> | undefined);
|
|
39
39
|
/**
|
|
40
|
-
*
|
|
40
|
+
* The index for the item to make active when the progress indicator
|
|
41
41
|
* loads. All steps that precede the active item are marked as complete, and all steps
|
|
42
42
|
* that follow the active item are marked as incomplete.
|
|
43
43
|
*/
|
|
@@ -1,15 +1,15 @@
|
|
|
1
1
|
import { SkyProgressIndicatorItemStatus } from './progress-indicator-item-status';
|
|
2
2
|
export interface SkyProgressIndicatorChange {
|
|
3
3
|
/**
|
|
4
|
-
*
|
|
4
|
+
* The active item.
|
|
5
5
|
*/
|
|
6
6
|
activeIndex?: number;
|
|
7
7
|
/**
|
|
8
|
-
*
|
|
8
|
+
* Whether the progress indicator is complete.
|
|
9
9
|
*/
|
|
10
10
|
isComplete?: boolean;
|
|
11
11
|
/**
|
|
12
|
-
*
|
|
12
|
+
* The array with the status of each item.
|
|
13
13
|
*/
|
|
14
14
|
itemStatuses?: SkyProgressIndicatorItemStatus[];
|
|
15
15
|
}
|
|
@@ -1,18 +1,18 @@
|
|
|
1
1
|
export declare enum SkyProgressIndicatorItemStatus {
|
|
2
2
|
/**
|
|
3
|
-
*
|
|
3
|
+
* The item is active.
|
|
4
4
|
*/
|
|
5
5
|
Active = 0,
|
|
6
6
|
/**
|
|
7
|
-
*
|
|
7
|
+
* The item is complete.
|
|
8
8
|
*/
|
|
9
9
|
Complete = 1,
|
|
10
10
|
/**
|
|
11
|
-
*
|
|
11
|
+
* The item is incomplete.
|
|
12
12
|
*/
|
|
13
13
|
Incomplete = 2,
|
|
14
14
|
/**
|
|
15
|
-
*
|
|
15
|
+
* The item is pending.
|
|
16
16
|
*/
|
|
17
17
|
Pending = 3
|
|
18
18
|
}
|
|
@@ -1,26 +1,26 @@
|
|
|
1
1
|
export declare enum SkyProgressIndicatorMessageType {
|
|
2
2
|
/**
|
|
3
|
-
*
|
|
3
|
+
* The current step is complete.
|
|
4
4
|
* This completes the active item and moves to the next item.
|
|
5
5
|
*/
|
|
6
6
|
Progress = 0,
|
|
7
7
|
/**
|
|
8
|
-
*
|
|
8
|
+
* Returns progress to the previous step.
|
|
9
9
|
* This moves from the active item to the item that precedes it.
|
|
10
10
|
*/
|
|
11
11
|
Regress = 1,
|
|
12
12
|
/**
|
|
13
|
-
*
|
|
13
|
+
* Progress is incomplete.
|
|
14
14
|
* This marks all items as incomplete and sets the first item as the active item.
|
|
15
15
|
*/
|
|
16
16
|
Reset = 2,
|
|
17
17
|
/**
|
|
18
|
-
*
|
|
18
|
+
* Progress is complete.
|
|
19
19
|
* This marks all items as complete and sets the last item as the active item.
|
|
20
20
|
*/
|
|
21
21
|
Finish = 3,
|
|
22
22
|
/**
|
|
23
|
-
*
|
|
23
|
+
* Moves progress to the item indicated by the `data.activeIndex` property.
|
|
24
24
|
*/
|
|
25
25
|
GoTo = 4
|
|
26
26
|
}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { SkyProgressIndicatorMessageType } from './progress-indicator-message-type';
|
|
2
2
|
export interface SkyProgressIndicatorMessage {
|
|
3
3
|
/**
|
|
4
|
-
*
|
|
4
|
+
* The type of state change for the progress indicator.
|
|
5
5
|
*/
|
|
6
6
|
type: SkyProgressIndicatorMessageType;
|
|
7
7
|
/**
|
|
@@ -4,11 +4,11 @@
|
|
|
4
4
|
*/
|
|
5
5
|
export declare enum SkyProgressIndicatorDisplayMode {
|
|
6
6
|
/**
|
|
7
|
-
*
|
|
7
|
+
* The vertical layout for the progress indicator.
|
|
8
8
|
*/
|
|
9
9
|
Vertical = 0,
|
|
10
10
|
/**
|
|
11
|
-
*
|
|
11
|
+
* The horizontal layout for the progress indicator.
|
|
12
12
|
*/
|
|
13
13
|
Horizontal = 1
|
|
14
14
|
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@skyux/progress-indicator",
|
|
3
|
-
"version": "7.
|
|
3
|
+
"version": "7.6.0",
|
|
4
4
|
"author": "Blackbaud, Inc.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"blackbaud",
|
|
@@ -34,10 +34,10 @@
|
|
|
34
34
|
"peerDependencies": {
|
|
35
35
|
"@angular/common": "^14.2.11",
|
|
36
36
|
"@angular/core": "^14.2.11",
|
|
37
|
-
"@skyux/core": "7.
|
|
38
|
-
"@skyux/i18n": "7.
|
|
39
|
-
"@skyux/indicators": "7.
|
|
40
|
-
"@skyux/theme": "7.
|
|
37
|
+
"@skyux/core": "7.6.0",
|
|
38
|
+
"@skyux/i18n": "7.6.0",
|
|
39
|
+
"@skyux/indicators": "7.6.0",
|
|
40
|
+
"@skyux/theme": "7.6.0"
|
|
41
41
|
},
|
|
42
42
|
"dependencies": {
|
|
43
43
|
"tslib": "^2.3.1"
|