@skyux/tabs 12.23.0 → 13.0.0-alpha.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/fesm2022/skyux-tabs-testing.mjs.map +1 -1
- package/fesm2022/skyux-tabs.mjs +75 -75
- package/fesm2022/skyux-tabs.mjs.map +1 -1
- package/index.d.ts +835 -20
- package/package.json +16 -16
- package/testing/index.d.ts +623 -3
- package/lib/modules/sectioned-form/sectioned-form-section.component.d.ts +0 -35
- package/lib/modules/sectioned-form/sectioned-form.component.d.ts +0 -48
- package/lib/modules/sectioned-form/sectioned-form.module.d.ts +0 -12
- package/lib/modules/sectioned-form/sectioned-form.service.d.ts +0 -24
- package/lib/modules/sectioned-form/types/sectioned-form-message-type.d.ts +0 -3
- package/lib/modules/sectioned-form/types/sectioned-form-message.d.ts +0 -4
- package/lib/modules/shared/sky-tabs-resources.module.d.ts +0 -10
- package/lib/modules/shared/tab-id.service.d.ts +0 -24
- package/lib/modules/tabs/tab-button-adapter.service.d.ts +0 -10
- package/lib/modules/tabs/tab-button-view-model.d.ts +0 -17
- package/lib/modules/tabs/tab-button.component.d.ts +0 -43
- package/lib/modules/tabs/tab-index.d.ts +0 -1
- package/lib/modules/tabs/tab-layout-type.d.ts +0 -1
- package/lib/modules/tabs/tab.component.d.ts +0 -90
- package/lib/modules/tabs/tabs.module.d.ts +0 -17
- package/lib/modules/tabs/tabset-active-tab-change-args.d.ts +0 -5
- package/lib/modules/tabs/tabset-active-tab-unregistered-args.d.ts +0 -10
- package/lib/modules/tabs/tabset-adapter.service.d.ts +0 -19
- package/lib/modules/tabs/tabset-buttons-display-mode.d.ts +0 -1
- package/lib/modules/tabs/tabset-nav-button-disabled.pipe.d.ts +0 -8
- package/lib/modules/tabs/tabset-nav-button-type.d.ts +0 -4
- package/lib/modules/tabs/tabset-nav-button.component.d.ts +0 -47
- package/lib/modules/tabs/tabset-permalink.service.d.ts +0 -35
- package/lib/modules/tabs/tabset-style.d.ts +0 -1
- package/lib/modules/tabs/tabset-tab-indexes-change.d.ts +0 -7
- package/lib/modules/tabs/tabset.component.d.ts +0 -97
- package/lib/modules/tabs/tabset.service.d.ts +0 -65
- package/lib/modules/vertical-tabset/vertical-tab.component.d.ts +0 -86
- package/lib/modules/vertical-tabset/vertical-tabset-adapter.service.d.ts +0 -12
- package/lib/modules/vertical-tabset/vertical-tabset-group-message.d.ts +0 -3
- package/lib/modules/vertical-tabset/vertical-tabset-group.component.d.ts +0 -38
- package/lib/modules/vertical-tabset/vertical-tabset-group.service.d.ts +0 -11
- package/lib/modules/vertical-tabset/vertical-tabset.component.d.ts +0 -71
- package/lib/modules/vertical-tabset/vertical-tabset.module.d.ts +0 -15
- package/lib/modules/vertical-tabset/vertical-tabset.service.d.ts +0 -40
- package/testing/legacy/tabs/tab-fixture-tab.d.ts +0 -26
- package/testing/legacy/tabs/tabset-fixture.d.ts +0 -45
- package/testing/modules/sectioned-form/sectioned-form-harness-filters.d.ts +0 -6
- package/testing/modules/sectioned-form/sectioned-form-harness.d.ts +0 -33
- package/testing/modules/sectioned-form/sectioned-form-section-content-harness-filters.d.ts +0 -6
- package/testing/modules/sectioned-form/sectioned-form-section-content-harness.d.ts +0 -17
- package/testing/modules/sectioned-form/sectioned-form-section-harness-filters.d.ts +0 -10
- package/testing/modules/sectioned-form/sectioned-form-section-harness.d.ts +0 -59
- package/testing/modules/tabs/tab-button-harness-filters.d.ts +0 -10
- package/testing/modules/tabs/tab-button-harness.d.ts +0 -56
- package/testing/modules/tabs/tab-content-harness-filters.d.ts +0 -11
- package/testing/modules/tabs/tab-content-harness.d.ts +0 -31
- package/testing/modules/tabs/tabset-harness-filters.d.ts +0 -6
- package/testing/modules/tabs/tabset-harness.d.ts +0 -69
- package/testing/modules/tabs/tabset-nav-button-harness-filters.d.ts +0 -11
- package/testing/modules/tabs/tabset-nav-button-harness.d.ts +0 -35
- package/testing/modules/vertical-tabset/vertical-tab-button-harness-filters.d.ts +0 -10
- package/testing/modules/vertical-tabset/vertical-tab-button-harness.d.ts +0 -48
- package/testing/modules/vertical-tabset/vertical-tab-content-harness-filters.d.ts +0 -11
- package/testing/modules/vertical-tabset/vertical-tab-content-harness.d.ts +0 -26
- package/testing/modules/vertical-tabset/vertical-tabset-group-harness-filters.d.ts +0 -10
- package/testing/modules/vertical-tabset/vertical-tabset-group-harness.d.ts +0 -48
- package/testing/modules/vertical-tabset/vertical-tabset-harness-filters.d.ts +0 -6
- package/testing/modules/vertical-tabset/vertical-tabset-harness.d.ts +0 -69
- package/testing/public-api.d.ts +0 -24
package/index.d.ts
CHANGED
|
@@ -1,20 +1,835 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
1
|
+
import * as i0 from '@angular/core';
|
|
2
|
+
import { ElementRef, OnInit, OnDestroy, ChangeDetectorRef, QueryList, AfterViewChecked, EventEmitter, AfterViewInit, OnChanges, SimpleChanges, PipeTransform } from '@angular/core';
|
|
3
|
+
import * as i6 from '@skyux/core';
|
|
4
|
+
import { SkyLogService } from '@skyux/core';
|
|
5
|
+
import { Observable, Subject, BehaviorSubject, ReplaySubject } from 'rxjs';
|
|
6
|
+
import * as i4 from '@angular/common';
|
|
7
|
+
import * as i4$1 from '@skyux/forms';
|
|
8
|
+
import * as i9 from '@skyux/theme';
|
|
9
|
+
import * as i1 from '@skyux/i18n';
|
|
10
|
+
import { SkyLibResourcesService } from '@skyux/i18n';
|
|
11
|
+
import * as i5 from '@skyux/icon';
|
|
12
|
+
import * as i7 from '@skyux/indicators';
|
|
13
|
+
import * as i8 from '@skyux/popovers';
|
|
14
|
+
|
|
15
|
+
/**
|
|
16
|
+
* Tracks the element IDs for all tabs within a tablist.
|
|
17
|
+
* @internal
|
|
18
|
+
*/
|
|
19
|
+
declare class SkyTabIdService {
|
|
20
|
+
#private;
|
|
21
|
+
get ids(): Observable<string[]>;
|
|
22
|
+
constructor();
|
|
23
|
+
/**
|
|
24
|
+
* Associates a tab's ID with its parent tablist.
|
|
25
|
+
* @param {string} id A unique ID for the tab's registration.
|
|
26
|
+
* @param {string} elementId The ID applied to the tab's element.
|
|
27
|
+
*/
|
|
28
|
+
register(id: string, elementId: string): void;
|
|
29
|
+
/**
|
|
30
|
+
* Disassociates a tab's ID with its parent tablist.
|
|
31
|
+
* @param {string} id The ID used to register the tab.
|
|
32
|
+
*/
|
|
33
|
+
unregister(id: string): void;
|
|
34
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyTabIdService, never>;
|
|
35
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<SkyTabIdService>;
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
declare class SkyVerticalTabsetAdapterService {
|
|
39
|
+
#private;
|
|
40
|
+
scrollToContentTop(element: ElementRef): void;
|
|
41
|
+
focusButton(elRef: ElementRef<HTMLElement> | undefined): boolean;
|
|
42
|
+
focusFirstButton(tabGroups: ElementRef<HTMLElement> | undefined): void;
|
|
43
|
+
focusNextButton(tabGroups: ElementRef | undefined): void;
|
|
44
|
+
focusPreviousButton(tabGroups: ElementRef | undefined): void;
|
|
45
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyVerticalTabsetAdapterService, never>;
|
|
46
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<SkyVerticalTabsetAdapterService>;
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
interface SkyVerticalTabsetGroupMessage {
|
|
50
|
+
messageType: 'focus';
|
|
51
|
+
}
|
|
52
|
+
|
|
53
|
+
/**
|
|
54
|
+
* @internal
|
|
55
|
+
*/
|
|
56
|
+
declare class SkyVerticalTabsetGroupService {
|
|
57
|
+
messageStream: Subject<SkyVerticalTabsetGroupMessage>;
|
|
58
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyVerticalTabsetGroupService, never>;
|
|
59
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<SkyVerticalTabsetGroupService>;
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
declare class SkyVerticalTabComponent implements OnInit, OnDestroy {
|
|
63
|
+
#private;
|
|
64
|
+
/**
|
|
65
|
+
* Whether the tab is active when the tabset loads.
|
|
66
|
+
* @default false
|
|
67
|
+
*/
|
|
68
|
+
set active(value: boolean | undefined);
|
|
69
|
+
get active(): boolean;
|
|
70
|
+
/**
|
|
71
|
+
* The HTML element ID of the element that contains
|
|
72
|
+
* the content that the vertical tab displays, which corresponds to the `tabId`. This property
|
|
73
|
+
* [supports accessibility rules for disclosures](https://www.w3.org/TR/wai-aria-practices-1.1/#disclosure).
|
|
74
|
+
* For more information about the `aria-controls` attribute, see the [WAI-ARIA definition](https://www.w3.org/TR/wai-aria/#aria-controls).
|
|
75
|
+
* @deprecated Now that the vertical tabs provide aria labels automatically, this input is no longer necessary.
|
|
76
|
+
*/
|
|
77
|
+
ariaControls: string | undefined;
|
|
78
|
+
/**
|
|
79
|
+
* The ARIA role for the vertical tab
|
|
80
|
+
* [to support accessibility](https://developer.blackbaud.com/skyux/learn/accessibility)
|
|
81
|
+
* by indicating how the tab functions and what it controls. For information about how
|
|
82
|
+
* an ARIA role indicates what an item represents on a web page, see the
|
|
83
|
+
* [WAI-ARIA roles model](https://www.w3.org/WAI/PF/aria/#roles).
|
|
84
|
+
* @default "tab"
|
|
85
|
+
* @deprecated Any other value than `tab` could lead to a poor user experience for users with assistive technology.
|
|
86
|
+
* In the next major version, this property will be automatically set to `tab`.
|
|
87
|
+
*/
|
|
88
|
+
get ariaRole(): string;
|
|
89
|
+
set ariaRole(value: string | undefined);
|
|
90
|
+
/**
|
|
91
|
+
* Whether to disable the tab.
|
|
92
|
+
*/
|
|
93
|
+
disabled: boolean | undefined;
|
|
94
|
+
/**
|
|
95
|
+
* Whether to indicate that the tab has an error.
|
|
96
|
+
* @internal This is used for sectioned forms and is not currently a supported design for pure vertical tabs.
|
|
97
|
+
*/
|
|
98
|
+
errorIndicator: boolean | undefined;
|
|
99
|
+
/**
|
|
100
|
+
* Whether to indicate that the tab has required content.
|
|
101
|
+
* @internal This is used for sectioned forms and is not currently a supported design for pure vertical tabs.
|
|
102
|
+
*/
|
|
103
|
+
requiredIndicator: boolean | undefined;
|
|
104
|
+
/**
|
|
105
|
+
* Displays an item count alongside the tab header to indicate how many list items the tab contains.
|
|
106
|
+
*/
|
|
107
|
+
tabHeaderCount: number | undefined;
|
|
108
|
+
/**
|
|
109
|
+
* The tab header.
|
|
110
|
+
* @required
|
|
111
|
+
*/
|
|
112
|
+
tabHeading: string | undefined;
|
|
113
|
+
/**
|
|
114
|
+
* Whether to display a chevron-right icon on the right hand side of the tab.
|
|
115
|
+
* @internal
|
|
116
|
+
*/
|
|
117
|
+
showTabRightArrow: boolean | undefined;
|
|
118
|
+
/**
|
|
119
|
+
* The ID for the tab.
|
|
120
|
+
* @deprecated Now that the vertical tabs provide aria labels automatically, this input is no longer necessary.
|
|
121
|
+
*/
|
|
122
|
+
set tabId(value: string | undefined);
|
|
123
|
+
get tabId(): string;
|
|
124
|
+
set contentRendered(value: boolean);
|
|
125
|
+
get contentRendered(): boolean;
|
|
126
|
+
index: number | undefined;
|
|
127
|
+
isMobile: boolean;
|
|
128
|
+
tabButton: ElementRef | undefined;
|
|
129
|
+
tabContent: ElementRef | undefined;
|
|
130
|
+
groupService: SkyVerticalTabsetGroupService | null;
|
|
131
|
+
constructor(adapterService: SkyVerticalTabsetAdapterService, changeRef: ChangeDetectorRef, tabsetService: SkyVerticalTabsetService, tabIdSvc?: SkyTabIdService);
|
|
132
|
+
ngOnInit(): void;
|
|
133
|
+
ngOnDestroy(): void;
|
|
134
|
+
activateTab(): void;
|
|
135
|
+
focusButton(): void;
|
|
136
|
+
tabButtonActivate(event: Event): void;
|
|
137
|
+
tabButtonArrowLeft(event: Event): void;
|
|
138
|
+
tabDeactivated(): void;
|
|
139
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyVerticalTabComponent, [null, null, null, { optional: true; }]>;
|
|
140
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<SkyVerticalTabComponent, "sky-vertical-tab", never, { "active": { "alias": "active"; "required": false; }; "ariaControls": { "alias": "ariaControls"; "required": false; }; "ariaRole": { "alias": "ariaRole"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; "errorIndicator": { "alias": "errorIndicator"; "required": false; }; "requiredIndicator": { "alias": "requiredIndicator"; "required": false; }; "tabHeaderCount": { "alias": "tabHeaderCount"; "required": false; }; "tabHeading": { "alias": "tabHeading"; "required": false; }; "showTabRightArrow": { "alias": "showTabRightArrow"; "required": false; }; "tabId": { "alias": "tabId"; "required": false; }; }, {}, never, ["*"], false, never>;
|
|
141
|
+
}
|
|
142
|
+
|
|
143
|
+
declare class SkyVerticalTabsetGroupComponent implements OnInit, OnDestroy {
|
|
144
|
+
#private;
|
|
145
|
+
/**
|
|
146
|
+
* Whether to disable the ability to expand and collapse the group.
|
|
147
|
+
* @default false
|
|
148
|
+
*/
|
|
149
|
+
set disabled(value: boolean | undefined);
|
|
150
|
+
get disabled(): boolean | undefined;
|
|
151
|
+
/**
|
|
152
|
+
* The header for the collapsible group of tabs.
|
|
153
|
+
*/
|
|
154
|
+
groupHeading: string | undefined;
|
|
155
|
+
/**
|
|
156
|
+
* Whether the collapsible group is expanded.
|
|
157
|
+
* @default false
|
|
158
|
+
*/
|
|
159
|
+
set open(value: boolean | undefined);
|
|
160
|
+
get open(): boolean | undefined;
|
|
161
|
+
tabs: QueryList<SkyVerticalTabComponent> | undefined;
|
|
162
|
+
groupHeadingButton: ElementRef | undefined;
|
|
163
|
+
animationDisabled: boolean;
|
|
164
|
+
slideDirection: 'down' | 'up' | 'void';
|
|
165
|
+
protected groupId: string;
|
|
166
|
+
constructor(tabService: SkyVerticalTabsetService, changeRef: ChangeDetectorRef);
|
|
167
|
+
ngOnInit(): void;
|
|
168
|
+
ngOnDestroy(): void;
|
|
169
|
+
updateSlideDirection(event: any): void;
|
|
170
|
+
toggleMenuOpen(): void;
|
|
171
|
+
protected groupButtonArrowLeft(event: Event): void;
|
|
172
|
+
protected groupButtonArrowRight(event: Event): void;
|
|
173
|
+
isActive(): boolean;
|
|
174
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyVerticalTabsetGroupComponent, never>;
|
|
175
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<SkyVerticalTabsetGroupComponent, "sky-vertical-tabset-group", never, { "disabled": { "alias": "disabled"; "required": false; }; "groupHeading": { "alias": "groupHeading"; "required": false; }; "open": { "alias": "open"; "required": false; }; }, {}, ["tabs"], ["*"], false, never>;
|
|
176
|
+
}
|
|
177
|
+
|
|
178
|
+
/**
|
|
179
|
+
* @internal
|
|
180
|
+
*/
|
|
181
|
+
declare class SkyVerticalTabsetService {
|
|
182
|
+
#private;
|
|
183
|
+
activeIndex: number | undefined;
|
|
184
|
+
animationContentVisibleState: string | undefined;
|
|
185
|
+
animationTabsVisibleState: string | undefined;
|
|
186
|
+
content: ElementRef | undefined;
|
|
187
|
+
hidingTabs: BehaviorSubject<boolean>;
|
|
188
|
+
indexChanged: ReplaySubject<number | undefined>;
|
|
189
|
+
maintainTabContent: boolean | undefined;
|
|
190
|
+
showingTabs: BehaviorSubject<boolean>;
|
|
191
|
+
switchingMobile: Subject<boolean>;
|
|
192
|
+
tabs: SkyVerticalTabComponent[];
|
|
193
|
+
tabAdded: Subject<SkyVerticalTabComponent>;
|
|
194
|
+
tabClicked: ReplaySubject<boolean>;
|
|
195
|
+
constructor();
|
|
196
|
+
addTab(tab: SkyVerticalTabComponent): void;
|
|
197
|
+
destroyTab(tab: SkyVerticalTabComponent): void;
|
|
198
|
+
addGroup(group: SkyVerticalTabsetGroupComponent): void;
|
|
199
|
+
destroyGroup(group: SkyVerticalTabsetGroupComponent): void;
|
|
200
|
+
activateTab(tab: SkyVerticalTabComponent): void;
|
|
201
|
+
activeTab(): SkyVerticalTabComponent | undefined;
|
|
202
|
+
isMobile(): boolean;
|
|
203
|
+
updateContent(): void;
|
|
204
|
+
tabsVisible(): boolean;
|
|
205
|
+
contentVisible(): boolean;
|
|
206
|
+
showTabs(): void;
|
|
207
|
+
focusActiveTab(tabGroups: ElementRef | undefined): void;
|
|
208
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyVerticalTabsetService, never>;
|
|
209
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<SkyVerticalTabsetService>;
|
|
210
|
+
}
|
|
211
|
+
|
|
212
|
+
declare enum SkySectionedFormMessageType {
|
|
213
|
+
ShowTabs = 1
|
|
214
|
+
}
|
|
215
|
+
|
|
216
|
+
interface SkySectionedFormMessage {
|
|
217
|
+
type: SkySectionedFormMessageType;
|
|
218
|
+
}
|
|
219
|
+
|
|
220
|
+
/**
|
|
221
|
+
* Creates a container for the sectioned forms.
|
|
222
|
+
*/
|
|
223
|
+
declare class SkySectionedFormComponent implements OnInit, OnDestroy, AfterViewChecked {
|
|
224
|
+
#private;
|
|
225
|
+
tabService: SkyVerticalTabsetService;
|
|
226
|
+
/**
|
|
227
|
+
* Whether the sectioned form loads section content during initialization so that it
|
|
228
|
+
* displays content without moving around elements in the content container.
|
|
229
|
+
* @default false
|
|
230
|
+
*/
|
|
231
|
+
maintainSectionContent: boolean | undefined;
|
|
232
|
+
set messageStream(value: Subject<SkySectionedFormMessage> | undefined);
|
|
233
|
+
get messageStream(): Subject<SkySectionedFormMessage>;
|
|
234
|
+
/**
|
|
235
|
+
* Fires when the active tab changes and emits the index of the active
|
|
236
|
+
* section. The index is based on the section's position when the form loads.
|
|
237
|
+
*/
|
|
238
|
+
indexChanged: EventEmitter<number>;
|
|
239
|
+
/**
|
|
240
|
+
* Fires when the sectioned form tabs are shown or hidden.
|
|
241
|
+
*/
|
|
242
|
+
tabsVisibleChanged: EventEmitter<boolean>;
|
|
243
|
+
ariaOwns: string | undefined;
|
|
244
|
+
ariaRole: string | undefined;
|
|
245
|
+
content: ElementRef | undefined;
|
|
246
|
+
constructor(tabService: SkyVerticalTabsetService, changeRef: ChangeDetectorRef, tabIdSvc: SkyTabIdService, logger: SkyLogService);
|
|
247
|
+
ngOnInit(): void;
|
|
248
|
+
ngAfterViewChecked(): void;
|
|
249
|
+
ngOnDestroy(): void;
|
|
250
|
+
/**
|
|
251
|
+
* @deprecated Use the `tabsVisibleChanged` output to listen for tab visibility changes.
|
|
252
|
+
*/
|
|
253
|
+
tabsVisible(): boolean;
|
|
254
|
+
/**
|
|
255
|
+
* @deprecated Use the `messageStream` input and push a `ShowTabs` message to the message stream instead.
|
|
256
|
+
*/
|
|
257
|
+
showTabs(): void;
|
|
258
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkySectionedFormComponent, never>;
|
|
259
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<SkySectionedFormComponent, "sky-sectioned-form", never, { "maintainSectionContent": { "alias": "maintainSectionContent"; "required": false; }; "messageStream": { "alias": "messageStream"; "required": false; }; }, { "indexChanged": "indexChanged"; "tabsVisibleChanged": "tabsVisibleChanged"; }, never, ["*"], false, never>;
|
|
260
|
+
}
|
|
261
|
+
|
|
262
|
+
declare class SkySectionedFormService {
|
|
263
|
+
/**
|
|
264
|
+
* @internal
|
|
265
|
+
*/
|
|
266
|
+
invalidChange: BehaviorSubject<boolean | undefined>;
|
|
267
|
+
/**
|
|
268
|
+
* @internal
|
|
269
|
+
*/
|
|
270
|
+
requiredChange: BehaviorSubject<boolean | undefined>;
|
|
271
|
+
/**
|
|
272
|
+
* Sets the current section's invalid state based on the `isInvalid` parameter.
|
|
273
|
+
* This method is used within a `sky-sectioned-form-section` element.
|
|
274
|
+
*/
|
|
275
|
+
invalidFieldChanged(isInvalid: boolean | undefined): void;
|
|
276
|
+
/**
|
|
277
|
+
* Sets the current section's required state based on the `isRequired` parameter.
|
|
278
|
+
* This method is used within a `sky-sectioned-form-section` element.
|
|
279
|
+
*/
|
|
280
|
+
requiredFieldChanged(isRequired: boolean | undefined): void;
|
|
281
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkySectionedFormService, never>;
|
|
282
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<SkySectionedFormService>;
|
|
283
|
+
}
|
|
284
|
+
|
|
285
|
+
/**
|
|
286
|
+
* Creates an individual form to display as a section within the sectioned form.
|
|
287
|
+
*/
|
|
288
|
+
declare class SkySectionedFormSectionComponent implements OnInit, OnDestroy {
|
|
289
|
+
#private;
|
|
290
|
+
sectionTabId: string;
|
|
291
|
+
sectionContentId: string;
|
|
292
|
+
/**
|
|
293
|
+
* The section header.
|
|
294
|
+
* @required
|
|
295
|
+
*/
|
|
296
|
+
heading: string | undefined;
|
|
297
|
+
/**
|
|
298
|
+
* The number of items within the section. A counter appears beside the section header.
|
|
299
|
+
*/
|
|
300
|
+
itemCount: number | undefined;
|
|
301
|
+
/**
|
|
302
|
+
* Whether the section is active when the form loads.
|
|
303
|
+
* @default false
|
|
304
|
+
*/
|
|
305
|
+
active: boolean | undefined;
|
|
306
|
+
fieldRequired: boolean | undefined;
|
|
307
|
+
fieldInvalid: boolean | undefined;
|
|
308
|
+
tab: SkyVerticalTabComponent | undefined;
|
|
309
|
+
constructor(sectionedFormService: SkySectionedFormService, tabsetService: SkyVerticalTabsetService, changeRef: ChangeDetectorRef);
|
|
310
|
+
ngOnInit(): void;
|
|
311
|
+
ngOnDestroy(): void;
|
|
312
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkySectionedFormSectionComponent, never>;
|
|
313
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<SkySectionedFormSectionComponent, "sky-sectioned-form-section", never, { "heading": { "alias": "heading"; "required": false; }; "itemCount": { "alias": "itemCount"; "required": false; }; "active": { "alias": "active"; "required": false; }; }, {}, never, ["*"], false, never>;
|
|
314
|
+
}
|
|
315
|
+
|
|
316
|
+
declare class SkyVerticalTabsetComponent implements OnInit, AfterViewChecked, OnDestroy {
|
|
317
|
+
#private;
|
|
318
|
+
adapterService: SkyVerticalTabsetAdapterService;
|
|
319
|
+
tabService: SkyVerticalTabsetService;
|
|
320
|
+
tabIdSvc: SkyTabIdService;
|
|
321
|
+
/**
|
|
322
|
+
* The text to display on the show tabs button on mobile devices.
|
|
323
|
+
*/
|
|
324
|
+
showTabsText: string | undefined;
|
|
325
|
+
/**
|
|
326
|
+
* The ARIA label for the tabset. This sets the tabset's `aria-label` attribute to provide a text equivalent for screen readers
|
|
327
|
+
* [to support accessibility](https://developer.blackbaud.com/skyux/learn/accessibility).
|
|
328
|
+
* If the tabset includes a visible label, use `ariaLabelledBy` instead.
|
|
329
|
+
* For more information about the `aria-label` attribute, see the [WAI-ARIA definition](https://www.w3.org/TR/wai-aria/#aria-label).
|
|
330
|
+
*/
|
|
331
|
+
ariaLabel: string | undefined;
|
|
332
|
+
/**
|
|
333
|
+
* The HTML element ID of the element that labels
|
|
334
|
+
* the tabset. This sets the tabset's `aria-labelledby` attribute to provide a text equivalent for screen readers
|
|
335
|
+
* [to support accessibility](https://developer.blackbaud.com/skyux/learn/accessibility).
|
|
336
|
+
* If the tabset does not include a visible label, use `ariaLabel` instead.
|
|
337
|
+
* For more information about the `aria-labelledby` attribute, see the [WAI-ARIA definition](https://www.w3.org/TR/wai-aria/#aria-labelledby).
|
|
338
|
+
*/
|
|
339
|
+
ariaLabelledBy: string | undefined;
|
|
340
|
+
/**
|
|
341
|
+
* The ARIA role for the vertical tabset
|
|
342
|
+
* [to support accessibility](https://developer.blackbaud.com/skyux/learn/accessibility)
|
|
343
|
+
* by indicating how the tabset functions and what it controls. For information about how
|
|
344
|
+
* an ARIA role indicates what an item represents on a web page, see the
|
|
345
|
+
* [WAI-ARIA roles model](https://www.w3.org/WAI/PF/aria/#roles).
|
|
346
|
+
* @default "tablist"
|
|
347
|
+
* @deprecated Any other value than `tablist` could lead to a poor user experience for users with assistive technology.
|
|
348
|
+
* In the next major version, this property will be automatically set to `tablist`.
|
|
349
|
+
*/
|
|
350
|
+
get ariaRole(): string;
|
|
351
|
+
set ariaRole(value: string | undefined);
|
|
352
|
+
/**
|
|
353
|
+
* Whether the vertical tabset loads tab content during initialization so that it
|
|
354
|
+
* displays content without moving around elements in the content container.
|
|
355
|
+
* @default false
|
|
356
|
+
*/
|
|
357
|
+
maintainTabContent: boolean | undefined;
|
|
358
|
+
/**
|
|
359
|
+
* Fires when the active tab changes. Emits the index of the active tab. The
|
|
360
|
+
* index is based on the tab's position when it loads.
|
|
361
|
+
*/
|
|
362
|
+
activeChange: EventEmitter<number>;
|
|
363
|
+
tabGroups: ElementRef | undefined;
|
|
364
|
+
content: ElementRef | undefined;
|
|
365
|
+
contentWrapper: ElementRef | undefined;
|
|
366
|
+
ariaOwns: string | undefined;
|
|
367
|
+
isMobile: boolean;
|
|
368
|
+
protected tablistHasFocus: boolean;
|
|
369
|
+
constructor(adapterService: SkyVerticalTabsetAdapterService, tabService: SkyVerticalTabsetService, resources: SkyLibResourcesService, changeRef: ChangeDetectorRef, tabIdSvc: SkyTabIdService);
|
|
370
|
+
ngOnInit(): void;
|
|
371
|
+
ngAfterViewChecked(): void;
|
|
372
|
+
ngOnDestroy(): void;
|
|
373
|
+
protected tabsetFocus(): void;
|
|
374
|
+
protected trapFocusInTablist(): void;
|
|
375
|
+
protected resetTabIndex(): void;
|
|
376
|
+
protected tabGroupsArrowDown(): void;
|
|
377
|
+
protected tabGroupsArrowUp(): void;
|
|
378
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyVerticalTabsetComponent, never>;
|
|
379
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<SkyVerticalTabsetComponent, "sky-vertical-tabset", never, { "showTabsText": { "alias": "showTabsText"; "required": false; }; "ariaLabel": { "alias": "ariaLabel"; "required": false; }; "ariaLabelledBy": { "alias": "ariaLabelledBy"; "required": false; }; "ariaRole": { "alias": "ariaRole"; "required": false; }; "maintainTabContent": { "alias": "maintainTabContent"; "required": false; }; }, { "activeChange": "activeChange"; }, never, ["*"], false, never>;
|
|
380
|
+
}
|
|
381
|
+
|
|
382
|
+
/**
|
|
383
|
+
* Import into any component library module that needs to use resource strings.
|
|
384
|
+
*/
|
|
385
|
+
declare class SkyTabsResourcesModule {
|
|
386
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyTabsResourcesModule, never>;
|
|
387
|
+
static ɵmod: i0.ɵɵNgModuleDeclaration<SkyTabsResourcesModule, never, never, [typeof i1.SkyI18nModule]>;
|
|
388
|
+
static ɵinj: i0.ɵɵInjectorDeclaration<SkyTabsResourcesModule>;
|
|
389
|
+
}
|
|
390
|
+
|
|
391
|
+
declare class SkyVerticalTabsetModule {
|
|
392
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyVerticalTabsetModule, never>;
|
|
393
|
+
static ɵmod: i0.ɵɵNgModuleDeclaration<SkyVerticalTabsetModule, [typeof SkyVerticalTabsetComponent, typeof SkyVerticalTabsetGroupComponent, typeof SkyVerticalTabComponent], [typeof i4.CommonModule, typeof i5.SkyIconModule, typeof i6.SkyIdModule, typeof i7.SkyExpansionIndicatorModule, typeof i6.SkyResponsiveHostDirective, typeof i7.SkyStatusIndicatorModule, typeof SkyTabsResourcesModule, typeof i9.SkyThemeModule], [typeof SkyVerticalTabsetComponent, typeof SkyVerticalTabsetGroupComponent, typeof SkyVerticalTabComponent]>;
|
|
394
|
+
static ɵinj: i0.ɵɵInjectorDeclaration<SkyVerticalTabsetModule>;
|
|
395
|
+
}
|
|
396
|
+
|
|
397
|
+
declare class SkySectionedFormModule {
|
|
398
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkySectionedFormModule, never>;
|
|
399
|
+
static ɵmod: i0.ɵɵNgModuleDeclaration<SkySectionedFormModule, [typeof SkySectionedFormComponent, typeof SkySectionedFormSectionComponent], [typeof i4.CommonModule, typeof i4$1.SkyCheckboxModule, typeof i9.SkyThemeModule, typeof SkyVerticalTabsetModule], [typeof SkySectionedFormComponent, typeof SkySectionedFormSectionComponent]>;
|
|
400
|
+
static ɵinj: i0.ɵɵInjectorDeclaration<SkySectionedFormModule>;
|
|
401
|
+
}
|
|
402
|
+
|
|
403
|
+
type SkyTabIndex = string | number;
|
|
404
|
+
|
|
405
|
+
type SkyTabLayoutType = 'none' | 'blocks' | 'fit' | 'list';
|
|
406
|
+
|
|
407
|
+
/**
|
|
408
|
+
* @internal
|
|
409
|
+
*/
|
|
410
|
+
declare class SkyTabButtonAdapterService {
|
|
411
|
+
focusButtonLink(buttonEl: ElementRef): void;
|
|
412
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyTabButtonAdapterService, never>;
|
|
413
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<SkyTabButtonAdapterService>;
|
|
414
|
+
}
|
|
415
|
+
|
|
416
|
+
type SkyTabsetStyle = 'tabs' | 'wizard';
|
|
417
|
+
|
|
418
|
+
/**
|
|
419
|
+
* @internal
|
|
420
|
+
*/
|
|
421
|
+
interface TabButtonViewModel {
|
|
422
|
+
active: boolean;
|
|
423
|
+
ariaControls: string;
|
|
424
|
+
buttonHref: string | null;
|
|
425
|
+
buttonId: string;
|
|
426
|
+
buttonText: string | undefined;
|
|
427
|
+
buttonTextCount: string | undefined;
|
|
428
|
+
closeable: boolean;
|
|
429
|
+
disabled: boolean | undefined;
|
|
430
|
+
tabIndex: SkyTabIndex | undefined;
|
|
431
|
+
tabNumber: number;
|
|
432
|
+
totalTabsCount: number;
|
|
433
|
+
}
|
|
434
|
+
|
|
435
|
+
interface SkyTabsetActiveTabChangeArgs {
|
|
436
|
+
tabIndex: SkyTabIndex | undefined;
|
|
437
|
+
initial?: boolean;
|
|
438
|
+
}
|
|
439
|
+
|
|
440
|
+
/**
|
|
441
|
+
* The arguments for the tabset service's `activeTabUnregistered` event.
|
|
442
|
+
* @internal
|
|
443
|
+
*/
|
|
444
|
+
interface SkyTabsetActiveTabUnregisteredArgs {
|
|
445
|
+
/**
|
|
446
|
+
* The array index of the active tab, when it has been unregistered.
|
|
447
|
+
*/
|
|
448
|
+
arrayIndex: number;
|
|
449
|
+
}
|
|
450
|
+
|
|
451
|
+
/**
|
|
452
|
+
* @internal
|
|
453
|
+
*/
|
|
454
|
+
declare class SkyTabsetService implements OnDestroy {
|
|
455
|
+
#private;
|
|
456
|
+
readonly activeTabUnregistered: Observable<SkyTabsetActiveTabUnregisteredArgs>;
|
|
457
|
+
readonly activeTabChange: Observable<SkyTabsetActiveTabChangeArgs>;
|
|
458
|
+
readonly focusedTabBtnIndex: Observable<SkyTabIndex>;
|
|
459
|
+
readonly activeTabLayout: Observable<SkyTabLayoutType>;
|
|
460
|
+
currentActiveTabIndex: SkyTabIndex | undefined;
|
|
461
|
+
currentFocusedTabBtnIndex: SkyTabIndex;
|
|
462
|
+
constructor();
|
|
463
|
+
ngOnDestroy(): void;
|
|
464
|
+
/**
|
|
465
|
+
* Sets the active tab by its unique `tabIndex` property.
|
|
466
|
+
*/
|
|
467
|
+
setActiveTabIndex(value: SkyTabsetActiveTabChangeArgs, config?: {
|
|
468
|
+
emitChange: boolean;
|
|
469
|
+
}): void;
|
|
470
|
+
focusNextTabBtn(tabButtons: TabButtonViewModel[]): void;
|
|
471
|
+
focusPrevTabBtn(tabButtons: TabButtonViewModel[]): void;
|
|
472
|
+
focusFirstOrNearestTabBtn(tabButtons: TabButtonViewModel[]): void;
|
|
473
|
+
focusLastOrNearestTabBtn(tabButtons: TabButtonViewModel[]): void;
|
|
474
|
+
setFocusedTabBtnIndex(tabIndex: SkyTabIndex): void;
|
|
475
|
+
/**
|
|
476
|
+
* Registers a tab component.
|
|
477
|
+
*/
|
|
478
|
+
registerTab(tabIndex?: SkyTabIndex): SkyTabIndex;
|
|
479
|
+
updateTabIndex(currentTabIndex: SkyTabIndex, newTabIndex: SkyTabIndex): void;
|
|
480
|
+
updateActiveTabLayout(layout: SkyTabLayoutType): void;
|
|
481
|
+
/**
|
|
482
|
+
* Unregisters a tab component.
|
|
483
|
+
*/
|
|
484
|
+
unregisterTab(tabIndex: SkyTabIndex): void;
|
|
485
|
+
/**
|
|
486
|
+
* Unregisters all tab components at once.
|
|
487
|
+
*/
|
|
488
|
+
unregisterAll(): void;
|
|
489
|
+
/**
|
|
490
|
+
* Compares two tab indexes and returns `true` if they are equal.
|
|
491
|
+
*/
|
|
492
|
+
tabIndexesEqual(tabIndex1: SkyTabIndex | undefined, tabIndex2: SkyTabIndex | undefined): boolean;
|
|
493
|
+
/**
|
|
494
|
+
* Verifies if a provided tab index is registered.
|
|
495
|
+
*/
|
|
496
|
+
isValidTabIndex(tabIndex: SkyTabIndex): boolean;
|
|
497
|
+
/**
|
|
498
|
+
* Activates the first registered tab.
|
|
499
|
+
*/
|
|
500
|
+
activateFirstTab(): SkyTabIndex | undefined;
|
|
501
|
+
/**
|
|
502
|
+
* Activates the next registered tab, or the previous one based on a provided array index.
|
|
503
|
+
*/
|
|
504
|
+
activateNearestTab(arrayIndex: number): void;
|
|
505
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyTabsetService, never>;
|
|
506
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<SkyTabsetService>;
|
|
507
|
+
}
|
|
508
|
+
|
|
509
|
+
type SkyWizardStepState = 'completed' | 'current' | 'unavailable';
|
|
510
|
+
/**
|
|
511
|
+
* @internal
|
|
512
|
+
*/
|
|
513
|
+
declare class SkyTabButtonComponent implements AfterViewInit, OnDestroy {
|
|
514
|
+
#private;
|
|
515
|
+
get active(): boolean | undefined;
|
|
516
|
+
set active(value: boolean | undefined);
|
|
517
|
+
ariaControls: string | undefined;
|
|
518
|
+
buttonHref: string | undefined;
|
|
519
|
+
buttonId: string | undefined;
|
|
520
|
+
buttonText: string | undefined;
|
|
521
|
+
buttonTextCount: string | undefined;
|
|
522
|
+
closeable: boolean | undefined;
|
|
523
|
+
get disabled(): boolean;
|
|
524
|
+
set disabled(value: boolean | undefined);
|
|
525
|
+
tabIndex: SkyTabIndex | undefined;
|
|
526
|
+
tabNumber: number | undefined;
|
|
527
|
+
totalTabsCount: number | undefined;
|
|
528
|
+
get tabStyle(): SkyTabsetStyle | undefined;
|
|
529
|
+
set tabStyle(style: SkyTabsetStyle | undefined);
|
|
530
|
+
buttonClick: EventEmitter<void>;
|
|
531
|
+
closeClick: EventEmitter<void>;
|
|
532
|
+
constructor(elementRef: ElementRef, adapterService: SkyTabButtonAdapterService, changeDetectorRef: ChangeDetectorRef, tabsetService: SkyTabsetService);
|
|
533
|
+
closeBtnTabIndex: string;
|
|
534
|
+
wizardStepState: SkyWizardStepState | undefined;
|
|
535
|
+
ngAfterViewInit(): void;
|
|
536
|
+
ngOnDestroy(): void;
|
|
537
|
+
onButtonClick(event: any): void;
|
|
538
|
+
onTabButtonKeyDown(event: KeyboardEvent): void;
|
|
539
|
+
onCloseClick(event: any): void;
|
|
540
|
+
focusBtn(): void;
|
|
541
|
+
onFocus(): void;
|
|
542
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyTabButtonComponent, never>;
|
|
543
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<SkyTabButtonComponent, "sky-tab-button", never, { "active": { "alias": "active"; "required": false; }; "ariaControls": { "alias": "ariaControls"; "required": false; }; "buttonHref": { "alias": "buttonHref"; "required": false; }; "buttonId": { "alias": "buttonId"; "required": false; }; "buttonText": { "alias": "buttonText"; "required": false; }; "buttonTextCount": { "alias": "buttonTextCount"; "required": false; }; "closeable": { "alias": "closeable"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; "tabIndex": { "alias": "tabIndex"; "required": false; }; "tabNumber": { "alias": "tabNumber"; "required": false; }; "totalTabsCount": { "alias": "totalTabsCount"; "required": false; }; "tabStyle": { "alias": "tabStyle"; "required": false; }; }, { "buttonClick": "buttonClick"; "closeClick": "closeClick"; }, never, never, false, never>;
|
|
544
|
+
}
|
|
545
|
+
|
|
546
|
+
/**
|
|
547
|
+
* @internal
|
|
548
|
+
*/
|
|
549
|
+
declare class SkyTabsetPermalinkService implements OnDestroy {
|
|
550
|
+
#private;
|
|
551
|
+
get popStateChange(): Observable<void>;
|
|
552
|
+
ngOnDestroy(): void;
|
|
553
|
+
init(): void;
|
|
554
|
+
/**
|
|
555
|
+
* Returns the value of a URL query param.
|
|
556
|
+
*/
|
|
557
|
+
getParam(name: string): string;
|
|
558
|
+
/**
|
|
559
|
+
* Sets the value of a URL query param.
|
|
560
|
+
*/
|
|
561
|
+
setParam(name: string, value: string | null, initial?: boolean): void;
|
|
562
|
+
/**
|
|
563
|
+
* Removes the provided query param from the URL.
|
|
564
|
+
*/
|
|
565
|
+
clearParam(name: string): void;
|
|
566
|
+
/**
|
|
567
|
+
* Returns a relative URL that includes the provided query parameter. The value is intended to be
|
|
568
|
+
* used by an HTML anchor element.
|
|
569
|
+
*/
|
|
570
|
+
getParamHref(name: string | undefined, value: string): string | null;
|
|
571
|
+
/**
|
|
572
|
+
* Converts the provided string into a value that can be safely used in a URL.
|
|
573
|
+
*/
|
|
574
|
+
urlify(value: string | undefined): string;
|
|
575
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyTabsetPermalinkService, never>;
|
|
576
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<SkyTabsetPermalinkService>;
|
|
577
|
+
}
|
|
578
|
+
|
|
579
|
+
declare class SkyTabComponent implements OnChanges, OnDestroy {
|
|
580
|
+
#private;
|
|
581
|
+
/**
|
|
582
|
+
* Whether the tab is active when the tabset loads. After initialization, the `active`
|
|
583
|
+
* property on the tabset component should be used to set the active tab.
|
|
584
|
+
* @default false
|
|
585
|
+
*/
|
|
586
|
+
set active(value: boolean | undefined);
|
|
587
|
+
get active(): boolean;
|
|
588
|
+
get activeChange(): Observable<void>;
|
|
589
|
+
/**
|
|
590
|
+
* Whether to disable the tab.
|
|
591
|
+
* @default false
|
|
592
|
+
*/
|
|
593
|
+
disabled: boolean | undefined;
|
|
594
|
+
/**
|
|
595
|
+
* The custom query parameter value for the tab.
|
|
596
|
+
* This works in conjunction with the tabset's `permalinkId` to distinguish
|
|
597
|
+
* the tab's unique state in the URL by generating a query parameter that is
|
|
598
|
+
* written as `?<queryParam>-active-tab=<sanitized-tab-heading`.
|
|
599
|
+
* By default, the query parameter's value is parsed automatically from the tab's heading text.
|
|
600
|
+
* This input only applies when the tabset's `tabStyle` is `"tabs"`.
|
|
601
|
+
*/
|
|
602
|
+
set permalinkValue(value: string | undefined);
|
|
603
|
+
get permalinkValue(): string | undefined;
|
|
604
|
+
/**
|
|
605
|
+
* Displays a counter beside the tab header.
|
|
606
|
+
* This input only applies when the tabset's `tabStyle` is `"tabs"`.
|
|
607
|
+
* @deprecated SKY UX no longer recommends adding counts to tabs.
|
|
608
|
+
*/
|
|
609
|
+
tabHeaderCount: string | undefined;
|
|
610
|
+
/**
|
|
611
|
+
* The tab header.
|
|
612
|
+
* When using tabs as the main navigation on a page,
|
|
613
|
+
* use [the Angular `Title` service](https://angular.io/docs/ts/latest/cookbook/set-document-title.html)
|
|
614
|
+
* and [the SKY UX `title` configuration property](https://developer.blackbaud.com/skyux/learn/reference/configuration#app)
|
|
615
|
+
* to reflect the tab header in the page title.
|
|
616
|
+
* @required
|
|
617
|
+
*/
|
|
618
|
+
set tabHeading(value: string | undefined);
|
|
619
|
+
get tabHeading(): string | undefined;
|
|
620
|
+
/**
|
|
621
|
+
* The unique identifier for the tab.
|
|
622
|
+
* If not defined, the identifier is set to the position of the tab on load, starting with `0`.
|
|
623
|
+
*/
|
|
624
|
+
set tabIndexValue(value: SkyTabIndex | undefined);
|
|
625
|
+
get tabIndexValue(): SkyTabIndex | undefined;
|
|
626
|
+
/**
|
|
627
|
+
* The tab layout that applies spacing to the tab container element. Use the layout
|
|
628
|
+
* that corresponds with the top-level component type used within the tab, or use `fit` to
|
|
629
|
+
* constrain the tab contents to the available viewport.
|
|
630
|
+
* Use `none` for custom content that does not adhere to predefined spacing or constraints.
|
|
631
|
+
* @default "none"
|
|
632
|
+
*/
|
|
633
|
+
set layout(value: SkyTabLayoutType | undefined);
|
|
634
|
+
get layout(): SkyTabLayoutType;
|
|
635
|
+
cssClass: string;
|
|
636
|
+
/**
|
|
637
|
+
* Fires when users click the button to close the tab.
|
|
638
|
+
* The close button is added to the tab when you specify a listener for this event.
|
|
639
|
+
* This event only applies when the tabset's `tabStyle` is `"tabs"`.
|
|
640
|
+
*/
|
|
641
|
+
close: EventEmitter<void>;
|
|
642
|
+
/**
|
|
643
|
+
* Alerts the tabset component when this component has changes that need to be reflected in the UI.
|
|
644
|
+
*/
|
|
645
|
+
get stateChange(): Observable<void>;
|
|
646
|
+
get tabIndexChange(): Observable<SkyTabIndex | undefined>;
|
|
647
|
+
permalinkValueOrDefault: string;
|
|
648
|
+
showContent: boolean;
|
|
649
|
+
tabButtonId: string;
|
|
650
|
+
tabPanelId: string;
|
|
651
|
+
constructor(changeDetector: ChangeDetectorRef, permalinkService: SkyTabsetPermalinkService, tabsetService: SkyTabsetService);
|
|
652
|
+
ngOnChanges(changes: SimpleChanges): void;
|
|
653
|
+
ngOnDestroy(): void;
|
|
654
|
+
init(): void;
|
|
655
|
+
activate(): void;
|
|
656
|
+
deactivate(): void;
|
|
657
|
+
isCloseable(): boolean;
|
|
658
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyTabComponent, never>;
|
|
659
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<SkyTabComponent, "sky-tab", never, { "active": { "alias": "active"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; "permalinkValue": { "alias": "permalinkValue"; "required": false; }; "tabHeaderCount": { "alias": "tabHeaderCount"; "required": false; }; "tabHeading": { "alias": "tabHeading"; "required": false; }; "tabIndexValue": { "alias": "tabIndexValue"; "required": false; }; "layout": { "alias": "layout"; "required": false; }; }, { "close": "close"; }, never, ["*"], false, [{ directive: typeof i6.SkyResponsiveHostDirective; inputs: {}; outputs: {}; }]>;
|
|
660
|
+
}
|
|
661
|
+
|
|
662
|
+
/**
|
|
663
|
+
* @internal
|
|
664
|
+
*/
|
|
665
|
+
declare class SkyTabsetAdapterService implements OnDestroy {
|
|
666
|
+
#private;
|
|
667
|
+
get overflowChange(): Observable<boolean>;
|
|
668
|
+
constructor();
|
|
669
|
+
ngOnDestroy(): void;
|
|
670
|
+
registerTabset(tabsetRef: ElementRef): void;
|
|
671
|
+
/**
|
|
672
|
+
* Detects if the tab buttons are wider than the tabset container.
|
|
673
|
+
*/
|
|
674
|
+
detectOverflow(): void;
|
|
675
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyTabsetAdapterService, never>;
|
|
676
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<SkyTabsetAdapterService>;
|
|
677
|
+
}
|
|
678
|
+
|
|
679
|
+
type SkyTabsetButtonsDisplayMode = 'dropdown' | 'tabs';
|
|
680
|
+
|
|
681
|
+
interface SkyTabsetTabIndexesChange {
|
|
682
|
+
tabs?: {
|
|
683
|
+
tabHeading?: string;
|
|
684
|
+
tabIndex?: SkyTabIndex;
|
|
685
|
+
}[];
|
|
686
|
+
}
|
|
687
|
+
|
|
688
|
+
declare class SkyTabsetComponent implements AfterViewInit, OnDestroy {
|
|
689
|
+
#private;
|
|
690
|
+
/**
|
|
691
|
+
* Activates a tab by its `tabIndex` property.
|
|
692
|
+
*/
|
|
693
|
+
set active(value: SkyTabIndex | undefined);
|
|
694
|
+
get active(): SkyTabIndex | undefined;
|
|
695
|
+
/**
|
|
696
|
+
* The ARIA label for the tabset. This sets the tabset's `aria-label` attribute to provide a text equivalent for screen readers
|
|
697
|
+
* [to support accessibility](https://developer.blackbaud.com/skyux/learn/accessibility).
|
|
698
|
+
* If the tabset includes a visible label, use `ariaLabelledBy` instead.
|
|
699
|
+
* For more information about the `aria-label` attribute, see the [WAI-ARIA definition](https://www.w3.org/TR/wai-aria/#aria-label).
|
|
700
|
+
*/
|
|
701
|
+
ariaLabel: string | undefined;
|
|
702
|
+
/**
|
|
703
|
+
* The HTML element ID of the element that labels
|
|
704
|
+
* the tabset. This sets the tabset's `aria-labelledby` attribute to provide a text equivalent for screen readers
|
|
705
|
+
* [to support accessibility](https://developer.blackbaud.com/skyux/learn/accessibility).
|
|
706
|
+
* If the tabset does not include a visible label, use `ariaLabel` instead.
|
|
707
|
+
* For more information about the `aria-labelledby` attribute, see the [WAI-ARIA definition](https://www.w3.org/TR/wai-aria/#aria-labelledby).
|
|
708
|
+
*/
|
|
709
|
+
ariaLabelledBy: string | undefined;
|
|
710
|
+
/**
|
|
711
|
+
* Distinguishes a tabset's unique state in the URL by generating a query parameter
|
|
712
|
+
* that is written as `?<queryParam>-active-tab=<sanitized-tab-heading>`.
|
|
713
|
+
* The query parameter's value is parsed automatically from the selected tab's heading text,
|
|
714
|
+
* but you can supply a custom query parameter value for each tab with its `permalinkValue`.
|
|
715
|
+
* This input only applies when `tabStyle` is `"tabs"`
|
|
716
|
+
*/
|
|
717
|
+
set permalinkId(value: string | undefined);
|
|
718
|
+
get permalinkId(): string;
|
|
719
|
+
/**
|
|
720
|
+
* The behavior for a series of tabs.
|
|
721
|
+
* @default "tabs"
|
|
722
|
+
*/
|
|
723
|
+
set tabStyle(value: SkyTabsetStyle | undefined);
|
|
724
|
+
get tabStyle(): SkyTabsetStyle;
|
|
725
|
+
get dataTabStyle(): string;
|
|
726
|
+
/**
|
|
727
|
+
* Fires when the active tab changes. This event emits the index of the active tab.
|
|
728
|
+
*/
|
|
729
|
+
activeChange: EventEmitter<SkyTabIndex>;
|
|
730
|
+
/**
|
|
731
|
+
* Fires when users click the button to add a new tab.
|
|
732
|
+
* The new tab button is added to the tab area when you specify a listener for this event.
|
|
733
|
+
* This event only applies when `tabStyle` is `"tabs"`.
|
|
734
|
+
*/
|
|
735
|
+
newTab: EventEmitter<void>;
|
|
736
|
+
/**
|
|
737
|
+
* Fires when users click the button to open a tab.
|
|
738
|
+
* The open tab button is added to the tab area when you specify a listener for this event.
|
|
739
|
+
* This event only applies when `tabStyle` is `"tabs"`.
|
|
740
|
+
*/
|
|
741
|
+
openTab: EventEmitter<void>;
|
|
742
|
+
/**
|
|
743
|
+
* Fires when any tab's `tabIndex` value changes.
|
|
744
|
+
* This event only applies when `tabStyle` is `"tabs"`.
|
|
745
|
+
*/
|
|
746
|
+
tabIndexesChange: EventEmitter<SkyTabsetTabIndexesChange>;
|
|
747
|
+
set tabDisplayMode(value: SkyTabsetButtonsDisplayMode);
|
|
748
|
+
get tabDisplayMode(): SkyTabsetButtonsDisplayMode;
|
|
749
|
+
set tabs(value: QueryList<SkyTabComponent> | undefined);
|
|
750
|
+
get tabs(): QueryList<SkyTabComponent> | undefined;
|
|
751
|
+
cssClass: string;
|
|
752
|
+
dropdownTriggerButtonText: string;
|
|
753
|
+
/**
|
|
754
|
+
* This property is used by the deprecated tabset-nav-button component.
|
|
755
|
+
* @internal
|
|
756
|
+
*/
|
|
757
|
+
lastActiveTabIndex: SkyTabIndex | undefined;
|
|
758
|
+
tabButtons: TabButtonViewModel[];
|
|
759
|
+
constructor(changeDetector: ChangeDetectorRef, elementRef: ElementRef, adapterService: SkyTabsetAdapterService, permalinkService: SkyTabsetPermalinkService, tabsetService: SkyTabsetService);
|
|
760
|
+
ngAfterViewInit(): void;
|
|
761
|
+
ngOnDestroy(): void;
|
|
762
|
+
onWindowResize(): void;
|
|
763
|
+
onTabCloseClick(tabButton: TabButtonViewModel): void;
|
|
764
|
+
onTabButtonClick(tabButton: TabButtonViewModel): void;
|
|
765
|
+
onNewTabClick(): void;
|
|
766
|
+
onOpenTabClick(): void;
|
|
767
|
+
onRightKeyDown(): void;
|
|
768
|
+
onLeftKeyDown(): void;
|
|
769
|
+
onHomeKeyDown(): void;
|
|
770
|
+
onEndKeyDown(): void;
|
|
771
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyTabsetComponent, never>;
|
|
772
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<SkyTabsetComponent, "sky-tabset", never, { "active": { "alias": "active"; "required": false; }; "ariaLabel": { "alias": "ariaLabel"; "required": false; }; "ariaLabelledBy": { "alias": "ariaLabelledBy"; "required": false; }; "permalinkId": { "alias": "permalinkId"; "required": false; }; "tabStyle": { "alias": "tabStyle"; "required": false; }; }, { "activeChange": "activeChange"; "newTab": "newTab"; "openTab": "openTab"; "tabIndexesChange": "tabIndexesChange"; }, ["tabs"], ["*"], false, never>;
|
|
773
|
+
}
|
|
774
|
+
|
|
775
|
+
/**
|
|
776
|
+
* The nav button type.
|
|
777
|
+
*/
|
|
778
|
+
type SkyTabsetNavButtonType = 'previous' | 'next' | 'finish';
|
|
779
|
+
|
|
780
|
+
/**
|
|
781
|
+
* Creates a button to navigate between tabs in a tabset when `tabStyle` is `"wizard"`.
|
|
782
|
+
*/
|
|
783
|
+
declare class SkyTabsetNavButtonComponent implements OnDestroy {
|
|
784
|
+
#private;
|
|
785
|
+
/**
|
|
786
|
+
* The tabset wizard component to associate with the nav button.
|
|
787
|
+
* @required
|
|
788
|
+
*/
|
|
789
|
+
get tabset(): SkyTabsetComponent | undefined;
|
|
790
|
+
set tabset(value: SkyTabsetComponent | undefined);
|
|
791
|
+
/**
|
|
792
|
+
* The type of nav button to include.
|
|
793
|
+
* @required
|
|
794
|
+
*/
|
|
795
|
+
get buttonType(): SkyTabsetNavButtonType | undefined;
|
|
796
|
+
set buttonType(value: SkyTabsetNavButtonType | undefined);
|
|
797
|
+
get buttonTypeData(): SkyTabsetNavButtonType | undefined;
|
|
798
|
+
/**
|
|
799
|
+
* The label to display on the nav button. The following are the defaults for each `buttonType`:
|
|
800
|
+
* `next` = "Next", `previous` = "Previous", `finish` = "Finish"
|
|
801
|
+
*/
|
|
802
|
+
buttonText?: string | undefined;
|
|
803
|
+
/**
|
|
804
|
+
* Whether to disable the nav button.
|
|
805
|
+
* Defaults to the disabled state of the next tab for `next`, the existence of a previous tab for `previous`,
|
|
806
|
+
* and false for `finish`.
|
|
807
|
+
*/
|
|
808
|
+
set disabled(value: boolean | undefined);
|
|
809
|
+
get disabled(): boolean | undefined;
|
|
810
|
+
buttonClassName: string | undefined;
|
|
811
|
+
isVisible: boolean;
|
|
812
|
+
type: 'submit' | 'button';
|
|
813
|
+
ariaControls: string | undefined;
|
|
814
|
+
protected tabToSelect: SkyTabComponent | undefined;
|
|
815
|
+
constructor(logger: SkyLogService);
|
|
816
|
+
ngOnDestroy(): void;
|
|
817
|
+
buttonClick(): void;
|
|
818
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyTabsetNavButtonComponent, never>;
|
|
819
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<SkyTabsetNavButtonComponent, "sky-tabset-nav-button", never, { "tabset": { "alias": "tabset"; "required": false; }; "buttonType": { "alias": "buttonType"; "required": false; }; "buttonText": { "alias": "buttonText"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; }, {}, never, never, false, never>;
|
|
820
|
+
}
|
|
821
|
+
|
|
822
|
+
declare class SkyTabsetNavButtonDisabledPipe implements PipeTransform {
|
|
823
|
+
transform(disabled: boolean | undefined, buttonType?: SkyTabsetNavButtonType | string, tabToSelectExists?: boolean, tabToSelectIsDisabled?: boolean): boolean;
|
|
824
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyTabsetNavButtonDisabledPipe, never>;
|
|
825
|
+
static ɵpipe: i0.ɵɵPipeDeclaration<SkyTabsetNavButtonDisabledPipe, "skyTabsetNavButtonDisabled", false>;
|
|
826
|
+
}
|
|
827
|
+
|
|
828
|
+
declare class SkyTabsModule {
|
|
829
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyTabsModule, never>;
|
|
830
|
+
static ɵmod: i0.ɵɵNgModuleDeclaration<SkyTabsModule, [typeof SkyTabButtonComponent, typeof SkyTabComponent, typeof SkyTabsetComponent, typeof SkyTabsetNavButtonComponent, typeof SkyTabsetNavButtonDisabledPipe], [typeof i4.CommonModule, typeof i6.SkyResponsiveHostDirective, typeof i8.SkyDropdownModule, typeof i5.SkyIconModule, typeof i6.SkyIdModule, typeof SkyTabsResourcesModule, typeof i9.SkyThemeModule], [typeof SkyTabComponent, typeof SkyTabsetComponent, typeof SkyTabsetNavButtonComponent]>;
|
|
831
|
+
static ɵinj: i0.ɵɵInjectorDeclaration<SkyTabsModule>;
|
|
832
|
+
}
|
|
833
|
+
|
|
834
|
+
export { SkySectionedFormComponent, SkySectionedFormMessageType, SkySectionedFormModule, SkySectionedFormService, SkyTabsModule, SkyVerticalTabsetModule, SkyTabComponent as λ1, SkyTabsetComponent as λ2, SkyTabsetNavButtonComponent as λ3, SkyVerticalTabComponent as λ4, SkySectionedFormSectionComponent as λ5, SkyVerticalTabsetComponent as λ6, SkyVerticalTabsetGroupComponent as λ7 };
|
|
835
|
+
export type { SkySectionedFormMessage, SkyTabIndex, SkyTabLayoutType, SkyTabsetButtonsDisplayMode, SkyTabsetNavButtonType, SkyTabsetStyle, SkyTabsetTabIndexesChange };
|