@rossigee/clarity-angular 18.2.1-fixed.1 → 18.2.1
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/fesm2022/clr-angular-accordion.mjs +355 -0
- package/fesm2022/clr-angular-accordion.mjs.map +1 -0
- package/fesm2022/clr-angular-button.mjs +713 -0
- package/fesm2022/clr-angular-button.mjs.map +1 -0
- package/fesm2022/clr-angular-collapsible-panel.mjs +201 -0
- package/fesm2022/clr-angular-collapsible-panel.mjs.map +1 -0
- package/fesm2022/clr-angular-data-datagrid.mjs +7635 -0
- package/fesm2022/clr-angular-data-datagrid.mjs.map +1 -0
- package/fesm2022/clr-angular-data-stack-view.mjs +442 -0
- package/fesm2022/clr-angular-data-stack-view.mjs.map +1 -0
- package/fesm2022/clr-angular-data-tree-view.mjs +1106 -0
- package/fesm2022/clr-angular-data-tree-view.mjs.map +1 -0
- package/fesm2022/clr-angular-data.mjs +40 -0
- package/fesm2022/clr-angular-data.mjs.map +1 -0
- package/fesm2022/clr-angular-emphasis-alert.mjs +624 -0
- package/fesm2022/clr-angular-emphasis-alert.mjs.map +1 -0
- package/fesm2022/clr-angular-emphasis-badge.mjs +69 -0
- package/fesm2022/clr-angular-emphasis-badge.mjs.map +1 -0
- package/fesm2022/clr-angular-emphasis-common.mjs +25 -0
- package/fesm2022/clr-angular-emphasis-common.mjs.map +1 -0
- package/fesm2022/clr-angular-emphasis-label.mjs +105 -0
- package/fesm2022/clr-angular-emphasis-label.mjs.map +1 -0
- package/fesm2022/clr-angular-emphasis.mjs +41 -0
- package/fesm2022/clr-angular-emphasis.mjs.map +1 -0
- package/fesm2022/clr-angular-forms-checkbox.mjs +270 -0
- package/fesm2022/clr-angular-forms-checkbox.mjs.map +1 -0
- package/fesm2022/clr-angular-forms-combobox.mjs +1775 -0
- package/fesm2022/clr-angular-forms-combobox.mjs.map +1 -0
- package/fesm2022/clr-angular-forms-common.mjs +1251 -0
- package/fesm2022/clr-angular-forms-common.mjs.map +1 -0
- package/fesm2022/clr-angular-forms-datalist.mjs +263 -0
- package/fesm2022/clr-angular-forms-datalist.mjs.map +1 -0
- package/fesm2022/clr-angular-forms-datepicker.mjs +3274 -0
- package/fesm2022/clr-angular-forms-datepicker.mjs.map +1 -0
- package/fesm2022/clr-angular-forms-file-input.mjs +826 -0
- package/fesm2022/clr-angular-forms-file-input.mjs.map +1 -0
- package/fesm2022/clr-angular-forms-input.mjs +153 -0
- package/fesm2022/clr-angular-forms-input.mjs.map +1 -0
- package/fesm2022/clr-angular-forms-number-input.mjs +236 -0
- package/fesm2022/clr-angular-forms-number-input.mjs.map +1 -0
- package/fesm2022/clr-angular-forms-password.mjs +233 -0
- package/fesm2022/clr-angular-forms-password.mjs.map +1 -0
- package/fesm2022/clr-angular-forms-radio.mjs +231 -0
- package/fesm2022/clr-angular-forms-radio.mjs.map +1 -0
- package/fesm2022/clr-angular-forms-range.mjs +186 -0
- package/fesm2022/clr-angular-forms-range.mjs.map +1 -0
- package/fesm2022/clr-angular-forms-select.mjs +153 -0
- package/fesm2022/clr-angular-forms-select.mjs.map +1 -0
- package/fesm2022/clr-angular-forms-textarea.mjs +136 -0
- package/fesm2022/clr-angular-forms-textarea.mjs.map +1 -0
- package/fesm2022/clr-angular-forms.mjs +100 -0
- package/fesm2022/clr-angular-forms.mjs.map +1 -0
- package/fesm2022/clr-angular-icon.mjs +7397 -0
- package/fesm2022/clr-angular-icon.mjs.map +1 -0
- package/fesm2022/clr-angular-layout-breadcrumbs.mjs +120 -0
- package/fesm2022/clr-angular-layout-breadcrumbs.mjs.map +1 -0
- package/fesm2022/clr-angular-layout-main-container.mjs +100 -0
- package/fesm2022/clr-angular-layout-main-container.mjs.map +1 -0
- package/fesm2022/clr-angular-layout-nav.mjs +582 -0
- package/fesm2022/clr-angular-layout-nav.mjs.map +1 -0
- package/fesm2022/clr-angular-layout-tabs.mjs +807 -0
- package/fesm2022/clr-angular-layout-tabs.mjs.map +1 -0
- package/fesm2022/clr-angular-layout-vertical-nav.mjs +507 -0
- package/fesm2022/clr-angular-layout-vertical-nav.mjs.map +1 -0
- package/fesm2022/clr-angular-layout.mjs +44 -0
- package/fesm2022/clr-angular-layout.mjs.map +1 -0
- package/fesm2022/clr-angular-modal.mjs +617 -0
- package/fesm2022/clr-angular-modal.mjs.map +1 -0
- package/fesm2022/clr-angular-popover-common.mjs +1082 -0
- package/fesm2022/clr-angular-popover-common.mjs.map +1 -0
- package/fesm2022/clr-angular-popover-dropdown.mjs +492 -0
- package/fesm2022/clr-angular-popover-dropdown.mjs.map +1 -0
- package/fesm2022/clr-angular-popover-signpost.mjs +494 -0
- package/fesm2022/clr-angular-popover-signpost.mjs.map +1 -0
- package/fesm2022/clr-angular-popover-tooltip.mjs +293 -0
- package/fesm2022/clr-angular-popover-tooltip.mjs.map +1 -0
- package/fesm2022/clr-angular-popover.mjs +41 -0
- package/fesm2022/clr-angular-popover.mjs.map +1 -0
- package/fesm2022/clr-angular-progress-progress-bars.mjs +217 -0
- package/fesm2022/clr-angular-progress-progress-bars.mjs.map +1 -0
- package/fesm2022/clr-angular-progress-spinner.mjs +132 -0
- package/fesm2022/clr-angular-progress-spinner.mjs.map +1 -0
- package/fesm2022/clr-angular-stepper.mjs +694 -0
- package/fesm2022/clr-angular-stepper.mjs.map +1 -0
- package/fesm2022/clr-angular-timeline.mjs +316 -0
- package/fesm2022/clr-angular-timeline.mjs.map +1 -0
- package/fesm2022/clr-angular-utils-conditional.mjs +351 -0
- package/fesm2022/clr-angular-utils-conditional.mjs.map +1 -0
- package/fesm2022/clr-angular-utils-loading.mjs +107 -0
- package/fesm2022/clr-angular-utils-loading.mjs.map +1 -0
- package/fesm2022/clr-angular-utils.mjs +2079 -0
- package/fesm2022/clr-angular-utils.mjs.map +1 -0
- package/fesm2022/clr-angular-wizard.mjs +3074 -0
- package/fesm2022/clr-angular-wizard.mjs.map +1 -0
- package/fesm2022/clr-angular.mjs +2 -2
- package/fesm2022/clr-angular.mjs.map +1 -1
- package/package.json +7 -5
- package/schematics/ng-update/index.d.ts +2 -0
- package/schematics/ng-update/index.js +69 -0
- package/schematics/ng-update/index.js.map +1 -0
- package/schematics/ng-update/migrations/css-migration.d.ts +6 -0
- package/schematics/ng-update/migrations/css-migration.js +177 -0
- package/schematics/ng-update/migrations/css-migration.js.map +1 -0
- package/schematics/ng-update/migrations/import-migration.d.ts +4 -0
- package/schematics/ng-update/migrations/import-migration.js +187 -0
- package/schematics/ng-update/migrations/import-migration.js.map +1 -0
- package/schematics/ng-update/migrations/template-migration.d.ts +6 -0
- package/schematics/ng-update/migrations/template-migration.js +261 -0
- package/schematics/ng-update/migrations/template-migration.js.map +1 -0
- package/schematics/ng-update/replacements/css-replacements.d.ts +17 -0
- package/schematics/ng-update/replacements/css-replacements.js +74 -0
- package/schematics/ng-update/replacements/css-replacements.js.map +1 -0
- package/schematics/ng-update/replacements/import-replacements.d.ts +13 -0
- package/schematics/ng-update/replacements/import-replacements.js +108 -0
- package/schematics/ng-update/replacements/import-replacements.js.map +1 -0
- package/schematics/ng-update/replacements/symbol-replacements.d.ts +12 -0
- package/schematics/ng-update/replacements/symbol-replacements.js +67 -0
- package/schematics/ng-update/replacements/symbol-replacements.js.map +1 -0
- package/schematics/ng-update/replacements/template-replacements.d.ts +19 -0
- package/schematics/ng-update/replacements/template-replacements.js +57 -0
- package/schematics/ng-update/replacements/template-replacements.js.map +1 -0
- package/schematics/ng-update/tests/test-helpers.d.ts +6 -0
- package/schematics/ng-update/tests/test-helpers.js +34 -0
- package/schematics/ng-update/tests/test-helpers.js.map +1 -0
- package/schematics/ng-update/utils/file-visitor.d.ts +8 -0
- package/schematics/ng-update/utils/file-visitor.js +44 -0
- package/schematics/ng-update/utils/file-visitor.js.map +1 -0
- package/schematics/ng-update/utils/regexp-utils.d.ts +16 -0
- package/schematics/ng-update/utils/regexp-utils.js +34 -0
- package/schematics/ng-update/utils/regexp-utils.js.map +1 -0
- package/schematics/vitest.config.d.ts +2 -0
- package/schematics/vitest.config.js +17 -0
- package/schematics/vitest.config.js.map +1 -0
- package/types/clr-angular-accordion.d.ts +100 -0
- package/types/clr-angular-button.d.ts +169 -0
- package/types/clr-angular-collapsible-panel.d.ts +73 -0
- package/types/clr-angular-data-datagrid.d.ts +1843 -0
- package/types/clr-angular-data-stack-view.d.ts +87 -0
- package/types/clr-angular-data-tree-view.d.ts +229 -0
- package/types/clr-angular-data.d.ts +15 -0
- package/types/clr-angular-emphasis-alert.d.ts +175 -0
- package/types/clr-angular-emphasis-badge.d.ts +25 -0
- package/types/clr-angular-emphasis-common.d.ts +6 -0
- package/types/clr-angular-emphasis-label.d.ts +29 -0
- package/types/clr-angular-emphasis.d.ts +15 -0
- package/types/clr-angular-forms-checkbox.d.ts +69 -0
- package/types/clr-angular-forms-combobox.d.ts +353 -0
- package/types/clr-angular-forms-common.d.ts +339 -0
- package/types/clr-angular-forms-datalist.d.ts +59 -0
- package/types/clr-angular-forms-datepicker.d.ts +986 -0
- package/types/clr-angular-forms-file-input.d.ts +193 -0
- package/types/clr-angular-forms-input.d.ts +29 -0
- package/types/clr-angular-forms-number-input.d.ts +43 -0
- package/types/clr-angular-forms-password.d.ts +52 -0
- package/types/clr-angular-forms-radio.d.ts +50 -0
- package/types/clr-angular-forms-range.d.ts +37 -0
- package/types/clr-angular-forms-select.d.ts +36 -0
- package/types/clr-angular-forms-textarea.d.ts +29 -0
- package/types/clr-angular-forms.d.ts +36 -0
- package/types/clr-angular-icon.d.ts +1498 -0
- package/types/clr-angular-layout-breadcrumbs.d.ts +45 -0
- package/types/clr-angular-layout-main-container.d.ts +28 -0
- package/types/clr-angular-layout-nav.d.ts +142 -0
- package/types/clr-angular-layout-tabs.d.ts +158 -0
- package/types/clr-angular-layout-vertical-nav.d.ts +128 -0
- package/types/clr-angular-layout.d.ts +19 -0
- package/types/clr-angular-modal.d.ts +160 -0
- package/types/clr-angular-popover-common.d.ts +254 -0
- package/types/clr-angular-popover-dropdown.d.ts +123 -0
- package/types/clr-angular-popover-signpost.d.ts +157 -0
- package/types/clr-angular-popover-tooltip.d.ts +83 -0
- package/types/clr-angular-popover.d.ts +16 -0
- package/types/clr-angular-progress-progress-bars.d.ts +57 -0
- package/types/clr-angular-progress-spinner.d.ts +44 -0
- package/types/clr-angular-stepper.d.ts +179 -0
- package/types/clr-angular-timeline.d.ts +86 -0
- package/types/clr-angular-utils-conditional.d.ts +132 -0
- package/types/clr-angular-utils-loading.d.ts +38 -0
- package/types/clr-angular-utils.d.ts +913 -0
- package/types/clr-angular-wizard.d.ts +1508 -0
|
@@ -0,0 +1,1508 @@
|
|
|
1
|
+
import * as i0 from '@angular/core';
|
|
2
|
+
import { EventEmitter, QueryList, TemplateRef, OnInit, OnDestroy, AfterContentInit, DoCheck, ElementRef, IterableDiffers, AfterViewInit } from '@angular/core';
|
|
3
|
+
import { HeadingLevel, ClrCommonStringsService } from '@clr/angular/utils';
|
|
4
|
+
import { Observable, Subscription } from 'rxjs';
|
|
5
|
+
import * as i12 from '@angular/common';
|
|
6
|
+
import * as i13 from '@clr/angular/icon';
|
|
7
|
+
import * as i14 from '@clr/angular/modal';
|
|
8
|
+
import * as i15 from '@clr/angular/emphasis/alert';
|
|
9
|
+
|
|
10
|
+
declare enum ClrWizardFooterAlign {
|
|
11
|
+
START = "start",
|
|
12
|
+
END = "end"
|
|
13
|
+
}
|
|
14
|
+
declare function footerAlignAttribute(value: ClrWizardFooterAlign | string): ClrWizardFooterAlign;
|
|
15
|
+
|
|
16
|
+
declare enum ClrWizardStepnavLayout {
|
|
17
|
+
VERTICAL = "vertical",
|
|
18
|
+
HORIZONTAL = "horizontal"
|
|
19
|
+
}
|
|
20
|
+
declare function stepnavLayoutAttribute(value: ClrWizardStepnavLayout | string): ClrWizardStepnavLayout;
|
|
21
|
+
|
|
22
|
+
declare class ButtonHubService {
|
|
23
|
+
buttonsReady: boolean;
|
|
24
|
+
private _previousBtnClicked;
|
|
25
|
+
private _nextBtnClicked;
|
|
26
|
+
private _dangerBtnClicked;
|
|
27
|
+
private _cancelBtnClicked;
|
|
28
|
+
private _finishBtnClicked;
|
|
29
|
+
private _customBtnClicked;
|
|
30
|
+
get previousBtnClicked(): Observable<void>;
|
|
31
|
+
get nextBtnClicked(): Observable<void>;
|
|
32
|
+
get dangerBtnClicked(): Observable<void>;
|
|
33
|
+
get cancelBtnClicked(): Observable<void>;
|
|
34
|
+
get finishBtnClicked(): Observable<void>;
|
|
35
|
+
get customBtnClicked(): Observable<string>;
|
|
36
|
+
buttonClicked(buttonType: string): void;
|
|
37
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<ButtonHubService, never>;
|
|
38
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<ButtonHubService>;
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
declare class ClrWizardHeaderAction {
|
|
42
|
+
title: string;
|
|
43
|
+
_id: string;
|
|
44
|
+
disabled: boolean;
|
|
45
|
+
headerActionClicked: EventEmitter<string>;
|
|
46
|
+
get id(): string;
|
|
47
|
+
click(): void;
|
|
48
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<ClrWizardHeaderAction, never>;
|
|
49
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<ClrWizardHeaderAction, "clr-wizard-header-action", never, { "title": { "alias": "title"; "required": false; }; "_id": { "alias": "id"; "required": false; }; "disabled": { "alias": "clrWizardHeaderActionDisabled"; "required": false; }; }, { "headerActionClicked": "actionClicked"; }, never, ["*"], false, never>;
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
/**
|
|
53
|
+
* PageCollectionService manages the collection of pages assigned to the wizard and offers
|
|
54
|
+
* a number of functions useful across the wizards providers and subcomponents -- all related
|
|
55
|
+
* to essentially lookups on the collection of pages.
|
|
56
|
+
*
|
|
57
|
+
* The easiest way to access PageCollectionService is via the wizard. The
|
|
58
|
+
* following example would allow you to access your instance of the wizard from your host
|
|
59
|
+
* component and thereby access the page collection via YourHostComponent.wizard.pageCollection.
|
|
60
|
+
*
|
|
61
|
+
* @example
|
|
62
|
+
* <clr-wizard #wizard ...>
|
|
63
|
+
*
|
|
64
|
+
* @example
|
|
65
|
+
* export class YourHostComponent {
|
|
66
|
+
* @ViewChild("wizard") wizard: Wizard;
|
|
67
|
+
* ...
|
|
68
|
+
* }
|
|
69
|
+
*
|
|
70
|
+
* The heart of the page collection is the query list of pages, which it is assigned as a
|
|
71
|
+
* reference to the Wizard.pages QueryList when the wizard is created.
|
|
72
|
+
*
|
|
73
|
+
*/
|
|
74
|
+
declare class PageCollectionService {
|
|
75
|
+
/**
|
|
76
|
+
* A reference to the Wizard.pages QueryList.
|
|
77
|
+
*
|
|
78
|
+
* Populated when the wizard is created.
|
|
79
|
+
*
|
|
80
|
+
* @memberof PageCollectionService
|
|
81
|
+
*/
|
|
82
|
+
pages: QueryList<ClrWizardPage>;
|
|
83
|
+
/**
|
|
84
|
+
*
|
|
85
|
+
* @memberof PageCollectionService
|
|
86
|
+
*/
|
|
87
|
+
private _pagesReset;
|
|
88
|
+
/**
|
|
89
|
+
* Converts the PageCollectionService.pages QueryList to an array and returns it.
|
|
90
|
+
*
|
|
91
|
+
* Useful for many instances when you would prefer a QueryList to act like an array.
|
|
92
|
+
*
|
|
93
|
+
* @memberof PageCollectionService
|
|
94
|
+
*/
|
|
95
|
+
get pagesAsArray(): ClrWizardPage[];
|
|
96
|
+
/**
|
|
97
|
+
* Returns the length of the pages query list.
|
|
98
|
+
*
|
|
99
|
+
* @memberof PageCollectionService
|
|
100
|
+
*/
|
|
101
|
+
get pagesCount(): number;
|
|
102
|
+
/**
|
|
103
|
+
* Returns the next-to-last page in the query list of pages. Operates as a getter
|
|
104
|
+
* so that it isn't working with stale data.
|
|
105
|
+
*
|
|
106
|
+
* @memberof PageCollectionService
|
|
107
|
+
*/
|
|
108
|
+
get penultimatePage(): ClrWizardPage;
|
|
109
|
+
/**
|
|
110
|
+
* Returns the last page in the query list of pages. Operates as a getter
|
|
111
|
+
* so that it isn't working with stale data.
|
|
112
|
+
*
|
|
113
|
+
* @memberof PageCollectionService
|
|
114
|
+
*/
|
|
115
|
+
get lastPage(): ClrWizardPage;
|
|
116
|
+
/**
|
|
117
|
+
* Returns the first page in the query list of pages. Operates as a getter
|
|
118
|
+
* so that it isn't working with stale data.
|
|
119
|
+
*
|
|
120
|
+
* @memberof PageCollectionService
|
|
121
|
+
*/
|
|
122
|
+
get firstPage(): ClrWizardPage;
|
|
123
|
+
/**
|
|
124
|
+
* An observable that the navigation service listens to in order to know when
|
|
125
|
+
* the page collection completed states have been reset to false so that way it
|
|
126
|
+
* can also reset the navigation to make the first page in the page collection
|
|
127
|
+
* current/active.
|
|
128
|
+
*
|
|
129
|
+
* @memberof PageCollectionService
|
|
130
|
+
*/
|
|
131
|
+
get pagesReset(): Observable<boolean>;
|
|
132
|
+
/**
|
|
133
|
+
* Used mostly internally, but accepts a string ID and returns a ClrWizardPage
|
|
134
|
+
* object that matches the ID passed. Note that IDs here should include the prefix
|
|
135
|
+
* "clr-wizard-page-".
|
|
136
|
+
*
|
|
137
|
+
* Returns the next-to-last page in the query list of pages. Operates as a getter
|
|
138
|
+
* so that it isn't working with stale data.
|
|
139
|
+
*
|
|
140
|
+
* @memberof PageCollectionService
|
|
141
|
+
*/
|
|
142
|
+
getPageById(id: string): ClrWizardPage;
|
|
143
|
+
/**
|
|
144
|
+
* Accepts s number as a parameter and treats that number as the index of the page
|
|
145
|
+
* you're looking for in the collection of pages. Returns a wizard page object.
|
|
146
|
+
*
|
|
147
|
+
* @memberof PageCollectionService
|
|
148
|
+
*/
|
|
149
|
+
getPageByIndex(index: number): ClrWizardPage;
|
|
150
|
+
/**
|
|
151
|
+
* Takes a wizard page object as a parameter and returns its index in the
|
|
152
|
+
* collection of pages.
|
|
153
|
+
*
|
|
154
|
+
* @memberof PageCollectionService
|
|
155
|
+
*/
|
|
156
|
+
getPageIndex(page: ClrWizardPage): number;
|
|
157
|
+
/**
|
|
158
|
+
* Accepts two numeric indexes and returns an array of wizard page objects that include
|
|
159
|
+
* all wizard pages in the page collection from the first index to the second.
|
|
160
|
+
*
|
|
161
|
+
* @memberof PageCollectionService
|
|
162
|
+
*/
|
|
163
|
+
pageRange(start: number, end: number): ClrWizardPage[];
|
|
164
|
+
/**
|
|
165
|
+
* Accepts two wizard page objects and returns those page objects with all other page
|
|
166
|
+
* objects between them in the page collection. It doesn't care which page is ahead of the
|
|
167
|
+
* other in the parameters. It will be smart enough to figure that out on its own.
|
|
168
|
+
*
|
|
169
|
+
* @memberof PageCollectionService
|
|
170
|
+
*/
|
|
171
|
+
getPageRangeFromPages(page: ClrWizardPage, otherPage: ClrWizardPage): ClrWizardPage[];
|
|
172
|
+
/**
|
|
173
|
+
* Takes a wizard page object as a parameter and returns the wizard page object of
|
|
174
|
+
* the page immediately before it in the page collection. Returns null if there is
|
|
175
|
+
* no page before the page it is passed.
|
|
176
|
+
*
|
|
177
|
+
* @memberof PageCollectionService
|
|
178
|
+
*/
|
|
179
|
+
getPreviousPage(page: ClrWizardPage): ClrWizardPage;
|
|
180
|
+
/**
|
|
181
|
+
* Accepts a wizard page object as a parameter and returns a Boolean that says if
|
|
182
|
+
* the page you sent it is complete.
|
|
183
|
+
*
|
|
184
|
+
* @memberof PageCollectionService
|
|
185
|
+
*/
|
|
186
|
+
previousPageIsCompleted(page: ClrWizardPage): boolean;
|
|
187
|
+
/**
|
|
188
|
+
* Takes a wizard page object as a parameter and returns the wizard page object of
|
|
189
|
+
* the page immediately after it in the page collection. Returns null if there is
|
|
190
|
+
* no page after the page it is passed.
|
|
191
|
+
*
|
|
192
|
+
* @memberof PageCollectionService
|
|
193
|
+
*/
|
|
194
|
+
getNextPage(page: ClrWizardPage): ClrWizardPage;
|
|
195
|
+
/**
|
|
196
|
+
* Takes a wizard page object as a parameter and generates a step item id from the
|
|
197
|
+
* page ID. Returns the generated step item ID as a string.
|
|
198
|
+
*
|
|
199
|
+
* @memberof PageCollectionService
|
|
200
|
+
*/
|
|
201
|
+
getStepItemIdForPage(page: ClrWizardPage): string;
|
|
202
|
+
/**
|
|
203
|
+
* Generally only used internally to mark that a specific page has been "committed".
|
|
204
|
+
* This involves marking the page complete and firing the ClrWizardPage.onCommit
|
|
205
|
+
* (clrWizardPageOnCommit) output. Takes the wizard page object that you intend to
|
|
206
|
+
* mark completed as a parameter.
|
|
207
|
+
*
|
|
208
|
+
* @memberof PageCollectionService
|
|
209
|
+
*/
|
|
210
|
+
commitPage(page: ClrWizardPage): void;
|
|
211
|
+
/**
|
|
212
|
+
* Sets all completed states of the pages in the page collection to false and
|
|
213
|
+
* notifies the navigation service to likewise reset the navigation.
|
|
214
|
+
*
|
|
215
|
+
* @memberof PageCollectionService
|
|
216
|
+
*/
|
|
217
|
+
reset(): void;
|
|
218
|
+
/**
|
|
219
|
+
* Rolls through all the pages in the page collection to make sure there are no
|
|
220
|
+
* incomplete pages sandwiched between completed pages in the workflow. Identifies
|
|
221
|
+
* the first incomplete page index and sets all pages behind it to a completed
|
|
222
|
+
* state of false.
|
|
223
|
+
*
|
|
224
|
+
* @memberof PageCollectionService
|
|
225
|
+
*/
|
|
226
|
+
updateCompletedStates(): void;
|
|
227
|
+
/**
|
|
228
|
+
* Retrieves the index of the first incomplete page in the page collection.
|
|
229
|
+
*
|
|
230
|
+
* @memberof PageCollectionService
|
|
231
|
+
*/
|
|
232
|
+
findFirstIncompletePageIndex(): number;
|
|
233
|
+
findFirstIncompletePage(): ClrWizardPage;
|
|
234
|
+
/**
|
|
235
|
+
* Consolidates guard logic that prevents a couple of unfortunate edge cases with
|
|
236
|
+
* look ups on the collection of pages.
|
|
237
|
+
*
|
|
238
|
+
* @memberof PageCollectionService
|
|
239
|
+
*/
|
|
240
|
+
private checkResults;
|
|
241
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<PageCollectionService, never>;
|
|
242
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<PageCollectionService>;
|
|
243
|
+
}
|
|
244
|
+
|
|
245
|
+
declare class ClrWizardPageButtons {
|
|
246
|
+
pageButtonsTemplateRef: TemplateRef<any>;
|
|
247
|
+
constructor(pageButtonsTemplateRef: TemplateRef<any>);
|
|
248
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<ClrWizardPageButtons, never>;
|
|
249
|
+
static ɵdir: i0.ɵɵDirectiveDeclaration<ClrWizardPageButtons, "[clrPageButtons]", never, {}, {}, never, never, false, never>;
|
|
250
|
+
}
|
|
251
|
+
|
|
252
|
+
declare class ClrWizardPageHeaderActions {
|
|
253
|
+
pageHeaderActionsTemplateRef: TemplateRef<any>;
|
|
254
|
+
constructor(pageHeaderActionsTemplateRef: TemplateRef<any>);
|
|
255
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<ClrWizardPageHeaderActions, never>;
|
|
256
|
+
static ɵdir: i0.ɵɵDirectiveDeclaration<ClrWizardPageHeaderActions, "[clrPageHeaderActions]", never, {}, {}, never, never, false, never>;
|
|
257
|
+
}
|
|
258
|
+
|
|
259
|
+
declare class ClrWizardPageNavTitle {
|
|
260
|
+
pageNavTitleTemplateRef: TemplateRef<any>;
|
|
261
|
+
constructor(pageNavTitleTemplateRef: TemplateRef<any>);
|
|
262
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<ClrWizardPageNavTitle, never>;
|
|
263
|
+
static ɵdir: i0.ɵɵDirectiveDeclaration<ClrWizardPageNavTitle, "[clrPageNavTitle]", never, {}, {}, never, never, false, never>;
|
|
264
|
+
}
|
|
265
|
+
|
|
266
|
+
declare class ClrWizardPageTitle {
|
|
267
|
+
pageTitleTemplateRef: TemplateRef<any>;
|
|
268
|
+
headingLevel: HeadingLevel;
|
|
269
|
+
constructor(pageTitleTemplateRef: TemplateRef<any>);
|
|
270
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<ClrWizardPageTitle, never>;
|
|
271
|
+
static ɵdir: i0.ɵɵDirectiveDeclaration<ClrWizardPageTitle, "[clrPageTitle]", never, { "headingLevel": { "alias": "clrHeadingLevel"; "required": false; }; }, {}, never, never, false, never>;
|
|
272
|
+
}
|
|
273
|
+
|
|
274
|
+
/**
|
|
275
|
+
* The ClrWizardPage component is responsible for displaying the content of each step
|
|
276
|
+
* in the wizard workflow.
|
|
277
|
+
*
|
|
278
|
+
* ClrWizardPage component has hooks into the navigation service (ClrWizardPage.navService),
|
|
279
|
+
* page collection (ClrWizardPage.pageCollection), and button service
|
|
280
|
+
* (ClrWizardPage.buttonService). These three providers are shared across the components
|
|
281
|
+
* within each instance of a Wizard.
|
|
282
|
+
*
|
|
283
|
+
*/
|
|
284
|
+
declare class ClrWizardPage implements OnInit {
|
|
285
|
+
private navService;
|
|
286
|
+
pageCollection: PageCollectionService;
|
|
287
|
+
buttonService: ButtonHubService;
|
|
288
|
+
/**
|
|
289
|
+
* An input value that is used internally to generate the ClrWizardPage ID as
|
|
290
|
+
* well as the step nav item ID.
|
|
291
|
+
*
|
|
292
|
+
* Typed as any because it should be able to accept numbers as well as
|
|
293
|
+
* strings. Passing an index for wizard whose pages are created with an
|
|
294
|
+
* ngFor loop is a common use case.
|
|
295
|
+
*
|
|
296
|
+
* @memberof WizardPage
|
|
297
|
+
*
|
|
298
|
+
*/
|
|
299
|
+
_id: any;
|
|
300
|
+
/**
|
|
301
|
+
* Overrides all actions from the page level, so you can use an alternate function for
|
|
302
|
+
* validation or data-munging with a ClrWizardPage.onCommit (clrWizardPageOnCommit output),
|
|
303
|
+
* ClrWizardPage.onCancel (clrWizardPageOnCancel output), or one
|
|
304
|
+
* of the granular page-level button click event emitters.
|
|
305
|
+
*
|
|
306
|
+
* @memberof WizardPage
|
|
307
|
+
*
|
|
308
|
+
*/
|
|
309
|
+
preventDefault: boolean | string;
|
|
310
|
+
/**
|
|
311
|
+
* Emits when the value of ClrWizardPage.nextStepDisabled changes.
|
|
312
|
+
* Should emit the new value of nextStepDisabled.
|
|
313
|
+
*
|
|
314
|
+
* @memberof WizardPage
|
|
315
|
+
*
|
|
316
|
+
*/
|
|
317
|
+
nextStepDisabledChange: EventEmitter<boolean>;
|
|
318
|
+
/**
|
|
319
|
+
* Emits when the value of ClrWizardPage.previousStepDisabled changes.
|
|
320
|
+
* Should emit the new value of previousStepDisabled.
|
|
321
|
+
*
|
|
322
|
+
* @memberof WizardPage
|
|
323
|
+
*
|
|
324
|
+
*/
|
|
325
|
+
previousStepDisabledChange: EventEmitter<boolean>;
|
|
326
|
+
/**
|
|
327
|
+
*
|
|
328
|
+
* @memberof WizardPage
|
|
329
|
+
*
|
|
330
|
+
*/
|
|
331
|
+
stopCancelChange: EventEmitter<boolean>;
|
|
332
|
+
/**
|
|
333
|
+
* An event emitter carried over from a legacy version of ClrWizardPage.
|
|
334
|
+
* Fires an event on ClrWizardPage whenever the next or finish buttons
|
|
335
|
+
* are clicked and the page is the current page of the Wizard.
|
|
336
|
+
*
|
|
337
|
+
* Note that this does not automatically emit an event when a custom
|
|
338
|
+
* button is used in place of a next or finish button.
|
|
339
|
+
*
|
|
340
|
+
* @memberof WizardPage
|
|
341
|
+
*
|
|
342
|
+
*/
|
|
343
|
+
onCommit: EventEmitter<string>;
|
|
344
|
+
/**
|
|
345
|
+
* Emits an event when ClrWizardPage becomes the current page of the
|
|
346
|
+
* Wizard.
|
|
347
|
+
*
|
|
348
|
+
* @memberof WizardPage
|
|
349
|
+
*
|
|
350
|
+
*/
|
|
351
|
+
onLoad: EventEmitter<string>;
|
|
352
|
+
/**
|
|
353
|
+
* Emits an event when the ClrWizardPage invokes the cancel routine for the wizard.
|
|
354
|
+
*
|
|
355
|
+
* Can be used in conjunction with the ClrWizardPage.stopCancel
|
|
356
|
+
* (clrWizardPagePreventDefaultCancel) or ClrWizardPage.preventDefault
|
|
357
|
+
* (clrWizardPagePagePreventDefault) inputs to implement custom cancel
|
|
358
|
+
* functionality at the page level. This is useful if you would like to do
|
|
359
|
+
* validation, save data, or warn users before cancelling the wizard.
|
|
360
|
+
*
|
|
361
|
+
* Note that this requires you to call Wizard.close() from the host component.
|
|
362
|
+
* This constitues a full replacement of the cancel functionality.
|
|
363
|
+
*
|
|
364
|
+
* @memberof WizardPage
|
|
365
|
+
*
|
|
366
|
+
*/
|
|
367
|
+
pageOnCancel: EventEmitter<ClrWizardPage>;
|
|
368
|
+
/**
|
|
369
|
+
* Emits an event when the finish button is clicked and the ClrWizardPage is
|
|
370
|
+
* the wizard's current page.
|
|
371
|
+
*
|
|
372
|
+
* Can be used in conjunction with the ClrWizardPage.preventDefault
|
|
373
|
+
* (clrWizardPagePagePreventDefault) input to implement custom finish
|
|
374
|
+
* functionality at the page level. This is useful if you would like to do
|
|
375
|
+
* validation, save data, or warn users before allowing them to complete
|
|
376
|
+
* the wizard.
|
|
377
|
+
*
|
|
378
|
+
* Note that this requires you to call Wizard.finish() or Wizard.forceFinish()
|
|
379
|
+
* from the host component. This combination creates a full replacement of
|
|
380
|
+
* the finish functionality.
|
|
381
|
+
*
|
|
382
|
+
* @memberof WizardPage
|
|
383
|
+
*
|
|
384
|
+
*/
|
|
385
|
+
finishButtonClicked: EventEmitter<ClrWizardPage>;
|
|
386
|
+
/**
|
|
387
|
+
* Emits an event when the previous button is clicked and the ClrWizardPage is
|
|
388
|
+
* the wizard's current page.
|
|
389
|
+
*
|
|
390
|
+
* Can be used in conjunction with the ClrWizardPage.preventDefault
|
|
391
|
+
* (clrWizardPagePagePreventDefault) input to implement custom backwards
|
|
392
|
+
* navigation at the page level. This is useful if you would like to do
|
|
393
|
+
* validation, save data, or warn users before allowing them to go
|
|
394
|
+
* backwards in the wizard.
|
|
395
|
+
*
|
|
396
|
+
* Note that this requires you to call Wizard.previous()
|
|
397
|
+
* from the host component. This combination creates a full replacement of
|
|
398
|
+
* the backwards navigation functionality.
|
|
399
|
+
*
|
|
400
|
+
* @memberof WizardPage
|
|
401
|
+
*
|
|
402
|
+
*/
|
|
403
|
+
previousButtonClicked: EventEmitter<ClrWizardPage>;
|
|
404
|
+
/**
|
|
405
|
+
* Emits an event when the next button is clicked and the ClrWizardPage is
|
|
406
|
+
* the wizard's current page.
|
|
407
|
+
*
|
|
408
|
+
* Can be used in conjunction with the ClrWizardPage.preventDefault
|
|
409
|
+
* (clrWizardPagePagePreventDefault) input to implement custom forwards
|
|
410
|
+
* navigation at the page level. This is useful if you would like to do
|
|
411
|
+
* validation, save data, or warn users before allowing them to go
|
|
412
|
+
* to the next page in the wizard.
|
|
413
|
+
*
|
|
414
|
+
* Note that this requires you to call Wizard.forceNext() or Wizard.next()
|
|
415
|
+
* from the host component. This combination creates a full replacement of
|
|
416
|
+
* the forward navigation functionality.
|
|
417
|
+
*
|
|
418
|
+
* @memberof WizardPage
|
|
419
|
+
*
|
|
420
|
+
*/
|
|
421
|
+
nextButtonClicked: EventEmitter<ClrWizardPage>;
|
|
422
|
+
/**
|
|
423
|
+
* Emits an event when a danger button is clicked and the ClrWizardPage is
|
|
424
|
+
* the wizard's current page. By default, a danger button will act as
|
|
425
|
+
* either a "next" or "finish" button depending on if the ClrWizardPage is the
|
|
426
|
+
* last page or not.
|
|
427
|
+
*
|
|
428
|
+
* Can be used in conjunction with the ClrWizardPage.preventDefault
|
|
429
|
+
* (clrWizardPagePagePreventDefault) input to implement custom forwards
|
|
430
|
+
* or finish navigation at the page level when the danger button is clicked.
|
|
431
|
+
* This is useful if you would like to do validation, save data, or warn
|
|
432
|
+
* users before allowing them to go to the next page in the wizard or
|
|
433
|
+
* finish the wizard.
|
|
434
|
+
*
|
|
435
|
+
* Note that this requires you to call Wizard.finish(), Wizard.forceFinish(),
|
|
436
|
+
* Wizard.forceNext() or Wizard.next() from the host component. This
|
|
437
|
+
* combination creates a full replacement of the forward navigation and
|
|
438
|
+
* finish functionality.
|
|
439
|
+
*
|
|
440
|
+
* @memberof WizardPage
|
|
441
|
+
*
|
|
442
|
+
*/
|
|
443
|
+
dangerButtonClicked: EventEmitter<ClrWizardPage>;
|
|
444
|
+
/**
|
|
445
|
+
* Emits an event when a next, finish, or danger button is clicked and the
|
|
446
|
+
* ClrWizardPage is the wizard's current page.
|
|
447
|
+
*
|
|
448
|
+
* Can be used in conjunction with the ClrWizardPage.preventDefault
|
|
449
|
+
* (clrWizardPagePagePreventDefault) input to implement custom forwards
|
|
450
|
+
* or finish navigation at the page level, regardless of the type of
|
|
451
|
+
* primary button.
|
|
452
|
+
*
|
|
453
|
+
* This is useful if you would like to do validation, save data, or warn
|
|
454
|
+
* users before allowing them to go to the next page in the wizard or
|
|
455
|
+
* finish the wizard.
|
|
456
|
+
*
|
|
457
|
+
* Note that this requires you to call Wizard.finish(), Wizard.forceFinish(),
|
|
458
|
+
* Wizard.forceNext() or Wizard.next() from the host component. This
|
|
459
|
+
* combination creates a full replacement of the forward navigation and
|
|
460
|
+
* finish functionality.
|
|
461
|
+
*
|
|
462
|
+
* @memberof WizardPage
|
|
463
|
+
*
|
|
464
|
+
*/
|
|
465
|
+
primaryButtonClicked: EventEmitter<string>;
|
|
466
|
+
customButtonClicked: EventEmitter<string>;
|
|
467
|
+
/**
|
|
468
|
+
* Contains a reference to the page title which is used for a number
|
|
469
|
+
* of different tasks for display in the wizard.
|
|
470
|
+
*
|
|
471
|
+
* @memberof WizardPage
|
|
472
|
+
*
|
|
473
|
+
*/
|
|
474
|
+
pageTitle: ClrWizardPageTitle;
|
|
475
|
+
/**
|
|
476
|
+
* Contains a reference to the desired title for the page's step in the
|
|
477
|
+
* navigation on the left side of the wizard. Can be projected to change the
|
|
478
|
+
* navigation link's text.
|
|
479
|
+
*
|
|
480
|
+
* If not defined, then ClrWizardPage.pageTitle will be displayed in the stepnav.
|
|
481
|
+
*
|
|
482
|
+
* @memberof WizardPage
|
|
483
|
+
*
|
|
484
|
+
*/
|
|
485
|
+
pageNavTitle: ClrWizardPageNavTitle;
|
|
486
|
+
/**
|
|
487
|
+
* Contains a reference to the buttons defined within the page. If not defined,
|
|
488
|
+
* the wizard defaults to the set of buttons defined as a direct child of the
|
|
489
|
+
* wizard.
|
|
490
|
+
*
|
|
491
|
+
* @memberof WizardPage
|
|
492
|
+
*
|
|
493
|
+
*/
|
|
494
|
+
_buttons: ClrWizardPageButtons;
|
|
495
|
+
/**
|
|
496
|
+
* Contains a reference to the header actions defined within the page. If not defined,
|
|
497
|
+
* the wizard defaults to the set of header actions defined as a direct child of the
|
|
498
|
+
* wizard.
|
|
499
|
+
*
|
|
500
|
+
* @memberof WizardPage
|
|
501
|
+
*
|
|
502
|
+
*/
|
|
503
|
+
_headerActions: ClrWizardPageHeaderActions;
|
|
504
|
+
/**
|
|
505
|
+
*
|
|
506
|
+
* @memberof WizardPage
|
|
507
|
+
*
|
|
508
|
+
*/
|
|
509
|
+
private _nextStepDisabled;
|
|
510
|
+
/**
|
|
511
|
+
*
|
|
512
|
+
* @memberof WizardPage
|
|
513
|
+
*
|
|
514
|
+
*/
|
|
515
|
+
private _previousStepDisabled;
|
|
516
|
+
/**
|
|
517
|
+
*
|
|
518
|
+
* @memberof WizardPage
|
|
519
|
+
*
|
|
520
|
+
*/
|
|
521
|
+
private _hasError;
|
|
522
|
+
/**
|
|
523
|
+
*
|
|
524
|
+
* @memberof WizardPage
|
|
525
|
+
*
|
|
526
|
+
*/
|
|
527
|
+
private _stopCancel;
|
|
528
|
+
/**
|
|
529
|
+
*
|
|
530
|
+
* @memberof WizardPage
|
|
531
|
+
*
|
|
532
|
+
*/
|
|
533
|
+
private _stopNext;
|
|
534
|
+
/**
|
|
535
|
+
*
|
|
536
|
+
* @memberof WizardPage
|
|
537
|
+
*
|
|
538
|
+
*/
|
|
539
|
+
private _complete;
|
|
540
|
+
/**
|
|
541
|
+
* Creates an instance of ClrWizardPage.
|
|
542
|
+
*
|
|
543
|
+
* @memberof WizardPage
|
|
544
|
+
*/
|
|
545
|
+
constructor(navService: WizardNavigationService, pageCollection: PageCollectionService, buttonService: ButtonHubService);
|
|
546
|
+
/**
|
|
547
|
+
* A property that tells whether or not the wizard should be allowed
|
|
548
|
+
* to move to the next page.
|
|
549
|
+
*
|
|
550
|
+
* Useful for in-page validation because it prevents forward navigation
|
|
551
|
+
* and visibly disables the next button.
|
|
552
|
+
*
|
|
553
|
+
* Does not require that you re-implement navigation routines like you
|
|
554
|
+
* would if you were using ClrWizardPage.preventDefault or
|
|
555
|
+
* Wizard.preventDefault.
|
|
556
|
+
*
|
|
557
|
+
* @memberof WizardPage
|
|
558
|
+
*
|
|
559
|
+
*/
|
|
560
|
+
get nextStepDisabled(): boolean;
|
|
561
|
+
set nextStepDisabled(val: boolean);
|
|
562
|
+
/**
|
|
563
|
+
* A property that tells whether or not the wizard should be allowed
|
|
564
|
+
* to move to the previous page.
|
|
565
|
+
*
|
|
566
|
+
* Useful for in-page validation because it prevents backward navigation
|
|
567
|
+
* and visibly disables the previous button.
|
|
568
|
+
*
|
|
569
|
+
* Does not require that you re-implement navigation routines like you
|
|
570
|
+
* would if you were using ClrWizardPage.preventDefault or
|
|
571
|
+
* Wizard.preventDefault.
|
|
572
|
+
*
|
|
573
|
+
* @memberof WizardPage
|
|
574
|
+
*
|
|
575
|
+
*/
|
|
576
|
+
get previousStepDisabled(): boolean;
|
|
577
|
+
set previousStepDisabled(val: boolean);
|
|
578
|
+
/**
|
|
579
|
+
* Whether the page has an error and also resolve the "falsy" value. The
|
|
580
|
+
* current logic treat a "0" or an empty string as false and likewise will treat any
|
|
581
|
+
* "truthy" value as true.
|
|
582
|
+
*
|
|
583
|
+
* @memberof WizardPage
|
|
584
|
+
*
|
|
585
|
+
*/
|
|
586
|
+
get hasError(): boolean;
|
|
587
|
+
set hasError(val: boolean);
|
|
588
|
+
/**
|
|
589
|
+
* Overrides the cancel action from the page level. Allows you to use an
|
|
590
|
+
* alternate function for validation or data-munging before cancelling the
|
|
591
|
+
* wizard when combined with the ClrWizardPage.onCancel
|
|
592
|
+
* (the clrWizardPageOnCancel output).
|
|
593
|
+
*
|
|
594
|
+
* Requires that you manually close the wizard from your host component,
|
|
595
|
+
* usually with a call to Wizard.forceNext() or wizard.next();
|
|
596
|
+
*
|
|
597
|
+
* @memberof ClrWizardPage
|
|
598
|
+
*/
|
|
599
|
+
get stopCancel(): boolean;
|
|
600
|
+
set stopCancel(val: boolean);
|
|
601
|
+
/**
|
|
602
|
+
* Overrides forward navigation from the page level. Allows you to use an
|
|
603
|
+
* alternate function for validation or data-munging before moving the
|
|
604
|
+
* wizard to the next pagewhen combined with the ClrWizardPage.onCommit
|
|
605
|
+
* (clrWizardPageOnCommit) or ClrWizardPage.nextButtonClicked
|
|
606
|
+
* (clrWizardPageNext) outputs.
|
|
607
|
+
*
|
|
608
|
+
* Requires that you manually tell the wizard to navigate forward from
|
|
609
|
+
* the hostComponent, usually with a call to Wizard.forceNext() or
|
|
610
|
+
* wizard.next();
|
|
611
|
+
*
|
|
612
|
+
* @memberof ClrWizardPage
|
|
613
|
+
*/
|
|
614
|
+
get stopNext(): boolean;
|
|
615
|
+
set stopNext(val: boolean);
|
|
616
|
+
/**
|
|
617
|
+
* A read-only getter that generates an ID string for the wizard page from
|
|
618
|
+
* either the value passed to the ClrWizardPage "id" input or a wizard page
|
|
619
|
+
* counter shared across all wizard pages in the application.
|
|
620
|
+
*
|
|
621
|
+
* Note that the value passed into the ID input Will be prefixed with
|
|
622
|
+
* "clr-wizard-page-".
|
|
623
|
+
*
|
|
624
|
+
* @readonly
|
|
625
|
+
*
|
|
626
|
+
* @memberof ClrWizardPage
|
|
627
|
+
*/
|
|
628
|
+
get id(): string;
|
|
629
|
+
/**
|
|
630
|
+
* A read-only getter that serves as a convenience for those who would rather
|
|
631
|
+
* not think in the terms of !ClrWizardPage.nextStepDisabled. For some use cases,
|
|
632
|
+
* ClrWizardPage.readyToComplete is more logical and declarative.
|
|
633
|
+
*
|
|
634
|
+
* @memberof WizardPage
|
|
635
|
+
*
|
|
636
|
+
*/
|
|
637
|
+
get readyToComplete(): boolean;
|
|
638
|
+
/**
|
|
639
|
+
* A page is marked as completed if it is both readyToComplete and completed,
|
|
640
|
+
* as in the next or finish action has been executed while this page was current.
|
|
641
|
+
*
|
|
642
|
+
* Note there is and open question about how to handle pages that are marked
|
|
643
|
+
* complete but who are no longer readyToComplete. This might indicate an error
|
|
644
|
+
* state for the ClrWizardPage. Currently, the wizard does not acknowledge this state
|
|
645
|
+
* and only returns that the page is incomplete.
|
|
646
|
+
*
|
|
647
|
+
* @memberof WizardPage
|
|
648
|
+
*
|
|
649
|
+
*/
|
|
650
|
+
get completed(): boolean;
|
|
651
|
+
/**
|
|
652
|
+
* A ClrWizardPage can be manually set to completed using this boolean setter.
|
|
653
|
+
* It is recommended that users rely on the convenience functions in the wizard
|
|
654
|
+
* and navigation service instead of manually setting pages’ completion state.
|
|
655
|
+
*
|
|
656
|
+
* @memberof ClrWizardPage
|
|
657
|
+
*/
|
|
658
|
+
set completed(value: boolean);
|
|
659
|
+
/**
|
|
660
|
+
* Checks with the navigation service to see if it is the current page.
|
|
661
|
+
*
|
|
662
|
+
* @memberof WizardPage
|
|
663
|
+
*
|
|
664
|
+
*/
|
|
665
|
+
get current(): boolean;
|
|
666
|
+
get disabled(): boolean;
|
|
667
|
+
/**
|
|
668
|
+
* A read-only getter that returns whether or not the page is navigable
|
|
669
|
+
* in the wizard. A wizard page can be navigated to if it is completed
|
|
670
|
+
* or the page before it is completed.
|
|
671
|
+
*
|
|
672
|
+
* This getter handles the logic for enabling or disabling the links in
|
|
673
|
+
* the step nav on the left Side of the wizard.
|
|
674
|
+
*
|
|
675
|
+
* @memberof WizardPage
|
|
676
|
+
*
|
|
677
|
+
*/
|
|
678
|
+
get enabled(): boolean;
|
|
679
|
+
/**
|
|
680
|
+
* A read-only getter that returns whether or not the page before this
|
|
681
|
+
* ClrWizardPage is completed. This is useful for determining whether or not
|
|
682
|
+
* a page is navigable if it is not current or already completed.
|
|
683
|
+
*
|
|
684
|
+
* @memberof WizardPage
|
|
685
|
+
*
|
|
686
|
+
*/
|
|
687
|
+
get previousCompleted(): boolean;
|
|
688
|
+
/**
|
|
689
|
+
*
|
|
690
|
+
* @memberof WizardPage
|
|
691
|
+
*
|
|
692
|
+
*/
|
|
693
|
+
get title(): TemplateRef<any>;
|
|
694
|
+
/**
|
|
695
|
+
*
|
|
696
|
+
* @memberof WizardPage
|
|
697
|
+
*
|
|
698
|
+
*/
|
|
699
|
+
get navTitle(): TemplateRef<any>;
|
|
700
|
+
/**
|
|
701
|
+
*
|
|
702
|
+
* @memberof WizardPage
|
|
703
|
+
*
|
|
704
|
+
*/
|
|
705
|
+
get headerActions(): TemplateRef<any>;
|
|
706
|
+
/**
|
|
707
|
+
*
|
|
708
|
+
* @memberof WizardPage
|
|
709
|
+
*
|
|
710
|
+
*/
|
|
711
|
+
get hasHeaderActions(): boolean;
|
|
712
|
+
/**
|
|
713
|
+
*
|
|
714
|
+
* @memberof WizardPage
|
|
715
|
+
*
|
|
716
|
+
*/
|
|
717
|
+
get buttons(): TemplateRef<any>;
|
|
718
|
+
/**
|
|
719
|
+
* A read-only getter that returns a boolean that says whether or
|
|
720
|
+
* not the ClrWizardPage includes buttons. Used to determine if the
|
|
721
|
+
* Wizard should override the default button set defined as
|
|
722
|
+
* its direct children.
|
|
723
|
+
*
|
|
724
|
+
* @memberof WizardPage
|
|
725
|
+
*
|
|
726
|
+
*/
|
|
727
|
+
get hasButtons(): boolean;
|
|
728
|
+
/**
|
|
729
|
+
* A read-only getter that returns the id used by the step nav item associated with the page.
|
|
730
|
+
*
|
|
731
|
+
* ClrWizardPage needs this ID string for aria information.
|
|
732
|
+
*
|
|
733
|
+
* @memberof WizardPage
|
|
734
|
+
*
|
|
735
|
+
*/
|
|
736
|
+
get stepItemId(): string;
|
|
737
|
+
/**
|
|
738
|
+
* Links the nav service and establishes the current page if one is not defined.
|
|
739
|
+
*
|
|
740
|
+
* @memberof WizardPage
|
|
741
|
+
*
|
|
742
|
+
*/
|
|
743
|
+
ngOnInit(): void;
|
|
744
|
+
/**
|
|
745
|
+
* Uses the nav service to make the ClrWizardPage the current page in the
|
|
746
|
+
* wizard. Bypasses all checks but still emits the ClrWizardPage.onLoad
|
|
747
|
+
* (clrWizardPageOnLoad) output.
|
|
748
|
+
*
|
|
749
|
+
* In most cases, it is better to use the default navigation functions
|
|
750
|
+
* in Wizard.
|
|
751
|
+
*
|
|
752
|
+
* @memberof WizardPage
|
|
753
|
+
*
|
|
754
|
+
*/
|
|
755
|
+
makeCurrent(): void;
|
|
756
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<ClrWizardPage, never>;
|
|
757
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<ClrWizardPage, "clr-wizard-page", never, { "_id": { "alias": "id"; "required": false; }; "preventDefault": { "alias": "clrWizardPagePreventDefault"; "required": false; }; "nextStepDisabled": { "alias": "clrWizardPageNextDisabled"; "required": false; }; "previousStepDisabled": { "alias": "clrWizardPagePreviousDisabled"; "required": false; }; "hasError": { "alias": "clrWizardPageHasError"; "required": false; }; "stopCancel": { "alias": "clrWizardPagePreventDefaultCancel"; "required": false; }; "stopNext": { "alias": "clrWizardPagePreventDefaultNext"; "required": false; }; }, { "nextStepDisabledChange": "clrWizardPageNextDisabledChange"; "previousStepDisabledChange": "clrWizardPagePreviousDisabledChange"; "stopCancelChange": "clrWizardPagePreventDefaultCancelChange"; "onCommit": "clrWizardPageOnCommit"; "onLoad": "clrWizardPageOnLoad"; "pageOnCancel": "clrWizardPageOnCancel"; "finishButtonClicked": "clrWizardPageFinish"; "previousButtonClicked": "clrWizardPagePrevious"; "nextButtonClicked": "clrWizardPageNext"; "dangerButtonClicked": "clrWizardPageDanger"; "primaryButtonClicked": "clrWizardPagePrimary"; "customButtonClicked": "clrWizardPageCustomButton"; }, ["pageTitle", "pageNavTitle", "_buttons", "_headerActions"], ["*"], false, never>;
|
|
758
|
+
}
|
|
759
|
+
|
|
760
|
+
/**
|
|
761
|
+
* Performs navigation functions for a wizard and manages the current page. Presented as a
|
|
762
|
+
* separate service to encapsulate the behavior of navigating and completing the wizard so
|
|
763
|
+
* that it can be shared across the wizard and its sub-components.
|
|
764
|
+
*
|
|
765
|
+
* The easiest way to access the navigation service is there a reference on your wizard. The
|
|
766
|
+
* Following example would allow you to access your instance of the wizard from your host
|
|
767
|
+
* component and thereby access the navigation service via YourHostComponent.wizard.navService.
|
|
768
|
+
*
|
|
769
|
+
* @example
|
|
770
|
+
* <clr-wizard #wizard ...>
|
|
771
|
+
*
|
|
772
|
+
* @example
|
|
773
|
+
* export class YourHostComponent {
|
|
774
|
+
* @ViewChild("wizard") wizard: Wizard;
|
|
775
|
+
* ...
|
|
776
|
+
* }
|
|
777
|
+
*
|
|
778
|
+
*/
|
|
779
|
+
declare class WizardNavigationService implements OnDestroy {
|
|
780
|
+
pageCollection: PageCollectionService;
|
|
781
|
+
buttonService: ButtonHubService;
|
|
782
|
+
/**
|
|
783
|
+
* Is notified when a previous button is clicked in the wizard. Performs checks
|
|
784
|
+
* before alerting the current page of the button click. Enacts navigation to
|
|
785
|
+
* the previous page if not overridden at the page level.
|
|
786
|
+
*
|
|
787
|
+
* @memberof WizardNavigationService
|
|
788
|
+
*/
|
|
789
|
+
previousButtonSubscription: Subscription;
|
|
790
|
+
/**
|
|
791
|
+
* Is notified when a Next button is clicked in the wizard.
|
|
792
|
+
*
|
|
793
|
+
* @memberof WizardNavigationService
|
|
794
|
+
*/
|
|
795
|
+
nextButtonSubscription: Subscription;
|
|
796
|
+
/**
|
|
797
|
+
* Is notified when a danger button is clicked in the wizard.
|
|
798
|
+
*
|
|
799
|
+
* @memberof WizardNavigationService
|
|
800
|
+
*/
|
|
801
|
+
dangerButtonSubscription: Subscription;
|
|
802
|
+
/**
|
|
803
|
+
* Is notified when a finish button is clicked in the wizard.
|
|
804
|
+
*
|
|
805
|
+
* @memberof WizardNavigationService
|
|
806
|
+
*/
|
|
807
|
+
finishButtonSubscription: Subscription;
|
|
808
|
+
/**
|
|
809
|
+
* Is notified when a Custom button is clicked in the wizard.
|
|
810
|
+
*
|
|
811
|
+
* @memberof WizardNavigationService
|
|
812
|
+
*/
|
|
813
|
+
customButtonSubscription: Subscription;
|
|
814
|
+
/**
|
|
815
|
+
* Is notified when a Cancel button is clicked in the wizard. Notifies the wizard,
|
|
816
|
+
* which handles all cancel functionality, if cancel is not overridden at the page
|
|
817
|
+
* level.
|
|
818
|
+
*
|
|
819
|
+
* @memberof WizardNavigationService
|
|
820
|
+
*/
|
|
821
|
+
cancelButtonSubscription: Subscription;
|
|
822
|
+
/**
|
|
823
|
+
* Resets navigation to make the first page current when the page collection service
|
|
824
|
+
* emits an event notifying WizardNavigationService that it has reset all pages
|
|
825
|
+
* to their pristine, incomplete state.
|
|
826
|
+
*
|
|
827
|
+
* @memberof WizardNavigationService
|
|
828
|
+
*/
|
|
829
|
+
pagesResetSubscription: Subscription;
|
|
830
|
+
/**
|
|
831
|
+
* A Boolean flag used by the ClrWizardPage to avoid a race condition when pages are
|
|
832
|
+
* loading and there is no current page defined.
|
|
833
|
+
*
|
|
834
|
+
* @memberof WizardNavigationService
|
|
835
|
+
*/
|
|
836
|
+
navServiceLoaded: boolean;
|
|
837
|
+
/**
|
|
838
|
+
* A boolean flag shared across the Wizard subcomponents that follows the value
|
|
839
|
+
* of the Wizard.forceForward (clrWizardForceForwardNavigation) input. When true,
|
|
840
|
+
* navigating backwards in the stepnav menu will reset any skipped pages' completed
|
|
841
|
+
* state to false.
|
|
842
|
+
*
|
|
843
|
+
* This is useful when a wizard executes validation on a page-by-page basis when
|
|
844
|
+
* the next button is clicked.
|
|
845
|
+
*
|
|
846
|
+
* @memberof WizardNavigationService
|
|
847
|
+
*/
|
|
848
|
+
forceForwardNavigation: boolean;
|
|
849
|
+
/**
|
|
850
|
+
* A boolean flag shared across the Wizard subcomponents that follows the value
|
|
851
|
+
* of the Wizard.stopCancel (clrWizardPreventDefaultCancel) input. When true, the cancel
|
|
852
|
+
* routine is subverted and must be reinstated in the host component calling Wizard.close()
|
|
853
|
+
* at some point.
|
|
854
|
+
*
|
|
855
|
+
* @memberof WizardNavigationService
|
|
856
|
+
*/
|
|
857
|
+
wizardHasAltCancel: boolean;
|
|
858
|
+
/**
|
|
859
|
+
* A boolean flag shared across the Wizard subcomponents that follows the value
|
|
860
|
+
* of the Wizard.stopNext (clrWizardPreventDefaultNext) input. When true, the next and finish
|
|
861
|
+
* routines are subverted and must be reinstated in the host component calling Wizard.next(),
|
|
862
|
+
* Wizard.forceNext(), Wizard.finish(), or Wizard.forceFinish().
|
|
863
|
+
*
|
|
864
|
+
* @memberof WizardNavigationService
|
|
865
|
+
*/
|
|
866
|
+
wizardHasAltNext: boolean;
|
|
867
|
+
/**
|
|
868
|
+
* A boolean flag shared across the Wizard subcomponents that follows the value
|
|
869
|
+
* of the Wizard.stopNavigation (clrWizardPreventNavigation) input. When true, all
|
|
870
|
+
* navigational elements in the wizard are disabled.
|
|
871
|
+
*
|
|
872
|
+
* This is intended to freeze the wizard in place. Events are not fired so this is
|
|
873
|
+
* not a way to implement alternate functionality for navigation.
|
|
874
|
+
*
|
|
875
|
+
* @memberof WizardNavigationService
|
|
876
|
+
*/
|
|
877
|
+
wizardStopNavigation: boolean;
|
|
878
|
+
/**
|
|
879
|
+
* A boolean flag shared with the stepnav items that prevents user clicks on
|
|
880
|
+
* stepnav items from navigating the wizard.
|
|
881
|
+
*
|
|
882
|
+
* @memberof WizardNavigationService
|
|
883
|
+
*/
|
|
884
|
+
wizardDisableStepnav: boolean;
|
|
885
|
+
/**
|
|
886
|
+
* The layout of the wizard stepnav, either 'vertical' or 'horizontal'.
|
|
887
|
+
*/
|
|
888
|
+
stepnavLayout: ClrWizardStepnavLayout;
|
|
889
|
+
/**
|
|
890
|
+
* @memberof WizardNavigationService
|
|
891
|
+
*/
|
|
892
|
+
private _currentPage;
|
|
893
|
+
/**
|
|
894
|
+
*
|
|
895
|
+
* @memberof WizardNavigationService
|
|
896
|
+
*/
|
|
897
|
+
private _currentChanged;
|
|
898
|
+
/**
|
|
899
|
+
* @memberof WizardNavigationService
|
|
900
|
+
*/
|
|
901
|
+
private _movedToNextPage;
|
|
902
|
+
/**
|
|
903
|
+
* @memberof WizardNavigationService
|
|
904
|
+
*/
|
|
905
|
+
private _wizardFinished;
|
|
906
|
+
/**
|
|
907
|
+
* @memberof WizardNavigationService
|
|
908
|
+
*/
|
|
909
|
+
private _movedToPreviousPage;
|
|
910
|
+
/**
|
|
911
|
+
* @memberof WizardNavigationService
|
|
912
|
+
*/
|
|
913
|
+
private _cancelWizard;
|
|
914
|
+
/**
|
|
915
|
+
* Creates an instance of WizardNavigationService. Also sets up subscriptions
|
|
916
|
+
* that listen to the button service to determine when a button has been clicked
|
|
917
|
+
* in the wizard. Is also responsible for taking action when the page collection
|
|
918
|
+
* requests that navigation be reset to its pristine state.
|
|
919
|
+
*
|
|
920
|
+
* @memberof WizardNavigationService
|
|
921
|
+
*/
|
|
922
|
+
constructor(pageCollection: PageCollectionService, buttonService: ButtonHubService);
|
|
923
|
+
/**
|
|
924
|
+
* An Observable that is predominantly used amongst the subcomponents and services
|
|
925
|
+
* of the wizard. It is recommended that users listen to the ClrWizardPage.onLoad
|
|
926
|
+
* (clrWizardPageOnLoad) output instead of this Observable.
|
|
927
|
+
*
|
|
928
|
+
* @memberof WizardNavigationService
|
|
929
|
+
*/
|
|
930
|
+
get currentPageChange(): Observable<ClrWizardPage>;
|
|
931
|
+
/**
|
|
932
|
+
* @memberof WizardNavigationService
|
|
933
|
+
*/
|
|
934
|
+
get currentPageTitle(): TemplateRef<any>;
|
|
935
|
+
/**
|
|
936
|
+
* Returns a Boolean that tells you whether or not the current page is the first
|
|
937
|
+
* page in the Wizard.
|
|
938
|
+
*
|
|
939
|
+
* This is helpful for determining whether a page is navigable.
|
|
940
|
+
*
|
|
941
|
+
* @memberof WizardNavigationService
|
|
942
|
+
*/
|
|
943
|
+
get currentPageIsFirst(): boolean;
|
|
944
|
+
/**
|
|
945
|
+
* Returns a Boolean that tells you whether or not the current page is the
|
|
946
|
+
* last page in the Wizard.
|
|
947
|
+
*
|
|
948
|
+
* This is used to determine which buttons should display in the wizard footer.
|
|
949
|
+
*
|
|
950
|
+
* @memberof WizardNavigationService
|
|
951
|
+
*/
|
|
952
|
+
get currentPageIsLast(): boolean;
|
|
953
|
+
/**
|
|
954
|
+
* Returns the ClrWizardPage object of the current page or null.
|
|
955
|
+
*
|
|
956
|
+
* @memberof WizardNavigationService
|
|
957
|
+
*/
|
|
958
|
+
get currentPage(): ClrWizardPage;
|
|
959
|
+
/**
|
|
960
|
+
* Accepts a ClrWizardPage object, since that object to be the current/active
|
|
961
|
+
* page in the wizard, and emits the ClrWizardPage.onLoad (clrWizardPageOnLoad)
|
|
962
|
+
* event for that page.
|
|
963
|
+
*
|
|
964
|
+
* Note that all of this work is bypassed if the ClrWizardPage object is already
|
|
965
|
+
* the current page.
|
|
966
|
+
*
|
|
967
|
+
* @memberof WizardNavigationService
|
|
968
|
+
*/
|
|
969
|
+
set currentPage(page: ClrWizardPage);
|
|
970
|
+
/**
|
|
971
|
+
* An observable used internally to alert the wizard that forward navigation
|
|
972
|
+
* has occurred. It is recommended that you use the Wizard.onMoveNext
|
|
973
|
+
* (clrWizardOnNext) output instead of this one.
|
|
974
|
+
*
|
|
975
|
+
* @memberof WizardNavigationService
|
|
976
|
+
*/
|
|
977
|
+
get movedToNextPage(): Observable<boolean>;
|
|
978
|
+
/**
|
|
979
|
+
* An observable used internally to alert the wizard that the nav service
|
|
980
|
+
* has approved completion of the wizard.
|
|
981
|
+
*
|
|
982
|
+
* It is recommended that you use the Wizard.wizardFinished (clrWizardOnFinish)
|
|
983
|
+
* output instead of this one.
|
|
984
|
+
*
|
|
985
|
+
* @memberof WizardNavigationService
|
|
986
|
+
*/
|
|
987
|
+
get wizardFinished(): Observable<void>;
|
|
988
|
+
/**
|
|
989
|
+
* Notifies the wizard when backwards navigation has occurred via the
|
|
990
|
+
* previous button.
|
|
991
|
+
*
|
|
992
|
+
* @memberof WizardNavigationService
|
|
993
|
+
*/
|
|
994
|
+
get movedToPreviousPage(): Observable<boolean>;
|
|
995
|
+
/**
|
|
996
|
+
* Notifies the wizard that a user is trying to cancel it.
|
|
997
|
+
*
|
|
998
|
+
* @memberof WizardNavigationService
|
|
999
|
+
*/
|
|
1000
|
+
get notifyWizardCancel(): Observable<any>;
|
|
1001
|
+
/**
|
|
1002
|
+
*
|
|
1003
|
+
* @memberof WizardNavigationService
|
|
1004
|
+
*/
|
|
1005
|
+
ngOnDestroy(): void;
|
|
1006
|
+
/**
|
|
1007
|
+
* This is a public function that can be used to programmatically advance
|
|
1008
|
+
* the user to the next page.
|
|
1009
|
+
*
|
|
1010
|
+
* When invoked, this method will move the wizard to the next page after
|
|
1011
|
+
* successful validation. Note that this method goes through all checks
|
|
1012
|
+
* and event emissions as if Wizard.next(false) had been called.
|
|
1013
|
+
*
|
|
1014
|
+
* In most cases, it makes more sense to use Wizard.next(false).
|
|
1015
|
+
*
|
|
1016
|
+
* @memberof WizardNavigationService
|
|
1017
|
+
*/
|
|
1018
|
+
next(): void;
|
|
1019
|
+
/**
|
|
1020
|
+
* Bypasses checks and most event emissions to force a page to navigate forward.
|
|
1021
|
+
*
|
|
1022
|
+
* Comparable to calling Wizard.next() or Wizard.forceNext().
|
|
1023
|
+
*
|
|
1024
|
+
* @memberof WizardNavigationService
|
|
1025
|
+
*/
|
|
1026
|
+
forceNext(): void;
|
|
1027
|
+
/**
|
|
1028
|
+
* Accepts a button/action type as a parameter. Encapsulates all logic for
|
|
1029
|
+
* event emissions, state of the current page, and wizard and page level overrides.
|
|
1030
|
+
*
|
|
1031
|
+
* Avoid calling this function directly unless you really know what you're doing.
|
|
1032
|
+
*
|
|
1033
|
+
* @memberof WizardNavigationService
|
|
1034
|
+
*/
|
|
1035
|
+
checkAndCommitCurrentPage(buttonType: string): void;
|
|
1036
|
+
/**
|
|
1037
|
+
* This is a public function that can be used to programmatically conclude
|
|
1038
|
+
* the wizard.
|
|
1039
|
+
*
|
|
1040
|
+
* When invoked, this method will initiate the work involved with finalizing
|
|
1041
|
+
* and finishing the wizard workflow. Note that this method goes through all
|
|
1042
|
+
* checks and event emissions as if Wizard.finish(false) had been called.
|
|
1043
|
+
*
|
|
1044
|
+
* In most cases, it makes more sense to use Wizard.finish(false).
|
|
1045
|
+
*
|
|
1046
|
+
* @memberof WizardNavigationService
|
|
1047
|
+
*/
|
|
1048
|
+
finish(): void;
|
|
1049
|
+
/**
|
|
1050
|
+
* Programmatically moves the wizard to the page before the current page.
|
|
1051
|
+
*
|
|
1052
|
+
* In most instances, it makes more sense to call Wizard.previous()
|
|
1053
|
+
* which does the same thing.
|
|
1054
|
+
*
|
|
1055
|
+
* @memberof WizardNavigationService
|
|
1056
|
+
*/
|
|
1057
|
+
previous(): void;
|
|
1058
|
+
/**
|
|
1059
|
+
* Allows a hook into the cancel workflow of the wizard from the nav service. Note that
|
|
1060
|
+
* this route goes through all checks and event emissions as if a cancel button had
|
|
1061
|
+
* been clicked.
|
|
1062
|
+
*
|
|
1063
|
+
* In most cases, users looking for a hook into the cancel routine are actually looking
|
|
1064
|
+
* for a way to close the wizard from their host component because they have prevented
|
|
1065
|
+
* the default cancel action.
|
|
1066
|
+
*
|
|
1067
|
+
* In this instance, it is recommended that you use Wizard.close() to avoid any event
|
|
1068
|
+
* emission loop resulting from an event handler calling back into routine that will
|
|
1069
|
+
* again evoke the events it handles.
|
|
1070
|
+
*
|
|
1071
|
+
* @memberof WizardNavigationService
|
|
1072
|
+
*/
|
|
1073
|
+
cancel(): void;
|
|
1074
|
+
/**
|
|
1075
|
+
* Performs all required checks to determine if a user can navigate to a page. Checking at each
|
|
1076
|
+
* point if a page is navigable -- completed where the page immediately after the last completed
|
|
1077
|
+
* page.
|
|
1078
|
+
*
|
|
1079
|
+
* Takes two parameters. The first one must be either the ClrWizardPage object or the ID of the
|
|
1080
|
+
* ClrWizardPage object that you want to make the current page.
|
|
1081
|
+
*
|
|
1082
|
+
* The second parameter is optional and is a Boolean flag for "lazy completion". What this means
|
|
1083
|
+
* is the Wizard will mark all pages between the current page and the page you want to navigate
|
|
1084
|
+
* to as completed. This is useful for informational wizards that do not require user action,
|
|
1085
|
+
* allowing an easy means for users to jump ahead.
|
|
1086
|
+
*
|
|
1087
|
+
* To avoid checks on navigation, use ClrWizardPage.makeCurrent() instead.
|
|
1088
|
+
*
|
|
1089
|
+
* @memberof WizardNavigationService
|
|
1090
|
+
*/
|
|
1091
|
+
goTo(pageToGoToOrId: any, lazyComplete?: boolean): void;
|
|
1092
|
+
/**
|
|
1093
|
+
* Accepts a range of ClrWizardPage objects as a parameter. Performs the work of checking
|
|
1094
|
+
* those objects to determine if navigation can be accomplished.
|
|
1095
|
+
*
|
|
1096
|
+
* @memberof WizardNavigationService
|
|
1097
|
+
*/
|
|
1098
|
+
canGoTo(pagesToCheck: ClrWizardPage[]): boolean;
|
|
1099
|
+
/**
|
|
1100
|
+
* Looks through the collection of pages to find the first one that is incomplete
|
|
1101
|
+
* and makes that page the current/active page.
|
|
1102
|
+
*
|
|
1103
|
+
* @memberof WizardNavigationService
|
|
1104
|
+
*/
|
|
1105
|
+
setLastEnabledPageCurrent(): void;
|
|
1106
|
+
/**
|
|
1107
|
+
* Finds the first page in the collection of pages and makes that page the
|
|
1108
|
+
* current/active page.
|
|
1109
|
+
*
|
|
1110
|
+
* @memberof WizardNavigationService
|
|
1111
|
+
*/
|
|
1112
|
+
setFirstPageCurrent(): void;
|
|
1113
|
+
/**
|
|
1114
|
+
* Updates the stepnav on the left side of the wizard when pages are dynamically
|
|
1115
|
+
* added or removed from the collection of pages.
|
|
1116
|
+
*
|
|
1117
|
+
* @memberof WizardNavigationService
|
|
1118
|
+
*/
|
|
1119
|
+
updateNavigation(): void;
|
|
1120
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<WizardNavigationService, never>;
|
|
1121
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<WizardNavigationService>;
|
|
1122
|
+
}
|
|
1123
|
+
|
|
1124
|
+
declare class HeaderActionService {
|
|
1125
|
+
navService: WizardNavigationService;
|
|
1126
|
+
wizardHeaderActions: QueryList<ClrWizardHeaderAction>;
|
|
1127
|
+
constructor(navService: WizardNavigationService);
|
|
1128
|
+
get wizardHasHeaderActions(): boolean;
|
|
1129
|
+
get currentPageHasHeaderActions(): boolean;
|
|
1130
|
+
get showWizardHeaderActions(): boolean;
|
|
1131
|
+
get displayHeaderActionsWrapper(): boolean;
|
|
1132
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<HeaderActionService, never>;
|
|
1133
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<HeaderActionService>;
|
|
1134
|
+
}
|
|
1135
|
+
|
|
1136
|
+
declare const DEFAULT_BUTTON_TYPES: any;
|
|
1137
|
+
declare const CUSTOM_BUTTON_TYPES: any;
|
|
1138
|
+
declare class ClrWizardButton {
|
|
1139
|
+
navService: WizardNavigationService;
|
|
1140
|
+
buttonService: ButtonHubService;
|
|
1141
|
+
type: string;
|
|
1142
|
+
disabled: boolean;
|
|
1143
|
+
hidden: boolean;
|
|
1144
|
+
wasClicked: EventEmitter<string>;
|
|
1145
|
+
constructor(navService: WizardNavigationService, buttonService: ButtonHubService);
|
|
1146
|
+
get isCancel(): boolean;
|
|
1147
|
+
get isNext(): boolean;
|
|
1148
|
+
get isPrevious(): boolean;
|
|
1149
|
+
get isFinish(): boolean;
|
|
1150
|
+
get isDanger(): boolean;
|
|
1151
|
+
get isPrimaryAction(): boolean;
|
|
1152
|
+
get _disabledAttribute(): string | null;
|
|
1153
|
+
get isDisabled(): boolean;
|
|
1154
|
+
get isHidden(): boolean;
|
|
1155
|
+
click(): void;
|
|
1156
|
+
private checkDefaultAndCustomType;
|
|
1157
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<ClrWizardButton, never>;
|
|
1158
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<ClrWizardButton, "clr-wizard-button", never, { "type": { "alias": "type"; "required": false; }; "disabled": { "alias": "clrWizardButtonDisabled"; "required": false; }; "hidden": { "alias": "clrWizardButtonHidden"; "required": false; }; }, { "wasClicked": "clrWizardButtonClicked"; }, never, ["*"], false, never>;
|
|
1159
|
+
}
|
|
1160
|
+
|
|
1161
|
+
declare class ClrWizardTitle {
|
|
1162
|
+
headingLevel: HeadingLevel;
|
|
1163
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<ClrWizardTitle, never>;
|
|
1164
|
+
static ɵdir: i0.ɵɵDirectiveDeclaration<ClrWizardTitle, "clr-wizard-title", never, { "headingLevel": { "alias": "clrHeadingLevel"; "required": false; }; }, {}, never, never, false, never>;
|
|
1165
|
+
}
|
|
1166
|
+
|
|
1167
|
+
declare class ClrWizard implements OnDestroy, AfterContentInit, DoCheck {
|
|
1168
|
+
private platformId;
|
|
1169
|
+
commonStrings: ClrCommonStringsService;
|
|
1170
|
+
navService: WizardNavigationService;
|
|
1171
|
+
pageCollection: PageCollectionService;
|
|
1172
|
+
buttonService: ButtonHubService;
|
|
1173
|
+
headerActionService: HeaderActionService;
|
|
1174
|
+
private elementRef;
|
|
1175
|
+
/**
|
|
1176
|
+
* Set the aria-label for the stepnav section of the wizard. Set using `[clrWizardStepnavAriaLabel]` input.
|
|
1177
|
+
*/
|
|
1178
|
+
stepnavAriaLabel: string;
|
|
1179
|
+
/**
|
|
1180
|
+
* Set the wizard stepnav layout to 'vertical' (default) or 'horizontal'. Set using `[clrWizardStepnavLayout]` input.
|
|
1181
|
+
*/
|
|
1182
|
+
stepnavLayout: ClrWizardStepnavLayout;
|
|
1183
|
+
/**
|
|
1184
|
+
* Set the modal size of the wizard. Set using `[clrWizardSize]` input.
|
|
1185
|
+
*/
|
|
1186
|
+
size: string;
|
|
1187
|
+
/**
|
|
1188
|
+
* Enable "in page" wizard. Set using `[clrWizardInPage]` input.
|
|
1189
|
+
*/
|
|
1190
|
+
inPage: boolean;
|
|
1191
|
+
/**
|
|
1192
|
+
* Make an "in page" wizard fill the `.content-area`. Set using `[clrWizardInPageFillContentArea]` input.
|
|
1193
|
+
* If you can't use this option, you will likely need to provide custom CSS to set the wizard's height and margins.
|
|
1194
|
+
*/
|
|
1195
|
+
inPageFillContentArea: boolean;
|
|
1196
|
+
/**
|
|
1197
|
+
* Hide the wizard footer entirely. Set using `[clrWizardHideFooter]` input.
|
|
1198
|
+
* Useful when a nested wizard or stepper handles its own navigation.
|
|
1199
|
+
*/
|
|
1200
|
+
hideFooter: boolean;
|
|
1201
|
+
/**
|
|
1202
|
+
* Align the footer buttons to 'start' (left) or 'end' (right).
|
|
1203
|
+
* By default, modal wizards align to 'end' and in-page wizards align to 'start'.
|
|
1204
|
+
* Nested wizards inherit the default unless this input is explicitly set.
|
|
1205
|
+
* Set using `[clrWizardFooterAlign]` input.
|
|
1206
|
+
*/
|
|
1207
|
+
_footerAlign: ClrWizardFooterAlign | null;
|
|
1208
|
+
/**
|
|
1209
|
+
* Tells the modal part of the wizard whether it should have a close "X"
|
|
1210
|
+
* in the top right corner. Set using `[clrWizardClosable]` input.
|
|
1211
|
+
*/
|
|
1212
|
+
closable: boolean;
|
|
1213
|
+
/**
|
|
1214
|
+
* Used to communicate to the underlying modal that animations are not
|
|
1215
|
+
* wanted. Primary use is for the display of static/inline wizards.
|
|
1216
|
+
* Set using `[clrWizardPreventModalAnimation]` input.
|
|
1217
|
+
*/
|
|
1218
|
+
_stopModalAnimations: boolean;
|
|
1219
|
+
/**
|
|
1220
|
+
* Emits when the wizard is opened or closed.
|
|
1221
|
+
* Listen via `(clrWizardOpenChange)` event.
|
|
1222
|
+
*/
|
|
1223
|
+
_openChanged: EventEmitter<boolean>;
|
|
1224
|
+
/**
|
|
1225
|
+
* Emits when the wizard is canceled. Listen via `(clrWizardOnCancel)` event.
|
|
1226
|
+
* Can be combined with the `[clrWizardPreventDefaultCancel]` input to create
|
|
1227
|
+
* wizard-level custom cancel routines.
|
|
1228
|
+
*/
|
|
1229
|
+
onCancel: EventEmitter<any>;
|
|
1230
|
+
/**
|
|
1231
|
+
* Emits when the wizard is completed. Listen via `(clrWizardOnFinish)` event.
|
|
1232
|
+
* Can be combined with the `[clrWizardPreventDefaultNext]` input to create
|
|
1233
|
+
* wizard-level custom completion routines.
|
|
1234
|
+
*/
|
|
1235
|
+
wizardFinished: EventEmitter<any>;
|
|
1236
|
+
/**
|
|
1237
|
+
* Emits when the wizard is reset. Listen via `(clrWizardOnReset)` event.
|
|
1238
|
+
*/
|
|
1239
|
+
onReset: EventEmitter<any>;
|
|
1240
|
+
/**
|
|
1241
|
+
* Emits when the current page has changed. Listen via `(clrWizardCurrentPageChange)` event.
|
|
1242
|
+
* output. Useful for non-blocking validation.
|
|
1243
|
+
*/
|
|
1244
|
+
currentPageChange: EventEmitter<any>;
|
|
1245
|
+
/**
|
|
1246
|
+
* Emits when the wizard moves to the next page. Listen via `(clrWizardOnNext)` event.
|
|
1247
|
+
* Can be combined with the `[clrWizardPreventDefaultNext]` input to create
|
|
1248
|
+
* wizard-level custom navigation routines, which are useful for validation.
|
|
1249
|
+
*/
|
|
1250
|
+
onMoveNext: EventEmitter<any>;
|
|
1251
|
+
/**
|
|
1252
|
+
* Emits when the wizard moves to the previous page. Can be useful for validation.
|
|
1253
|
+
* Listen via `(clrWizardOnPrevious)` event.
|
|
1254
|
+
*/
|
|
1255
|
+
onMovePrevious: EventEmitter<any>;
|
|
1256
|
+
pageTitle: ElementRef<HTMLElement>;
|
|
1257
|
+
pages: QueryList<ClrWizardPage>;
|
|
1258
|
+
wizardButtons: QueryList<ClrWizardButton>;
|
|
1259
|
+
headerActions: QueryList<ClrWizardHeaderAction>;
|
|
1260
|
+
_open: boolean;
|
|
1261
|
+
wizardId: string;
|
|
1262
|
+
protected wizardTitle: ClrWizardTitle;
|
|
1263
|
+
protected ClrWizardFooterAlign: typeof ClrWizardFooterAlign;
|
|
1264
|
+
protected ClrWizardStepnavLayout: typeof ClrWizardStepnavLayout;
|
|
1265
|
+
private readonly bodyElementRef;
|
|
1266
|
+
private _forceForward;
|
|
1267
|
+
private _stopNext;
|
|
1268
|
+
private _stopCancel;
|
|
1269
|
+
private _stopNavigation;
|
|
1270
|
+
private _disableStepnav;
|
|
1271
|
+
private differ;
|
|
1272
|
+
private subscriptions;
|
|
1273
|
+
constructor(platformId: any, commonStrings: ClrCommonStringsService, navService: WizardNavigationService, pageCollection: PageCollectionService, buttonService: ButtonHubService, headerActionService: HeaderActionService, elementRef: ElementRef<HTMLElement>, differs: IterableDiffers);
|
|
1274
|
+
/**
|
|
1275
|
+
* Resets page completed states when navigating backwards.
|
|
1276
|
+
* Set using `[clrWizardForceForwardNavigation]` input.
|
|
1277
|
+
*/
|
|
1278
|
+
get forceForward(): boolean;
|
|
1279
|
+
set forceForward(value: boolean);
|
|
1280
|
+
/**
|
|
1281
|
+
* Toggles open/close of the wizard component.
|
|
1282
|
+
* Set using the `[clrWizardOpen]` input.
|
|
1283
|
+
*/
|
|
1284
|
+
set clrWizardOpen(open: boolean);
|
|
1285
|
+
/**
|
|
1286
|
+
* Prevents ClrWizard from moving to the next page or closing itself on finishing.
|
|
1287
|
+
* Set using the `[clrWizardPreventDefaultNext]` input. Note that using stopNext
|
|
1288
|
+
* will require you to create your own calls to .next() and .finish() in your
|
|
1289
|
+
* host component to make the ClrWizard work as expected.
|
|
1290
|
+
*/
|
|
1291
|
+
get stopNext(): boolean;
|
|
1292
|
+
set stopNext(value: boolean);
|
|
1293
|
+
/**
|
|
1294
|
+
* Prevents ClrWizard from closing when the cancel button or close "X" is clicked.
|
|
1295
|
+
* Set using the `[clrWizardPreventDefaultCancel]` input.
|
|
1296
|
+
*
|
|
1297
|
+
* Note that using stopCancel will require you to create your own calls to `close()` in your host compone`nt
|
|
1298
|
+
* to make the ClrWizard work as expected. Useful for doing checks or prompts
|
|
1299
|
+
* before closing a ClrWizard.
|
|
1300
|
+
*/
|
|
1301
|
+
get stopCancel(): boolean;
|
|
1302
|
+
set stopCancel(value: boolean);
|
|
1303
|
+
/**
|
|
1304
|
+
* Prevents ClrWizard from performing any form of navigation away from the current
|
|
1305
|
+
* page. Set using the `[clrWizardPreventNavigation]` input.
|
|
1306
|
+
* Note that stopNavigation is meant to freeze the wizard in place, typically
|
|
1307
|
+
* during a long validation or background action where you want the wizard to
|
|
1308
|
+
* display loading content but not allow the user to execute navigation in
|
|
1309
|
+
* the stepnav, close X, or the back, finish, or next buttons.
|
|
1310
|
+
*/
|
|
1311
|
+
get stopNavigation(): boolean;
|
|
1312
|
+
set stopNavigation(value: boolean);
|
|
1313
|
+
/**
|
|
1314
|
+
* Prevents clicks on the links in the stepnav from working.
|
|
1315
|
+
* Set using `[clrWizardDisableStepnav]` input.
|
|
1316
|
+
* A more granular bypassing of navigation which can be useful when your
|
|
1317
|
+
* ClrWizard is in a state of completion and you don't want users to be
|
|
1318
|
+
* able to jump backwards and change things.
|
|
1319
|
+
*/
|
|
1320
|
+
get disableStepnav(): boolean;
|
|
1321
|
+
set disableStepnav(value: boolean);
|
|
1322
|
+
get currentPage(): ClrWizardPage;
|
|
1323
|
+
set currentPage(page: ClrWizardPage);
|
|
1324
|
+
get isLast(): boolean;
|
|
1325
|
+
get isFirst(): boolean;
|
|
1326
|
+
get isInline(): boolean;
|
|
1327
|
+
get showHeader(): boolean;
|
|
1328
|
+
get showFooter(): boolean;
|
|
1329
|
+
get footerAlign(): ClrWizardFooterAlign;
|
|
1330
|
+
get stopModalAnimations(): boolean;
|
|
1331
|
+
ngAfterContentInit(): void;
|
|
1332
|
+
ngDoCheck(): void;
|
|
1333
|
+
ngOnDestroy(): void;
|
|
1334
|
+
/**
|
|
1335
|
+
* Marks Wizard as finished. By default it does not execute event
|
|
1336
|
+
* emissions or checks before completing and closing. This method is commonly
|
|
1337
|
+
* used as part of an alternative navigation with `[clrWizardPreventDefaultNext]`.
|
|
1338
|
+
*
|
|
1339
|
+
* If `skipChecksAndEmits` is true, the wizard will complete and close
|
|
1340
|
+
* regardless of the state of its current page. This is useful for alternative
|
|
1341
|
+
* navigation where event emissions have already been done and firing them again
|
|
1342
|
+
* may cause an event loop.
|
|
1343
|
+
*/
|
|
1344
|
+
finish(skipChecksAndEmits?: boolean): void;
|
|
1345
|
+
/**
|
|
1346
|
+
* Marks the wizard as finished but does run checks and emissions.
|
|
1347
|
+
* Good for a last step in an alternate workflow. Does the same thing as
|
|
1348
|
+
* calling `ClrWizard.finish(true)` or `ClrWizard.finish()` without a parameter.
|
|
1349
|
+
*/
|
|
1350
|
+
forceFinish(): void;
|
|
1351
|
+
/**
|
|
1352
|
+
* Opens the wizard. If there is no current page defined, sets the first page in the wizard to be current.
|
|
1353
|
+
*/
|
|
1354
|
+
open(): void;
|
|
1355
|
+
/**
|
|
1356
|
+
* Closes the wizard. Call this directly instead of `cancel()` to implement alternative cancel functionality.
|
|
1357
|
+
*/
|
|
1358
|
+
close(): void;
|
|
1359
|
+
/**
|
|
1360
|
+
* Used to open and close the wizard. By default the wizard will
|
|
1361
|
+
* close if invoked with no parameter. If parameter is true wizard will open
|
|
1362
|
+
* else if false will close.
|
|
1363
|
+
*/
|
|
1364
|
+
toggle(open: boolean): void;
|
|
1365
|
+
/**
|
|
1366
|
+
* Moves the wizard to the previous page.
|
|
1367
|
+
*/
|
|
1368
|
+
previous(): void;
|
|
1369
|
+
/**
|
|
1370
|
+
* By default, `next()` does not execute event emissions.
|
|
1371
|
+
* This method is commonly called as part of an alternative navigation
|
|
1372
|
+
* with `[clrWizardPreventDefaultNext]`. The wizard will move to the next page
|
|
1373
|
+
* regardless of the state of its current page. This is useful for alternative
|
|
1374
|
+
* navigation where event emissions have already been done and firing them again
|
|
1375
|
+
* may cause an event loop.
|
|
1376
|
+
*
|
|
1377
|
+
* If `skipChecksAndEmits` is false, the wizard will execute default checks
|
|
1378
|
+
* and emit events as normal. This is useful for custom buttons or programmatic
|
|
1379
|
+
* workflows that are not executing the wizards default checks and emissions.
|
|
1380
|
+
* It is another way to navigate without having to rewrite the wizard’s default
|
|
1381
|
+
* functionality from scratch.
|
|
1382
|
+
*/
|
|
1383
|
+
next(skipChecksAndEmits?: boolean): void;
|
|
1384
|
+
/**
|
|
1385
|
+
* Moves the wizard to the next page without the checks and emissions.
|
|
1386
|
+
* Good for a last step in an alternate workflow.
|
|
1387
|
+
* Alias for `ClrWizard.next(true)` or `ClrWizard.next()`
|
|
1388
|
+
*/
|
|
1389
|
+
forceNext(): void;
|
|
1390
|
+
/**
|
|
1391
|
+
* Cancels and closes the wizard. Do not use this for an override of the cancel
|
|
1392
|
+
* the functionality with `[clrWizardPreventDefaultCancel]`, `[clrWizardPreventPageDefaultCancel]`,
|
|
1393
|
+
* or `[clrWizardPagePreventDefault]` because it will initiate the same checks
|
|
1394
|
+
* and event emissions that invoked your event handler. Use `ClrWizard.close()` instead.
|
|
1395
|
+
*/
|
|
1396
|
+
cancel(): void;
|
|
1397
|
+
/**
|
|
1398
|
+
* Overrides behavior of the underlying modal to avoid collisions with
|
|
1399
|
+
* alternative cancel functionality. In most cases, use `ClrWizard.cancel()` instead.
|
|
1400
|
+
*/
|
|
1401
|
+
modalCancel(): void;
|
|
1402
|
+
/**
|
|
1403
|
+
* Checks for alternative cancel flows defined at the current page or
|
|
1404
|
+
* wizard level. Performs a canceled if not. Emits events that initiate
|
|
1405
|
+
* the alternative cancel outputs `(clrWizardPageOnCancel)` and `(clrWizardOnCancel)`.
|
|
1406
|
+
*/
|
|
1407
|
+
checkAndCancel(): void;
|
|
1408
|
+
/**
|
|
1409
|
+
* Navigates to a given page in the Wizard. Navigation will invoke the wizard’s default
|
|
1410
|
+
* checks and event emissions.
|
|
1411
|
+
*
|
|
1412
|
+
* The format of the expected ID parameter can be found in the return of the
|
|
1413
|
+
* ClrWizardPage.id getter, usually prefixed with `clr-wizard-page-` and then either a
|
|
1414
|
+
* numeric ID or the ID specified for the `ClrWizardPage` component’s `id` input.
|
|
1415
|
+
*/
|
|
1416
|
+
goTo(pageId: string): void;
|
|
1417
|
+
/**
|
|
1418
|
+
* Reset sets all WizardPages to incomplete and sets the first page in the `ClrWizard` to
|
|
1419
|
+
* be the current page, resetting the wizard navigation.
|
|
1420
|
+
* Use `(clrWizardOnReset)` event to reset the data or model of your wizard.
|
|
1421
|
+
*/
|
|
1422
|
+
reset(): void;
|
|
1423
|
+
private listenForNextPageChanges;
|
|
1424
|
+
private listenForPreviousPageChanges;
|
|
1425
|
+
private listenForCancelChanges;
|
|
1426
|
+
private listenForFinishedChanges;
|
|
1427
|
+
private listenForPageChanges;
|
|
1428
|
+
private updateNavOnPageChanges;
|
|
1429
|
+
private initializeButtons;
|
|
1430
|
+
private emitWizardFinished;
|
|
1431
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<ClrWizard, never>;
|
|
1432
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<ClrWizard, "clr-wizard", never, { "stepnavAriaLabel": { "alias": "clrWizardStepnavAriaLabel"; "required": false; }; "stepnavLayout": { "alias": "clrWizardStepnavLayout"; "required": false; }; "size": { "alias": "clrWizardSize"; "required": false; }; "inPage": { "alias": "clrWizardInPage"; "required": false; }; "inPageFillContentArea": { "alias": "clrWizardInPageFillContentArea"; "required": false; }; "hideFooter": { "alias": "clrWizardHideFooter"; "required": false; }; "_footerAlign": { "alias": "clrWizardFooterAlign"; "required": false; }; "closable": { "alias": "clrWizardClosable"; "required": false; }; "_stopModalAnimations": { "alias": "clrWizardPreventModalAnimation"; "required": false; }; "forceForward": { "alias": "clrWizardForceForwardNavigation"; "required": false; }; "clrWizardOpen": { "alias": "clrWizardOpen"; "required": false; }; "stopNext": { "alias": "clrWizardPreventDefaultNext"; "required": false; }; "stopCancel": { "alias": "clrWizardPreventDefaultCancel"; "required": false; }; "stopNavigation": { "alias": "clrWizardPreventNavigation"; "required": false; }; "disableStepnav": { "alias": "clrWizardDisableStepnav"; "required": false; }; }, { "_openChanged": "clrWizardOpenChange"; "onCancel": "clrWizardOnCancel"; "wizardFinished": "clrWizardOnFinish"; "onReset": "clrWizardOnReset"; "currentPageChange": "clrWizardCurrentPageChange"; "onMoveNext": "clrWizardOnNext"; "onMovePrevious": "clrWizardOnPrevious"; }, ["wizardTitle", "pages", "wizardButtons", "headerActions"], ["*", "clr-wizard-button", "clr-wizard-title", "clr-wizard-header-action"], false, never>;
|
|
1433
|
+
static ngAcceptInputType_stepnavLayout: ClrWizardStepnavLayout | string;
|
|
1434
|
+
static ngAcceptInputType__footerAlign: ClrWizardFooterAlign | string;
|
|
1435
|
+
}
|
|
1436
|
+
|
|
1437
|
+
declare class ClrWizardStepnav implements AfterViewInit, OnDestroy {
|
|
1438
|
+
pageService: PageCollectionService;
|
|
1439
|
+
private navService;
|
|
1440
|
+
private elementRef;
|
|
1441
|
+
label: string;
|
|
1442
|
+
protected showScrollLeftButton: boolean;
|
|
1443
|
+
protected showScrollRightButton: boolean;
|
|
1444
|
+
private readonly stepnavItems;
|
|
1445
|
+
private subscription;
|
|
1446
|
+
private intersectionObserver;
|
|
1447
|
+
private firstItemVisible;
|
|
1448
|
+
private lastItemVisible;
|
|
1449
|
+
constructor(pageService: PageCollectionService, navService: WizardNavigationService, elementRef: ElementRef<HTMLElement>);
|
|
1450
|
+
protected get stepnavLayout(): ClrWizardStepnavLayout;
|
|
1451
|
+
ngAfterViewInit(): void;
|
|
1452
|
+
ngOnDestroy(): void;
|
|
1453
|
+
protected scrollLeft(): void;
|
|
1454
|
+
protected scrollRight(): void;
|
|
1455
|
+
private setupIntersectionObserver;
|
|
1456
|
+
private observeEdgeItems;
|
|
1457
|
+
private scroll;
|
|
1458
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<ClrWizardStepnav, never>;
|
|
1459
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<ClrWizardStepnav, "clr-wizard-stepnav", never, { "label": { "alias": "label"; "required": false; }; }, {}, never, never, false, never>;
|
|
1460
|
+
}
|
|
1461
|
+
|
|
1462
|
+
declare class ClrWizardStepnavItem implements OnInit, OnDestroy {
|
|
1463
|
+
navService: WizardNavigationService;
|
|
1464
|
+
pageCollection: PageCollectionService;
|
|
1465
|
+
commonStrings: ClrCommonStringsService;
|
|
1466
|
+
readonly elementRef: ElementRef<HTMLElement>;
|
|
1467
|
+
page: ClrWizardPage;
|
|
1468
|
+
private subscription;
|
|
1469
|
+
/**
|
|
1470
|
+
* This is used to prevent the steps from scrolling as the user clicks on the steps.
|
|
1471
|
+
*/
|
|
1472
|
+
private skipNextScroll;
|
|
1473
|
+
constructor(navService: WizardNavigationService, pageCollection: PageCollectionService, commonStrings: ClrCommonStringsService, elementRef: ElementRef<HTMLElement>);
|
|
1474
|
+
get id(): string;
|
|
1475
|
+
get stepAriaCurrent(): string;
|
|
1476
|
+
get isDisabled(): boolean;
|
|
1477
|
+
get isCurrent(): boolean;
|
|
1478
|
+
get isComplete(): boolean;
|
|
1479
|
+
get hasError(): boolean;
|
|
1480
|
+
get canNavigate(): boolean;
|
|
1481
|
+
protected get stepIconId(): string;
|
|
1482
|
+
protected get stepTextId(): string;
|
|
1483
|
+
protected get stepNumberId(): string;
|
|
1484
|
+
protected get stepTitleId(): string;
|
|
1485
|
+
protected get labelledby(): string;
|
|
1486
|
+
protected get icon(): {
|
|
1487
|
+
shape: string;
|
|
1488
|
+
label: string;
|
|
1489
|
+
} | null;
|
|
1490
|
+
ngOnInit(): void;
|
|
1491
|
+
ngOnDestroy(): void;
|
|
1492
|
+
click(): void;
|
|
1493
|
+
protected scrollIntoView(): void;
|
|
1494
|
+
private pageGuard;
|
|
1495
|
+
private ensureCurrentStepIsScrolledIntoView;
|
|
1496
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<ClrWizardStepnavItem, never>;
|
|
1497
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<ClrWizardStepnavItem, "[clr-wizard-stepnav-item]", never, { "page": { "alias": "page"; "required": false; }; }, {}, never, ["*"], false, never>;
|
|
1498
|
+
}
|
|
1499
|
+
|
|
1500
|
+
declare const CLR_WIZARD_DIRECTIVES: any[];
|
|
1501
|
+
declare class ClrWizardModule {
|
|
1502
|
+
constructor();
|
|
1503
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<ClrWizardModule, never>;
|
|
1504
|
+
static ɵmod: i0.ɵɵNgModuleDeclaration<ClrWizardModule, [typeof ClrWizard, typeof ClrWizardPage, typeof ClrWizardStepnav, typeof ClrWizardStepnavItem, typeof ClrWizardButton, typeof ClrWizardHeaderAction, typeof ClrWizardTitle, typeof ClrWizardPageTitle, typeof ClrWizardPageNavTitle, typeof ClrWizardPageButtons, typeof ClrWizardPageHeaderActions], [typeof i12.CommonModule, typeof i13.ClrIcon, typeof i14.ClrModalModule, typeof i15.ClrAlertModule], [typeof ClrWizard, typeof ClrWizardPage, typeof ClrWizardStepnav, typeof ClrWizardStepnavItem, typeof ClrWizardButton, typeof ClrWizardHeaderAction, typeof ClrWizardTitle, typeof ClrWizardPageTitle, typeof ClrWizardPageNavTitle, typeof ClrWizardPageButtons, typeof ClrWizardPageHeaderActions]>;
|
|
1505
|
+
static ɵinj: i0.ɵɵInjectorDeclaration<ClrWizardModule>;
|
|
1506
|
+
}
|
|
1507
|
+
|
|
1508
|
+
export { CLR_WIZARD_DIRECTIVES, CUSTOM_BUTTON_TYPES, ClrWizard, ClrWizardButton, ClrWizardFooterAlign, ClrWizardHeaderAction, ClrWizardModule, ClrWizardPage, ClrWizardPageButtons, ClrWizardPageHeaderActions, ClrWizardPageNavTitle, ClrWizardPageTitle, ClrWizardStepnav, ClrWizardStepnavItem, ClrWizardStepnavLayout, ClrWizardTitle, DEFAULT_BUTTON_TYPES, footerAlignAttribute, stepnavLayoutAttribute };
|