@abgov/angular-components 5.0.0-dev.2 → 5.0.0-dev.4
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.
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
import * as i0 from '@angular/core';
|
|
2
|
-
import { ElementRef, Renderer2, OnInit, TemplateRef, EventEmitter
|
|
2
|
+
import { ElementRef, Renderer2, OnInit, TemplateRef, EventEmitter } from '@angular/core';
|
|
3
3
|
import { ControlValueAccessor, CheckboxControlValueAccessor } from '@angular/forms';
|
|
4
4
|
import { Spacing, GoabAccordionHeadingSize, GoabAccordionIconPosition, GoabBadgeType, GoabIconType, GoabBadgeSize, GoabBadgeEmphasis, GoabBlockDirection, GoabBlockAlignment, GoabButtonType, GoabButtonSize, GoabButtonVariant, GoabButtonGroupAlignment, GoabButtonGroupGap, GoabCalendarOnChangeDetail, GoabCalloutType, GoabCalloutSize, GoabCalloutAriaLive, GoabCalloutIconTheme, GoabCalloutEmphasis, GoabCheckboxSize, GoabCheckboxOnChangeDetail, GoabCheckboxListOnChangeDetail, GoabChipVariant, GoabChipTheme, GoabCircularProgressVariant, GoabCircularProgressSize, GoabContainerType, GoabContainerAccent, GoabContainerPadding, GoabContainerWidth, GoabDatePickerInputType, GoabDatePickerOnChangeDetail, GoabDrawerPosition, GoabDrawerSize, GoabDropdownSize, GoabDropdownOnChangeDetail, GoabDropdownItemMountType, GoabFileUploadOnCancelDetail, GoabFileUploadOnDeleteDetail, GoabFileUploadInputVariant, GoabFileUploadInputOnSelectFileDetail, GoabPublicFormStatus, GoabFormState, GoabPublicFormPageStep, GoabPublicFormPageButtonVisibility, GoabPublicFormTaskStatus, GoabFormDispatchOn, GoabFieldsetOnContinueDetail, GoabFormItemLabelSize, GoabFormItemRequirement, GoabFormItemType, GoabFormStepStatus, GoabFormStepperOnChangeDetail, GoabIconOverridesType, GoabIconSize, GoabIconTheme, GoabIconButtonVariant, GoabInputType, GoabInputAutoCapitalize, GoabInputSize, GoabInputOnFocusDetail, GoabInputOnBlurDetail, GoabInputOnKeyPressDetail, GoabInputOnChangeDetail, GoabLinkColor, GoabLinkSize, GoabServiceLevel, GoabLinkTarget, GoabModalCalloutVariant, GoabModalTransition, GoabMenuButtonOnActionDetail, GoabNotificationType, GoabAriaLiveType, GoabNotificationEmphasis, GoabPageBlockSize, GoabPaginationVariant, GoabPaginationOnChangeDetail, GoabPopoverPosition, GoabRadioGroupOrientation, GoabRadioGroupSize, GoabRadioGroupOnChangeDetail, GoabSkeletonType, GoabSkeletonSize, GoabSpacerHorizontalSpacing, GoabSpacerVerticalSpacing, GoabTableVariant, GoabTableSortMode, GoabTableOnSortDetail, GoabTableOnMultiSortDetail, GoabTableSortDirection, GoabTableSortOrder, GoabTabsVariant, GoabTabsOrientation, GoabTabsNavigation, GoabTabsOnChangeDetail, GoabTextTextElement, GoabTextHeadingElement, GoabTextSize, GoabTextMaxWidth, GoabTextColor, GoabTextAreaCountBy, GoabTextAreaSize, GoabTextAreaOnChangeDetail, GoabTextAreaOnKeyPressDetail, GoabTextAreaOnBlurDetail, GoabTooltipPosition, GoabTooltipHorizontalAlignment, GoabWorkSideMenuItemType, GoabWorkSideNotificationItemType, GoabWorkSideNotificationReadStatus, GoabWorkSideNotificationPriority, GoabWorkSideNotificationActiveTabType } from '@abgov/ui-components-common';
|
|
5
5
|
export * from '@abgov/ui-components-common';
|
|
6
6
|
|
|
7
7
|
declare class ValueDirective implements ControlValueAccessor {
|
|
8
|
-
protected elementRef: ElementRef
|
|
8
|
+
protected elementRef: ElementRef<any>;
|
|
9
9
|
private _value;
|
|
10
10
|
private _disabled;
|
|
11
11
|
onChange: any;
|
|
@@ -16,14 +16,13 @@ declare class ValueDirective implements ControlValueAccessor {
|
|
|
16
16
|
registerOnChange(fn: () => void): void;
|
|
17
17
|
registerOnTouched(fn: () => void): void;
|
|
18
18
|
setDisabledState(isDisabled: boolean): void;
|
|
19
|
-
constructor(elementRef: ElementRef);
|
|
20
19
|
listenForValueChange(event: Event): void;
|
|
21
20
|
listenForDisabledChange(event: Event): void;
|
|
22
21
|
static ɵfac: i0.ɵɵFactoryDeclaration<ValueDirective, never>;
|
|
23
22
|
static ɵdir: i0.ɵɵDirectiveDeclaration<ValueDirective, "[goaValue]", never, {}, {}, never, never, true, never>;
|
|
24
23
|
}
|
|
25
24
|
declare class ValueListDirective implements ControlValueAccessor {
|
|
26
|
-
protected elementRef: ElementRef
|
|
25
|
+
protected elementRef: ElementRef<any>;
|
|
27
26
|
private _value?;
|
|
28
27
|
onChange: any;
|
|
29
28
|
onTouched: any;
|
|
@@ -32,7 +31,6 @@ declare class ValueListDirective implements ControlValueAccessor {
|
|
|
32
31
|
writeValue(value?: string[]): void;
|
|
33
32
|
registerOnChange(fn: () => void): void;
|
|
34
33
|
registerOnTouched(fn: () => void): void;
|
|
35
|
-
constructor(elementRef: ElementRef);
|
|
36
34
|
listenForValueChange(event: Event): void;
|
|
37
35
|
_setValue(value?: string[]): void;
|
|
38
36
|
static ɵfac: i0.ɵɵFactoryDeclaration<ValueListDirective, never>;
|
|
@@ -45,7 +43,7 @@ declare class CheckedDirective extends CheckboxControlValueAccessor {
|
|
|
45
43
|
private _checked;
|
|
46
44
|
onChange: any;
|
|
47
45
|
onTouched: any;
|
|
48
|
-
constructor(
|
|
46
|
+
constructor();
|
|
49
47
|
get value(): string;
|
|
50
48
|
set value(checked: any);
|
|
51
49
|
writeValue(checked: any): void;
|
|
@@ -63,19 +61,27 @@ declare class AngularComponentsModule {
|
|
|
63
61
|
}
|
|
64
62
|
|
|
65
63
|
declare abstract class GoabBaseComponent {
|
|
64
|
+
/** Sets the top margin spacing token. */
|
|
66
65
|
mt?: Spacing;
|
|
66
|
+
/** Sets the bottom margin spacing token. */
|
|
67
67
|
mb?: Spacing;
|
|
68
|
+
/** Sets the left margin spacing token. */
|
|
68
69
|
ml?: Spacing;
|
|
70
|
+
/** Sets the right margin spacing token. */
|
|
69
71
|
mr?: Spacing;
|
|
72
|
+
/** Sets the data-testid attribute for automated testing. */
|
|
70
73
|
testId?: string;
|
|
71
74
|
static ɵfac: i0.ɵɵFactoryDeclaration<GoabBaseComponent, never>;
|
|
72
75
|
static ɵcmp: i0.ɵɵComponentDeclaration<GoabBaseComponent, "ng-component", never, { "mt": { "alias": "mt"; "required": false; }; "mb": { "alias": "mb"; "required": false; }; "ml": { "alias": "ml"; "required": false; }; "mr": { "alias": "mr"; "required": false; }; "testId": { "alias": "testId"; "required": false; }; }, {}, never, never, true, never>;
|
|
73
76
|
}
|
|
74
77
|
declare abstract class GoabControlValueAccessor extends GoabBaseComponent implements ControlValueAccessor {
|
|
75
|
-
|
|
78
|
+
/** Sets the id attribute of the underlying web component. */
|
|
76
79
|
id?: string;
|
|
80
|
+
/** Sets the disabled state for the control. */
|
|
77
81
|
disabled?: boolean;
|
|
82
|
+
/** Sets the error state for the control. */
|
|
78
83
|
error?: boolean;
|
|
84
|
+
/** Sets the control value used by Angular forms and one-way binding. */
|
|
79
85
|
value?: unknown | null | undefined;
|
|
80
86
|
/**
|
|
81
87
|
* Function to handle changes in the form control value.
|
|
@@ -98,7 +104,7 @@ declare abstract class GoabControlValueAccessor extends GoabBaseComponent implem
|
|
|
98
104
|
* The base class captures it here so children don't need their own ViewChild.
|
|
99
105
|
*/
|
|
100
106
|
protected goaComponentRef?: ElementRef;
|
|
101
|
-
|
|
107
|
+
protected renderer: Renderer2;
|
|
102
108
|
/**
|
|
103
109
|
* Convert an arbitrary value into a string for DOM attribute assignment.
|
|
104
110
|
* Child classes can override when they need special formatting.
|
|
@@ -135,16 +141,23 @@ declare abstract class GoabControlValueAccessor extends GoabBaseComponent implem
|
|
|
135
141
|
|
|
136
142
|
declare class GoabAccordion extends GoabBaseComponent implements OnInit {
|
|
137
143
|
private cdr;
|
|
144
|
+
/** Sets the heading text. */
|
|
138
145
|
heading?: string;
|
|
146
|
+
/** Sets secondary text. */
|
|
139
147
|
secondaryText?: string;
|
|
148
|
+
/** Sets the state of the accordion container open or closed. */
|
|
140
149
|
open?: boolean;
|
|
150
|
+
/** Sets the heading size of the accordion container heading. */
|
|
141
151
|
headingSize?: GoabAccordionHeadingSize;
|
|
152
|
+
/** Sets the heading content template reference. */
|
|
142
153
|
headingContent: TemplateRef<any>;
|
|
154
|
+
/** Sets the maximum width of the accordion. */
|
|
143
155
|
maxWidth?: string;
|
|
156
|
+
/** Sets the position of the expand/collapse icon. */
|
|
144
157
|
iconPosition?: GoabAccordionIconPosition;
|
|
158
|
+
/** Emits when the accordion opens or closes. Emits the new open state as a boolean. */
|
|
145
159
|
onChange: EventEmitter<boolean>;
|
|
146
160
|
isReady: boolean;
|
|
147
|
-
constructor(cdr: ChangeDetectorRef);
|
|
148
161
|
ngOnInit(): void;
|
|
149
162
|
_onChange(e: Event): void;
|
|
150
163
|
static ɵfac: i0.ɵɵFactoryDeclaration<GoabAccordion, never>;
|
|
@@ -154,16 +167,22 @@ declare class GoabAccordion extends GoabBaseComponent implements OnInit {
|
|
|
154
167
|
|
|
155
168
|
declare class GoabBadge extends GoabBaseComponent implements OnInit {
|
|
156
169
|
private cdr;
|
|
170
|
+
/** Sets the context and colour of the badge. */
|
|
157
171
|
type?: GoabBadgeType;
|
|
172
|
+
/** Sets the text label of the badge. */
|
|
158
173
|
content?: string;
|
|
174
|
+
/** @deprecated Use icontype instead. Includes an icon in the badge. */
|
|
159
175
|
icon?: boolean;
|
|
176
|
+
/** Sets the icon type to display in the badge. */
|
|
160
177
|
iconType?: GoabIconType;
|
|
178
|
+
/** Sets the size of the badge. @default "medium" */
|
|
161
179
|
size?: GoabBadgeSize;
|
|
180
|
+
/** Sets the visual emphasis. 'subtle' for less prominent, 'strong' for more emphasis. @default "strong" */
|
|
162
181
|
emphasis?: GoabBadgeEmphasis;
|
|
182
|
+
/** Sets the accessible label for screen readers. */
|
|
163
183
|
ariaLabel?: string;
|
|
164
184
|
isReady: boolean;
|
|
165
185
|
version: string;
|
|
166
|
-
constructor(cdr: ChangeDetectorRef);
|
|
167
186
|
ngOnInit(): void;
|
|
168
187
|
static ɵfac: i0.ɵɵFactoryDeclaration<GoabBadge, never>;
|
|
169
188
|
static ɵcmp: i0.ɵɵComponentDeclaration<GoabBadge, "goab-badge", never, { "type": { "alias": "type"; "required": false; }; "content": { "alias": "content"; "required": false; }; "icon": { "alias": "icon"; "required": false; }; "iconType": { "alias": "iconType"; "required": false; }; "size": { "alias": "size"; "required": false; }; "emphasis": { "alias": "emphasis"; "required": false; }; "ariaLabel": { "alias": "ariaLabel"; "required": false; }; }, {}, never, never, true, never>;
|
|
@@ -172,14 +191,19 @@ declare class GoabBadge extends GoabBaseComponent implements OnInit {
|
|
|
172
191
|
|
|
173
192
|
declare class GoabBlock extends GoabBaseComponent implements OnInit {
|
|
174
193
|
private cdr;
|
|
194
|
+
/** Sets the spacing between items. Uses design system spacing tokens. */
|
|
175
195
|
gap?: Spacing;
|
|
196
|
+
/** Sets the stacking direction of child components. */
|
|
176
197
|
direction?: GoabBlockDirection;
|
|
198
|
+
/** Sets the primary axis alignment of child components. */
|
|
177
199
|
alignment?: GoabBlockAlignment;
|
|
200
|
+
/** Sets the width of the block container. Defaults to max-content. */
|
|
178
201
|
width?: string;
|
|
202
|
+
/** Sets the minimum width of the block container. */
|
|
179
203
|
minWidth?: string;
|
|
204
|
+
/** Sets the maximum width of the block container. */
|
|
180
205
|
maxWidth?: string;
|
|
181
206
|
isReady: boolean;
|
|
182
|
-
constructor(cdr: ChangeDetectorRef);
|
|
183
207
|
ngOnInit(): void;
|
|
184
208
|
static ɵfac: i0.ɵɵFactoryDeclaration<GoabBlock, never>;
|
|
185
209
|
static ɵcmp: i0.ɵɵComponentDeclaration<GoabBlock, "goab-block", never, { "gap": { "alias": "gap"; "required": false; }; "direction": { "alias": "direction"; "required": false; }; "alignment": { "alias": "alignment"; "required": false; }; "width": { "alias": "width"; "required": false; }; "minWidth": { "alias": "minWidth"; "required": false; }; "maxWidth": { "alias": "maxWidth"; "required": false; }; }, {}, never, ["*"], true, never>;
|
|
@@ -187,20 +211,30 @@ declare class GoabBlock extends GoabBaseComponent implements OnInit {
|
|
|
187
211
|
|
|
188
212
|
declare class GoabButton extends GoabBaseComponent implements OnInit {
|
|
189
213
|
private cdr;
|
|
214
|
+
/** Sets the visual style of the button. Use "primary" for main actions, "secondary" for alternative actions, "tertiary" for low-emphasis actions, and "start" for prominent call-to-action buttons. @default "primary" */
|
|
190
215
|
type?: GoabButtonType;
|
|
216
|
+
/** Sets the size of the button. Use "compact" for inline actions or space-constrained layouts. @default "normal" */
|
|
191
217
|
size?: GoabButtonSize;
|
|
218
|
+
/** Sets the color variant for semantic meaning. Use "destructive" for delete or irreversible actions, "inverse" for dark backgrounds. @default "normal" */
|
|
192
219
|
variant?: GoabButtonVariant;
|
|
220
|
+
/** Sets the disabled state. When true, prevents user interaction and applies disabled styling. */
|
|
193
221
|
disabled?: boolean;
|
|
222
|
+
/** Sets the icon displayed before the button text. */
|
|
194
223
|
leadingIcon?: GoabIconType;
|
|
224
|
+
/** Icon displayed after the button text. */
|
|
195
225
|
trailingIcon?: GoabIconType;
|
|
226
|
+
/** Sets a custom width for the button (e.g., "200px" or "100%"). */
|
|
196
227
|
width?: string;
|
|
228
|
+
/** Action identifier passed in click events for event delegation patterns. */
|
|
197
229
|
action?: string;
|
|
230
|
+
/** Single argument value passed with the action in click events. */
|
|
198
231
|
actionArg?: string;
|
|
232
|
+
/** Multiple argument values passed with the action in click events. */
|
|
199
233
|
actionArgs?: Record<string, unknown>;
|
|
234
|
+
/** Emits when the button is clicked. */
|
|
200
235
|
onClick: EventEmitter<any>;
|
|
201
236
|
isReady: boolean;
|
|
202
237
|
version: string;
|
|
203
|
-
constructor(cdr: ChangeDetectorRef);
|
|
204
238
|
ngOnInit(): void;
|
|
205
239
|
_onClick(): void;
|
|
206
240
|
protected readonly JSON: JSON;
|
|
@@ -211,10 +245,11 @@ declare class GoabButton extends GoabBaseComponent implements OnInit {
|
|
|
211
245
|
|
|
212
246
|
declare class GoabButtonGroup extends GoabBaseComponent implements OnInit {
|
|
213
247
|
private cdr;
|
|
248
|
+
/** Positions the button group in the page layout. */
|
|
214
249
|
alignment?: GoabButtonGroupAlignment;
|
|
250
|
+
/** Sets the spacing between buttons in the button group. */
|
|
215
251
|
gap?: GoabButtonGroupGap;
|
|
216
252
|
isReady: boolean;
|
|
217
|
-
constructor(cdr: ChangeDetectorRef);
|
|
218
253
|
ngOnInit(): void;
|
|
219
254
|
static ɵfac: i0.ɵɵFactoryDeclaration<GoabButtonGroup, never>;
|
|
220
255
|
static ɵcmp: i0.ɵɵComponentDeclaration<GoabButtonGroup, "goab-button-group", never, { "alignment": { "alias": "alignment"; "required": false; }; "gap": { "alias": "gap"; "required": false; }; }, {}, never, ["*"], true, never>;
|
|
@@ -223,10 +258,15 @@ declare class GoabButtonGroup extends GoabBaseComponent implements OnInit {
|
|
|
223
258
|
declare class GoabCalendar extends GoabBaseComponent implements OnInit {
|
|
224
259
|
private cdr;
|
|
225
260
|
version: string;
|
|
261
|
+
/** Name identifier for the calendar, included in change events. */
|
|
226
262
|
name?: string;
|
|
263
|
+
/** The currently selected date value in YYYY-MM-DD format. */
|
|
227
264
|
value?: Date | string;
|
|
265
|
+
/** The minimum selectable date in YYYY-MM-DD format. Defaults to 5 years in the past. */
|
|
228
266
|
min?: Date | string | undefined;
|
|
267
|
+
/** The maximum selectable date in YYYY-MM-DD format. Defaults to 5 years in the future. */
|
|
229
268
|
max?: Date | string | undefined;
|
|
269
|
+
/** Emits when the selected date changes. Emits the selected date details as GoabCalendarOnChangeDetail. */
|
|
230
270
|
onChange: EventEmitter<GoabCalendarOnChangeDetail>;
|
|
231
271
|
isReady: boolean;
|
|
232
272
|
private once;
|
|
@@ -234,7 +274,6 @@ declare class GoabCalendar extends GoabBaseComponent implements OnInit {
|
|
|
234
274
|
valueString(): string;
|
|
235
275
|
minString(): string;
|
|
236
276
|
maxString(): string;
|
|
237
|
-
constructor(cdr: ChangeDetectorRef);
|
|
238
277
|
ngOnInit(): void;
|
|
239
278
|
_onChange(e: Event): void;
|
|
240
279
|
static ɵfac: i0.ɵɵFactoryDeclaration<GoabCalendar, never>;
|
|
@@ -245,14 +284,20 @@ declare class GoabCallout extends GoabBaseComponent implements OnInit {
|
|
|
245
284
|
private cdr;
|
|
246
285
|
isReady: boolean;
|
|
247
286
|
version: string;
|
|
248
|
-
constructor(cdr: ChangeDetectorRef);
|
|
249
287
|
ngOnInit(): void;
|
|
288
|
+
/** Define the context and colour of the callout. @default "information" */
|
|
250
289
|
type?: GoabCalloutType;
|
|
290
|
+
/** Callout heading text. */
|
|
251
291
|
heading?: string;
|
|
292
|
+
/** Sets the size of the callout. 'medium' has reduced padding and type size for compact areas. @default "large" */
|
|
252
293
|
size?: GoabCalloutSize;
|
|
294
|
+
/** Sets the maximum width of the callout. */
|
|
253
295
|
maxWidth?: string;
|
|
296
|
+
/** Indicates how assistive technology should handle updates to the live region. @default "off" */
|
|
254
297
|
ariaLive?: GoabCalloutAriaLive;
|
|
298
|
+
/** Sets the icon theme. 'outline' for stroked icons, 'filled' for solid icons. @default "outline" */
|
|
255
299
|
iconTheme?: GoabCalloutIconTheme;
|
|
300
|
+
/** Sets the visual prominence. 'high' for full background, 'medium' for subtle, 'low' for minimal. @default "medium" */
|
|
256
301
|
emphasis?: GoabCalloutEmphasis;
|
|
257
302
|
static ɵfac: i0.ɵɵFactoryDeclaration<GoabCallout, never>;
|
|
258
303
|
static ɵcmp: i0.ɵɵComponentDeclaration<GoabCallout, "goab-callout", never, { "type": { "alias": "type"; "required": false; }; "heading": { "alias": "heading"; "required": false; }; "size": { "alias": "size"; "required": false; }; "maxWidth": { "alias": "maxWidth"; "required": false; }; "ariaLive": { "alias": "ariaLive"; "required": false; }; "iconTheme": { "alias": "iconTheme"; "required": false; }; "emphasis": { "alias": "emphasis"; "required": false; }; }, {}, never, ["*"], true, never>;
|
|
@@ -261,9 +306,10 @@ declare class GoabCallout extends GoabBaseComponent implements OnInit {
|
|
|
261
306
|
declare class GoabCard extends GoabBaseComponent implements OnInit {
|
|
262
307
|
private cdr;
|
|
263
308
|
isReady: boolean;
|
|
264
|
-
constructor(cdr: ChangeDetectorRef);
|
|
265
309
|
ngOnInit(): void;
|
|
310
|
+
/** Adds a shadow to the card. 0 shows a border, 1-3 increase shadow intensity. */
|
|
266
311
|
elevation?: number;
|
|
312
|
+
/** Sets the width of the card. */
|
|
267
313
|
width?: string;
|
|
268
314
|
static ɵfac: i0.ɵɵFactoryDeclaration<GoabCard, never>;
|
|
269
315
|
static ɵcmp: i0.ɵɵComponentDeclaration<GoabCard, "goab-card", never, { "elevation": { "alias": "elevation"; "required": false; }; "width": { "alias": "width"; "required": false; }; }, {}, never, ["*"], true, never>;
|
|
@@ -273,7 +319,6 @@ declare class GoabCard extends GoabBaseComponent implements OnInit {
|
|
|
273
319
|
declare class GoabCardContent implements OnInit {
|
|
274
320
|
private cdr;
|
|
275
321
|
isReady: boolean;
|
|
276
|
-
constructor(cdr: ChangeDetectorRef);
|
|
277
322
|
ngOnInit(): void;
|
|
278
323
|
static ɵfac: i0.ɵɵFactoryDeclaration<GoabCardContent, never>;
|
|
279
324
|
static ɵcmp: i0.ɵɵComponentDeclaration<GoabCardContent, "goab-card-content", never, {}, {}, never, ["*"], true, never>;
|
|
@@ -282,7 +327,6 @@ declare class GoabCardContent implements OnInit {
|
|
|
282
327
|
declare class GoabCardActions implements OnInit {
|
|
283
328
|
private cdr;
|
|
284
329
|
isReady: boolean;
|
|
285
|
-
constructor(cdr: ChangeDetectorRef);
|
|
286
330
|
ngOnInit(): void;
|
|
287
331
|
static ɵfac: i0.ɵɵFactoryDeclaration<GoabCardActions, never>;
|
|
288
332
|
static ɵcmp: i0.ɵɵComponentDeclaration<GoabCardActions, "goab-card-actions", never, {}, {}, never, ["*"], true, never>;
|
|
@@ -290,10 +334,11 @@ declare class GoabCardActions implements OnInit {
|
|
|
290
334
|
|
|
291
335
|
declare class GoabCardImage implements OnInit {
|
|
292
336
|
private cdr;
|
|
337
|
+
/** @required The URL of the image to display. */
|
|
293
338
|
src: string;
|
|
339
|
+
/** @required Height of the image container. Accepts CSS values like "200px" or "100%". */
|
|
294
340
|
height: string;
|
|
295
341
|
isReady: boolean;
|
|
296
|
-
constructor(cdr: ChangeDetectorRef);
|
|
297
342
|
ngOnInit(): void;
|
|
298
343
|
static ɵfac: i0.ɵɵFactoryDeclaration<GoabCardImage, never>;
|
|
299
344
|
static ɵcmp: i0.ɵɵComponentDeclaration<GoabCardImage, "goab-card-image", never, { "src": { "alias": "src"; "required": true; }; "height": { "alias": "height"; "required": true; }; }, {}, never, ["*"], true, never>;
|
|
@@ -303,19 +348,30 @@ declare class GoabCheckbox extends GoabControlValueAccessor implements OnInit {
|
|
|
303
348
|
private cdr;
|
|
304
349
|
isReady: boolean;
|
|
305
350
|
version: string;
|
|
306
|
-
constructor(cdr: ChangeDetectorRef, renderer: Renderer2);
|
|
307
351
|
ngOnInit(): void;
|
|
352
|
+
/** Sets the name of the checkbox input for form submission. */
|
|
308
353
|
name?: string;
|
|
354
|
+
/** Marks the checkbox item as selected. */
|
|
309
355
|
checked?: boolean;
|
|
356
|
+
/** Shows a mixed/partial selection state. Used for 'Select All' checkboxes when some items are selected. */
|
|
310
357
|
indeterminate?: boolean;
|
|
358
|
+
/** Label shown beside the checkbox. */
|
|
311
359
|
text?: string;
|
|
360
|
+
/** The value binding. */
|
|
312
361
|
value?: string | number | boolean | null;
|
|
362
|
+
/** Defines how the text will be translated for the screen reader. If not specified it will fall back to the name. */
|
|
313
363
|
ariaLabel?: string;
|
|
364
|
+
/** Sets additional description content displayed below the checkbox label. Accepts plain text or a template. */
|
|
314
365
|
description: string | TemplateRef<any>;
|
|
366
|
+
/** Sets the template for the expandable reveal slot content. */
|
|
315
367
|
reveal?: TemplateRef<any>;
|
|
368
|
+
/** Text announced by screen readers when the reveal slot content is displayed. */
|
|
316
369
|
revealArialLabel?: string;
|
|
370
|
+
/** Sets the maximum width of the checkbox. */
|
|
317
371
|
maxWidth?: string;
|
|
372
|
+
/** Sets the size of the checkbox. 'compact' reduces spacing for dense layouts. @default "default" */
|
|
318
373
|
size?: GoabCheckboxSize;
|
|
374
|
+
/** Emits when the checkbox value changes. Emits the new checkbox state as a GoabCheckboxOnChangeDetail object. */
|
|
319
375
|
onChange: EventEmitter<GoabCheckboxOnChangeDetail>;
|
|
320
376
|
getDescriptionAsString(): string;
|
|
321
377
|
getDescriptionAsTemplate(): TemplateRef<any> | null;
|
|
@@ -331,12 +387,16 @@ declare class GoabCheckboxList extends GoabControlValueAccessor implements OnIni
|
|
|
331
387
|
private cdr;
|
|
332
388
|
isReady: boolean;
|
|
333
389
|
version: string;
|
|
390
|
+
/** @required The name for the checkbox list group. Used as group identifier in change events. */
|
|
334
391
|
name: string;
|
|
392
|
+
/** Sets the maximum width of the checkbox list container. */
|
|
335
393
|
maxWidth?: string;
|
|
394
|
+
/** Sets the size of the checkbox list. 'compact' reduces spacing between items. @default "default" */
|
|
336
395
|
size?: GoabCheckboxSize;
|
|
396
|
+
/** Array of currently selected checkbox values. */
|
|
337
397
|
value?: string[];
|
|
338
|
-
constructor(cdr: ChangeDetectorRef, renderer: Renderer2);
|
|
339
398
|
ngOnInit(): void;
|
|
399
|
+
/** Emits when a checkbox selection changes. Emits the change detail including name, value array, and event. */
|
|
340
400
|
onChange: EventEmitter<GoabCheckboxListOnChangeDetail>;
|
|
341
401
|
_onChange(e: Event): void;
|
|
342
402
|
writeValue(value: string[] | null): void;
|
|
@@ -347,14 +407,20 @@ declare class GoabCheckboxList extends GoabControlValueAccessor implements OnIni
|
|
|
347
407
|
declare class GoabChip extends GoabBaseComponent implements OnInit {
|
|
348
408
|
private cdr;
|
|
349
409
|
isReady: boolean;
|
|
350
|
-
constructor(cdr: ChangeDetectorRef);
|
|
351
410
|
ngOnInit(): void;
|
|
411
|
+
/** @deprecated Use GoAFilterChip instead. Icon displayed at the start of the chip. */
|
|
352
412
|
leadingIcon?: GoabIconType | null;
|
|
413
|
+
/** @deprecated Use GoAFilterChip instead. Shows an error state on the chip. */
|
|
353
414
|
error?: boolean;
|
|
415
|
+
/** @deprecated Use GoAFilterChip instead. When true, shows a delete icon and makes chip clickable. */
|
|
354
416
|
deletable?: boolean;
|
|
417
|
+
/** @deprecated Use GoAFilterChip instead. The text content displayed in the chip. */
|
|
355
418
|
content?: string;
|
|
419
|
+
/** @deprecated Use GoAFilterChip instead. The chip variant style. */
|
|
356
420
|
variant?: GoabChipVariant;
|
|
421
|
+
/** @deprecated Use GoAFilterChip instead. The icon theme - outline or filled. */
|
|
357
422
|
iconTheme?: GoabChipTheme;
|
|
423
|
+
/** Emits when the chip is clicked. */
|
|
358
424
|
onClick: EventEmitter<any>;
|
|
359
425
|
_onClick(): void;
|
|
360
426
|
static ɵfac: i0.ɵɵFactoryDeclaration<GoabChip, never>;
|
|
@@ -365,14 +431,19 @@ declare class GoabChip extends GoabBaseComponent implements OnInit {
|
|
|
365
431
|
|
|
366
432
|
declare class GoabCircularProgress implements OnInit {
|
|
367
433
|
private cdr;
|
|
434
|
+
/** Stretch across the full screen or use it inline. */
|
|
368
435
|
variant?: GoabCircularProgressVariant;
|
|
436
|
+
/** Size of the progress indicator. */
|
|
369
437
|
size?: GoabCircularProgressSize;
|
|
438
|
+
/** Loading message displayed under the progress indicator. */
|
|
370
439
|
message?: string;
|
|
440
|
+
/** Show/hide the page loader. This allows for fade transition to be applied in each transition. */
|
|
371
441
|
visible?: boolean;
|
|
442
|
+
/** Set the progress value. Setting this value will change the type from infinite to progress. */
|
|
372
443
|
progress?: number;
|
|
444
|
+
/** Sets a data-testid attribute for automated testing. */
|
|
373
445
|
testId?: string;
|
|
374
446
|
isReady: boolean;
|
|
375
|
-
constructor(cdr: ChangeDetectorRef);
|
|
376
447
|
ngOnInit(): void;
|
|
377
448
|
static ɵfac: i0.ɵɵFactoryDeclaration<GoabCircularProgress, never>;
|
|
378
449
|
static ɵcmp: i0.ɵɵComponentDeclaration<GoabCircularProgress, "goab-circular-progress", never, { "variant": { "alias": "variant"; "required": false; }; "size": { "alias": "size"; "required": false; }; "message": { "alias": "message"; "required": false; }; "visible": { "alias": "visible"; "required": false; }; "progress": { "alias": "progress"; "required": false; }; "testId": { "alias": "testId"; "required": false; }; }, {}, never, never, true, never>;
|
|
@@ -384,7 +455,6 @@ declare class GoabColumnLayout implements OnInit {
|
|
|
384
455
|
private cdr;
|
|
385
456
|
/** no props **/
|
|
386
457
|
isReady: boolean;
|
|
387
|
-
constructor(cdr: ChangeDetectorRef);
|
|
388
458
|
ngOnInit(): void;
|
|
389
459
|
static ɵfac: i0.ɵɵFactoryDeclaration<GoabColumnLayout, never>;
|
|
390
460
|
static ɵcmp: i0.ɵɵComponentDeclaration<GoabColumnLayout, "goab-column-layout", never, {}, {}, never, ["*"], true, never>;
|
|
@@ -392,17 +462,25 @@ declare class GoabColumnLayout implements OnInit {
|
|
|
392
462
|
|
|
393
463
|
declare class GoabContainer extends GoabBaseComponent implements OnInit {
|
|
394
464
|
private cdr;
|
|
465
|
+
/** Sets the container and accent bar styling. @default "interactive" */
|
|
395
466
|
type?: GoabContainerType;
|
|
467
|
+
/** Sets the style of accent on the container. @default "filled" */
|
|
396
468
|
accent?: GoabContainerAccent;
|
|
469
|
+
/** Sets the amount of white space in the container. @default "relaxed" */
|
|
397
470
|
padding?: GoabContainerPadding;
|
|
471
|
+
/** Sets the width of the container. @default "full" */
|
|
398
472
|
width?: GoabContainerWidth;
|
|
473
|
+
/** Sets the maximum width of the container. */
|
|
399
474
|
maxWidth?: string;
|
|
475
|
+
/** Sets the minimum height of the container. */
|
|
400
476
|
minHeight?: string;
|
|
477
|
+
/** Sets the maximum height of the container. */
|
|
401
478
|
maxHeight?: string;
|
|
479
|
+
/** Sets the template for the title slot content. */
|
|
402
480
|
title: TemplateRef<any>;
|
|
481
|
+
/** Sets the template for the actions slot content. */
|
|
403
482
|
actions: TemplateRef<any>;
|
|
404
483
|
isReady: boolean;
|
|
405
|
-
constructor(cdr: ChangeDetectorRef);
|
|
406
484
|
ngOnInit(): void;
|
|
407
485
|
static ɵfac: i0.ɵɵFactoryDeclaration<GoabContainer, never>;
|
|
408
486
|
static ɵcmp: i0.ɵɵComponentDeclaration<GoabContainer, "goab-container", never, { "type": { "alias": "type"; "required": false; }; "accent": { "alias": "accent"; "required": false; }; "padding": { "alias": "padding"; "required": false; }; "width": { "alias": "width"; "required": false; }; "maxWidth": { "alias": "maxWidth"; "required": false; }; "minHeight": { "alias": "minHeight"; "required": false; }; "maxHeight": { "alias": "maxHeight"; "required": false; }; "title": { "alias": "title"; "required": false; }; "actions": { "alias": "actions"; "required": false; }; }, {}, never, ["*"], true, never>;
|
|
@@ -410,31 +488,38 @@ declare class GoabContainer extends GoabBaseComponent implements OnInit {
|
|
|
410
488
|
|
|
411
489
|
declare class GoabDataGrid implements OnInit {
|
|
412
490
|
private cdr;
|
|
491
|
+
/** Controls visibility of the keyboard navigation indicator icon. Use "visible" to show or "hidden" to hide. @default "visible" */
|
|
413
492
|
keyboardIconVisibility: "visible" | "hidden";
|
|
493
|
+
/** Position of the keyboard navigation indicator icon. @default "left" */
|
|
414
494
|
keyboardIconPosition: "left" | "right";
|
|
495
|
+
/** @required Navigation mode. "table" navigates like a table (up/down between rows), "layout" allows wrapping between rows with left/right arrows. */
|
|
415
496
|
keyboardNav: "layout" | "table";
|
|
416
497
|
isReady: boolean;
|
|
417
|
-
constructor(cdr: ChangeDetectorRef);
|
|
418
498
|
ngOnInit(): void;
|
|
419
499
|
static ɵfac: i0.ɵɵFactoryDeclaration<GoabDataGrid, never>;
|
|
420
500
|
static ɵcmp: i0.ɵɵComponentDeclaration<GoabDataGrid, "goab-data-grid", never, { "keyboardIconVisibility": { "alias": "keyboardIconVisibility"; "required": false; }; "keyboardIconPosition": { "alias": "keyboardIconPosition"; "required": false; }; "keyboardNav": { "alias": "keyboardNav"; "required": true; }; }, {}, never, ["*"], true, never>;
|
|
421
501
|
}
|
|
422
502
|
|
|
423
503
|
declare class GoabDatePicker extends GoabControlValueAccessor implements OnInit {
|
|
424
|
-
protected elementRef: ElementRef
|
|
504
|
+
protected elementRef: ElementRef<any>;
|
|
425
505
|
private cdr;
|
|
426
506
|
isReady: boolean;
|
|
427
507
|
version: string;
|
|
508
|
+
/** Sets the name of the date field. */
|
|
428
509
|
name?: string;
|
|
510
|
+
/** Sets the value of the calendar date. */
|
|
429
511
|
value?: Date | string | null | undefined;
|
|
512
|
+
/** Sets the minimum date value allowed. */
|
|
430
513
|
min?: Date | string;
|
|
514
|
+
/** Sets the maximum date value allowed. */
|
|
431
515
|
max?: Date | string;
|
|
516
|
+
/** Sets the date picker type. 'calendar' shows a calendar popup, 'input' shows just a date input. @default "calendar" */
|
|
432
517
|
type?: GoabDatePickerInputType;
|
|
433
|
-
|
|
434
|
-
* @deprecated This property has no effect and will be removed in a future version
|
|
435
|
-
*/
|
|
518
|
+
/** @deprecated This property has no effect and will be removed in a future version. */
|
|
436
519
|
relative?: boolean;
|
|
520
|
+
/** Sets the width of the date picker input. */
|
|
437
521
|
width?: string;
|
|
522
|
+
/** Emits when the selected date changes. Emits the date picker change detail including name and value. */
|
|
438
523
|
onChange: EventEmitter<GoabDatePickerOnChangeDetail>;
|
|
439
524
|
private once;
|
|
440
525
|
private formatValue;
|
|
@@ -442,7 +527,6 @@ declare class GoabDatePicker extends GoabControlValueAccessor implements OnInit
|
|
|
442
527
|
minString(): string;
|
|
443
528
|
maxString(): string;
|
|
444
529
|
_onChange(e: Event): void;
|
|
445
|
-
constructor(elementRef: ElementRef, cdr: ChangeDetectorRef, renderer: Renderer2);
|
|
446
530
|
ngOnInit(): void;
|
|
447
531
|
setDisabledState(isDisabled: boolean): void;
|
|
448
532
|
listenDisabledChange(event: Event): void;
|
|
@@ -453,11 +537,13 @@ declare class GoabDatePicker extends GoabControlValueAccessor implements OnInit
|
|
|
453
537
|
|
|
454
538
|
declare class GoabDetails extends GoabBaseComponent implements OnInit {
|
|
455
539
|
private cdr;
|
|
540
|
+
/** @required The title heading. */
|
|
456
541
|
heading: string;
|
|
542
|
+
/** Controls if details is expanded or not. */
|
|
457
543
|
open?: boolean;
|
|
544
|
+
/** Sets the maximum width of the details. */
|
|
458
545
|
maxWidth?: string;
|
|
459
546
|
isReady: boolean;
|
|
460
|
-
constructor(cdr: ChangeDetectorRef);
|
|
461
547
|
ngOnInit(): void;
|
|
462
548
|
static ɵfac: i0.ɵɵFactoryDeclaration<GoabDetails, never>;
|
|
463
549
|
static ɵcmp: i0.ɵɵComponentDeclaration<GoabDetails, "goab-details", never, { "heading": { "alias": "heading"; "required": true; }; "open": { "alias": "open"; "required": false; }; "maxWidth": { "alias": "maxWidth"; "required": false; }; }, {}, never, ["*"], true, never>;
|
|
@@ -467,7 +553,6 @@ declare class GoabDetails extends GoabBaseComponent implements OnInit {
|
|
|
467
553
|
declare class GoabDivider extends GoabBaseComponent implements OnInit {
|
|
468
554
|
private cdr;
|
|
469
555
|
isReady: boolean;
|
|
470
|
-
constructor(cdr: ChangeDetectorRef);
|
|
471
556
|
ngOnInit(): void;
|
|
472
557
|
static ɵfac: i0.ɵɵFactoryDeclaration<GoabDivider, never>;
|
|
473
558
|
static ɵcmp: i0.ɵɵComponentDeclaration<GoabDivider, "goab-divider", never, {}, {}, never, never, true, never>;
|
|
@@ -476,15 +561,21 @@ declare class GoabDivider extends GoabBaseComponent implements OnInit {
|
|
|
476
561
|
declare class GoabDrawer implements OnInit {
|
|
477
562
|
private cdr;
|
|
478
563
|
version: string;
|
|
564
|
+
/** @required Whether the drawer is open. */
|
|
479
565
|
open: boolean;
|
|
566
|
+
/** @required The position of the drawer. */
|
|
480
567
|
position: GoabDrawerPosition;
|
|
568
|
+
/** The heading text displayed at the top of the drawer. */
|
|
481
569
|
heading: string | TemplateRef<any>;
|
|
570
|
+
/** Sets max height on bottom position, sets width on left and right position. */
|
|
482
571
|
maxSize?: GoabDrawerSize;
|
|
572
|
+
/** Sets a data-testid attribute for automated testing. */
|
|
483
573
|
testId?: string;
|
|
574
|
+
/** Sets the actions area content using an Angular template reference. */
|
|
484
575
|
actions: TemplateRef<any>;
|
|
576
|
+
/** Emits when the drawer is closed. */
|
|
485
577
|
onClose: EventEmitter<any>;
|
|
486
578
|
isReady: boolean;
|
|
487
|
-
constructor(cdr: ChangeDetectorRef);
|
|
488
579
|
ngOnInit(): void;
|
|
489
580
|
_onClose(): void;
|
|
490
581
|
getHeadingAsString(): string;
|
|
@@ -496,27 +587,38 @@ declare class GoabDrawer implements OnInit {
|
|
|
496
587
|
|
|
497
588
|
declare class GoabDropdown extends GoabControlValueAccessor implements OnInit {
|
|
498
589
|
private cdr;
|
|
590
|
+
/** Identifier for the dropdown. Should be unique. */
|
|
499
591
|
name?: string;
|
|
592
|
+
/** Defines how the selected value will be translated for the screen reader. If not specified it will fall back to the name. */
|
|
500
593
|
ariaLabel?: string;
|
|
594
|
+
/** The aria-labelledby attribute identifies the element(or elements) that labels the dropdown it is applied to. Normally it is the id of the label. */
|
|
501
595
|
ariaLabelledBy?: string;
|
|
596
|
+
/** When true the dropdown will have the ability to filter options by typing into the input field. */
|
|
502
597
|
filterable?: boolean;
|
|
598
|
+
/** Icon shown to the left of the dropdown input. */
|
|
503
599
|
leadingIcon?: GoabIconType;
|
|
600
|
+
/** Maximum height of the dropdown menu. Non-native only. */
|
|
504
601
|
maxHeight?: string;
|
|
602
|
+
/** When true, allows multiple items to be selected. Not currently exposed. */
|
|
505
603
|
multiselect?: boolean;
|
|
604
|
+
/** When true will render the native select HTML element. */
|
|
506
605
|
native?: boolean;
|
|
606
|
+
/** The text displayed for the dropdown before a selection is made. Non-native only. */
|
|
507
607
|
placeholder?: string;
|
|
608
|
+
/** Overrides the autosized menu width. Non-native only. */
|
|
508
609
|
width?: string;
|
|
610
|
+
/** Sets the maximum width of the dropdown. Use a CSS unit (px, %, ch, rem, em). */
|
|
509
611
|
maxWidth?: string;
|
|
612
|
+
/** Specifies the autocomplete attribute for the dropdown input. Native only. */
|
|
510
613
|
autoComplete?: string;
|
|
614
|
+
/** Sets the size of the dropdown. Compact reduces height for dense layouts. @default "default" */
|
|
511
615
|
size?: GoabDropdownSize;
|
|
512
|
-
|
|
513
|
-
* @deprecated This property has no effect and will be removed in a future version
|
|
514
|
-
*/
|
|
616
|
+
/** @deprecated This property has no effect and will be removed in a future version. */
|
|
515
617
|
relative?: boolean;
|
|
618
|
+
/** Emits when the user selects a value from the dropdown. Emits a GoabDropdownOnChangeDetail object with the new value. */
|
|
516
619
|
onChange: EventEmitter<GoabDropdownOnChangeDetail>;
|
|
517
620
|
isReady: boolean;
|
|
518
621
|
version: string;
|
|
519
|
-
constructor(cdr: ChangeDetectorRef, renderer: Renderer2);
|
|
520
622
|
ngOnInit(): void;
|
|
521
623
|
_onChange(e: Event): void;
|
|
522
624
|
static ɵfac: i0.ɵɵFactoryDeclaration<GoabDropdown, never>;
|
|
@@ -528,13 +630,17 @@ declare class GoabDropdown extends GoabControlValueAccessor implements OnInit {
|
|
|
528
630
|
|
|
529
631
|
declare class GoabDropdownItem implements OnInit {
|
|
530
632
|
private cdr;
|
|
633
|
+
/** The value submitted when this item is selected. */
|
|
531
634
|
value?: string;
|
|
635
|
+
/** Text used to filter and match this item in typeahead search. */
|
|
532
636
|
filter?: string;
|
|
637
|
+
/** Display label for the dropdown item. */
|
|
533
638
|
label?: string;
|
|
639
|
+
/** Sets the name attribute of the dropdown item. */
|
|
534
640
|
name?: string;
|
|
641
|
+
/** Controls how the item is registered with the parent dropdown. */
|
|
535
642
|
mountType?: GoabDropdownItemMountType;
|
|
536
643
|
isReady: boolean;
|
|
537
|
-
constructor(cdr: ChangeDetectorRef);
|
|
538
644
|
ngOnInit(): void;
|
|
539
645
|
static ɵfac: i0.ɵɵFactoryDeclaration<GoabDropdownItem, never>;
|
|
540
646
|
static ɵcmp: i0.ɵɵComponentDeclaration<GoabDropdownItem, "goab-dropdown-item", never, { "value": { "alias": "value"; "required": false; }; "filter": { "alias": "filter"; "required": false; }; "label": { "alias": "label"; "required": false; }; "name": { "alias": "name"; "required": false; }; "mountType": { "alias": "mountType"; "required": false; }; }, {}, never, never, true, never>;
|
|
@@ -542,54 +648,71 @@ declare class GoabDropdownItem implements OnInit {
|
|
|
542
648
|
|
|
543
649
|
declare class GoabFileUploadCard implements OnInit {
|
|
544
650
|
private cdr;
|
|
651
|
+
/** @required The name of the uploaded file to display. */
|
|
545
652
|
filename: string;
|
|
546
|
-
size
|
|
653
|
+
/** @required The file size in bytes. Displayed in a human-readable format (KB, MB). */
|
|
654
|
+
size: number;
|
|
655
|
+
/** The MIME type of the file. Used to determine the file type icon. */
|
|
547
656
|
type?: string;
|
|
657
|
+
/** Upload progress percentage from 0-100. Use -1 to indicate upload is complete. */
|
|
548
658
|
progress?: number;
|
|
659
|
+
/** Error message to display. When set, the card shows an error state with a cancel button. */
|
|
549
660
|
error?: string;
|
|
661
|
+
/** Sets a data-testid attribute for automated testing. */
|
|
550
662
|
testId?: string;
|
|
663
|
+
/** Emits when the user cancels a file upload. Emits a GoabFileUploadOnCancelDetail object with the filename. */
|
|
551
664
|
onCancel: EventEmitter<GoabFileUploadOnCancelDetail>;
|
|
665
|
+
/** Emits when the user removes an uploaded file. Emits a GoabFileUploadOnDeleteDetail object with the filename. */
|
|
552
666
|
onDelete: EventEmitter<GoabFileUploadOnDeleteDetail>;
|
|
553
667
|
isReady: boolean;
|
|
554
668
|
version: string;
|
|
555
|
-
constructor(cdr: ChangeDetectorRef);
|
|
556
669
|
ngOnInit(): void;
|
|
557
670
|
_onCancel(event: Event): void;
|
|
558
671
|
_onDelete(event: Event): void;
|
|
559
672
|
static ɵfac: i0.ɵɵFactoryDeclaration<GoabFileUploadCard, never>;
|
|
560
|
-
static ɵcmp: i0.ɵɵComponentDeclaration<GoabFileUploadCard, "goab-file-upload-card", never, { "filename": { "alias": "filename"; "required": true; }; "size": { "alias": "size"; "required":
|
|
673
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<GoabFileUploadCard, "goab-file-upload-card", never, { "filename": { "alias": "filename"; "required": true; }; "size": { "alias": "size"; "required": true; }; "type": { "alias": "type"; "required": false; }; "progress": { "alias": "progress"; "required": false; }; "error": { "alias": "error"; "required": false; }; "testId": { "alias": "testId"; "required": false; }; }, { "onCancel": "onCancel"; "onDelete": "onDelete"; }, never, never, true, never>;
|
|
561
674
|
static ngAcceptInputType_size: unknown;
|
|
562
675
|
static ngAcceptInputType_progress: unknown;
|
|
563
676
|
}
|
|
564
677
|
|
|
565
678
|
declare class GoabFileUploadInput extends GoabBaseComponent implements OnInit {
|
|
566
679
|
private cdr;
|
|
680
|
+
/** Sets the id attribute on the file upload input element. */
|
|
567
681
|
id?: string;
|
|
568
|
-
variant
|
|
682
|
+
/** The input display variant. "dragdrop" shows a drag-and-drop area, "button" shows a simple button. @default "dragdrop" */
|
|
683
|
+
variant?: GoabFileUploadInputVariant;
|
|
684
|
+
/** Maximum file size with unit (e.g., "5MB", "100KB", "1GB"). Files exceeding this will be rejected. @default "5MB" */
|
|
569
685
|
maxFileSize?: string;
|
|
686
|
+
/** Accepted file types as a comma-separated list of MIME types or file extensions (e.g., "image/*,.pdf"). */
|
|
570
687
|
accept?: string;
|
|
688
|
+
/** Emits when a file is selected. Emits the selected file details. */
|
|
571
689
|
onSelectFile: EventEmitter<GoabFileUploadInputOnSelectFileDetail>;
|
|
572
690
|
isReady: boolean;
|
|
573
691
|
version: string;
|
|
574
|
-
constructor(cdr: ChangeDetectorRef);
|
|
575
692
|
ngOnInit(): void;
|
|
576
693
|
_onSelectFile(e: Event): void;
|
|
577
694
|
static ɵfac: i0.ɵɵFactoryDeclaration<GoabFileUploadInput, never>;
|
|
578
|
-
static ɵcmp: i0.ɵɵComponentDeclaration<GoabFileUploadInput, "goab-file-upload-input", never, { "id": { "alias": "id"; "required": false; }; "variant": { "alias": "variant"; "required":
|
|
695
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<GoabFileUploadInput, "goab-file-upload-input", never, { "id": { "alias": "id"; "required": false; }; "variant": { "alias": "variant"; "required": false; }; "maxFileSize": { "alias": "maxFileSize"; "required": false; }; "accept": { "alias": "accept"; "required": false; }; }, { "onSelectFile": "onSelectFile"; }, never, never, true, never>;
|
|
579
696
|
}
|
|
580
697
|
|
|
581
698
|
declare class GoabFilterChip extends GoabBaseComponent implements OnInit {
|
|
582
699
|
private cdr;
|
|
700
|
+
/** Shows an error state. */
|
|
583
701
|
error?: boolean;
|
|
702
|
+
/** Marks the chip as deletable. */
|
|
584
703
|
deletable?: boolean;
|
|
704
|
+
/** Text label of the chip. */
|
|
585
705
|
content?: string;
|
|
706
|
+
/** Sets the icon theme style for the filter chip. */
|
|
586
707
|
iconTheme?: GoabChipTheme;
|
|
708
|
+
/** Secondary text displayed in a smaller size before the main content. */
|
|
587
709
|
secondaryText?: string;
|
|
710
|
+
/** Icon displayed at the start of the chip. */
|
|
588
711
|
leadingIcon?: GoabIconType | null;
|
|
712
|
+
/** Emits when the filter chip delete button is clicked. */
|
|
589
713
|
onClick: EventEmitter<any>;
|
|
590
714
|
isReady: boolean;
|
|
591
715
|
version: string;
|
|
592
|
-
constructor(cdr: ChangeDetectorRef);
|
|
593
716
|
ngOnInit(): void;
|
|
594
717
|
_onClick(): void;
|
|
595
718
|
static ɵfac: i0.ɵɵFactoryDeclaration<GoabFilterChip, never>;
|
|
@@ -600,12 +723,14 @@ declare class GoabFilterChip extends GoabBaseComponent implements OnInit {
|
|
|
600
723
|
|
|
601
724
|
declare class GoabAppFooter implements OnInit {
|
|
602
725
|
private cdr;
|
|
726
|
+
/** The maximum width of the main content area. */
|
|
603
727
|
maxContentWidth?: string;
|
|
728
|
+
/** Sets a data-testid attribute for automated testing. */
|
|
604
729
|
testId?: string;
|
|
730
|
+
/** URL for the Government of Alberta logo link. Set to empty string to disable the link. */
|
|
605
731
|
url?: string;
|
|
606
732
|
isReady: boolean;
|
|
607
733
|
version: string;
|
|
608
|
-
constructor(cdr: ChangeDetectorRef);
|
|
609
734
|
ngOnInit(): void;
|
|
610
735
|
static ɵfac: i0.ɵɵFactoryDeclaration<GoabAppFooter, never>;
|
|
611
736
|
static ɵcmp: i0.ɵɵComponentDeclaration<GoabAppFooter, "goab-app-footer", never, { "maxContentWidth": { "alias": "maxContentWidth"; "required": false; }; "testId": { "alias": "testId"; "required": false; }; "url": { "alias": "url"; "required": false; }; }, {}, never, ["[slot=nav]", "goab-app-footer-meta-section", "*"], true, never>;
|
|
@@ -613,11 +738,11 @@ declare class GoabAppFooter implements OnInit {
|
|
|
613
738
|
|
|
614
739
|
declare class GoabAppFooterMetaSection implements OnInit {
|
|
615
740
|
private cdr;
|
|
741
|
+
/** Sets a data-testid attribute for automated testing. */
|
|
616
742
|
testId?: string;
|
|
617
|
-
/**
|
|
743
|
+
/** @required Sets the slot to "meta" to render the section in the correct footer position. */
|
|
618
744
|
slot: "meta";
|
|
619
745
|
isReady: boolean;
|
|
620
|
-
constructor(cdr: ChangeDetectorRef);
|
|
621
746
|
ngOnInit(): void;
|
|
622
747
|
static ɵfac: i0.ɵɵFactoryDeclaration<GoabAppFooterMetaSection, never>;
|
|
623
748
|
static ɵcmp: i0.ɵɵComponentDeclaration<GoabAppFooterMetaSection, "goab-app-footer-meta-section", never, { "testId": { "alias": "testId"; "required": false; }; "slot": { "alias": "slot"; "required": true; }; }, {}, never, ["*"], true, never>;
|
|
@@ -625,23 +750,30 @@ declare class GoabAppFooterMetaSection implements OnInit {
|
|
|
625
750
|
|
|
626
751
|
declare class GoabAppFooterNavSection implements OnInit {
|
|
627
752
|
private cdr;
|
|
753
|
+
/** The section heading displayed above the navigation links. */
|
|
628
754
|
heading?: string;
|
|
755
|
+
/** Maximum number of columns to display links in on larger screens. @default 1 */
|
|
629
756
|
maxColumnCount?: number | undefined;
|
|
757
|
+
/** Sets a data-testid attribute for automated testing. */
|
|
630
758
|
testId?: string;
|
|
631
|
-
/**
|
|
759
|
+
/** @required Sets the slot to "nav" to render the section in the correct footer position. */
|
|
632
760
|
slot: "nav";
|
|
633
761
|
isReady: boolean;
|
|
634
|
-
constructor(cdr: ChangeDetectorRef);
|
|
635
762
|
ngOnInit(): void;
|
|
636
763
|
static ɵfac: i0.ɵɵFactoryDeclaration<GoabAppFooterNavSection, never>;
|
|
637
764
|
static ɵcmp: i0.ɵɵComponentDeclaration<GoabAppFooterNavSection, "goab-app-footer-nav-section", never, { "heading": { "alias": "heading"; "required": false; }; "maxColumnCount": { "alias": "maxColumnCount"; "required": false; }; "testId": { "alias": "testId"; "required": false; }; "slot": { "alias": "slot"; "required": true; }; }, {}, never, ["*"], true, never>;
|
|
638
765
|
}
|
|
639
766
|
|
|
640
767
|
declare class GoabPublicForm {
|
|
768
|
+
/** The initialization status of the form. Set to "initializing" while loading external state, then "complete" when ready. @default "complete" */
|
|
641
769
|
status?: GoabPublicFormStatus;
|
|
770
|
+
/** A name identifier for the form. Useful for debugging complex forms with multiple nested forms. */
|
|
642
771
|
name?: string;
|
|
772
|
+
/** Emits when the form is initialized. */
|
|
643
773
|
onInit: EventEmitter<Event>;
|
|
774
|
+
/** Emits when the form is complete. Emits the form state. */
|
|
644
775
|
onComplete: EventEmitter<GoabFormState>;
|
|
776
|
+
/** Emits when the form state changes. Emits the updated form state. */
|
|
645
777
|
onStateChange: EventEmitter<GoabFormState>;
|
|
646
778
|
_onInit(e: Event): void;
|
|
647
779
|
_onComplete(e: Event): void;
|
|
@@ -651,18 +783,25 @@ declare class GoabPublicForm {
|
|
|
651
783
|
}
|
|
652
784
|
|
|
653
785
|
declare class GoabPublicFormPage extends GoabBaseComponent {
|
|
786
|
+
/** Sets the id of the form page. */
|
|
654
787
|
id: string;
|
|
788
|
+
/** Sets the main heading text of the form page. */
|
|
655
789
|
heading: string;
|
|
790
|
+
/** Sets the sub-heading text displayed below the main heading. */
|
|
656
791
|
subHeading: string;
|
|
792
|
+
/** Sets the heading used in the summary view for this page. */
|
|
657
793
|
summaryHeading: string;
|
|
794
|
+
/** Sets the section title displayed above the heading. */
|
|
658
795
|
sectionTitle: string;
|
|
796
|
+
/** Sets the URL for the back navigation link. */
|
|
659
797
|
backUrl: string;
|
|
798
|
+
/** Sets the type of the form page step. @default "step" */
|
|
660
799
|
type: GoabPublicFormPageStep;
|
|
800
|
+
/** Sets the text for the continue or confirm button. */
|
|
661
801
|
buttonText: string;
|
|
802
|
+
/** Sets the visibility of the continue button. @default "visible" */
|
|
662
803
|
buttonVisibility: GoabPublicFormPageButtonVisibility;
|
|
663
|
-
/**
|
|
664
|
-
* triggers when the form page continues to the next step
|
|
665
|
-
*/
|
|
804
|
+
/** Emits when the form page continues to the next step. */
|
|
666
805
|
onContinue: EventEmitter<Event>;
|
|
667
806
|
_onContinue(event: Event): void;
|
|
668
807
|
static ɵfac: i0.ɵɵFactoryDeclaration<GoabPublicFormPage, never>;
|
|
@@ -670,16 +809,22 @@ declare class GoabPublicFormPage extends GoabBaseComponent {
|
|
|
670
809
|
}
|
|
671
810
|
|
|
672
811
|
declare class GoabPublicFormSummary {
|
|
812
|
+
/** Sets the heading text displayed above the form summary. */
|
|
673
813
|
heading?: string;
|
|
674
814
|
static ɵfac: i0.ɵɵFactoryDeclaration<GoabPublicFormSummary, never>;
|
|
675
815
|
static ɵcmp: i0.ɵɵComponentDeclaration<GoabPublicFormSummary, "goab-public-form-summary", never, { "heading": { "alias": "heading"; "required": false; }; }, {}, never, ["*"], true, never>;
|
|
676
816
|
}
|
|
677
817
|
|
|
678
818
|
declare class GoabPublicSubform extends GoabBaseComponent {
|
|
819
|
+
/** Sets the id of the subform. */
|
|
679
820
|
id?: string;
|
|
821
|
+
/** Sets the name identifier for the subform. */
|
|
680
822
|
name?: string;
|
|
823
|
+
/** Sets the text for the continue button. */
|
|
681
824
|
continueMsg?: string;
|
|
825
|
+
/** Emits when the subform is initialized. */
|
|
682
826
|
onInit: EventEmitter<Event>;
|
|
827
|
+
/** Emits when the subform state changes. */
|
|
683
828
|
onStateChange: EventEmitter<Event>;
|
|
684
829
|
_onInit(e: Event): void;
|
|
685
830
|
_onStateChange(e: Event): void;
|
|
@@ -688,30 +833,40 @@ declare class GoabPublicSubform extends GoabBaseComponent {
|
|
|
688
833
|
}
|
|
689
834
|
|
|
690
835
|
declare class GoabPublicSubformIndex extends GoabBaseComponent {
|
|
836
|
+
/** Sets the heading text of the subform index page. */
|
|
691
837
|
heading?: string;
|
|
838
|
+
/** Sets the section title displayed above the heading. */
|
|
692
839
|
sectionTitle?: string;
|
|
840
|
+
/** Sets the text for the action button that navigates to the subform. */
|
|
693
841
|
actionButtonText?: string;
|
|
842
|
+
/** Sets the visibility of the continue button. @default "hidden" */
|
|
694
843
|
buttonVisibility?: "visible" | "hidden";
|
|
695
844
|
static ɵfac: i0.ɵɵFactoryDeclaration<GoabPublicSubformIndex, never>;
|
|
696
845
|
static ɵcmp: i0.ɵɵComponentDeclaration<GoabPublicSubformIndex, "goab-public-subform-index", never, { "heading": { "alias": "heading"; "required": false; }; "sectionTitle": { "alias": "sectionTitle"; "required": false; }; "actionButtonText": { "alias": "actionButtonText"; "required": false; }; "buttonVisibility": { "alias": "buttonVisibility"; "required": false; }; }, {}, never, ["*"], true, never>;
|
|
697
846
|
}
|
|
698
847
|
|
|
699
848
|
declare class GoabPublicFormTask {
|
|
849
|
+
/** Sets the status of the task, which determines its badge display. */
|
|
700
850
|
status?: GoabPublicFormTaskStatus;
|
|
701
851
|
static ɵfac: i0.ɵɵFactoryDeclaration<GoabPublicFormTask, never>;
|
|
702
852
|
static ɵcmp: i0.ɵɵComponentDeclaration<GoabPublicFormTask, "goab-public-form-task", never, { "status": { "alias": "status"; "required": false; }; }, {}, never, ["*"], true, never>;
|
|
703
853
|
}
|
|
704
854
|
|
|
705
855
|
declare class GoabPublicFormTaskList extends GoabBaseComponent {
|
|
856
|
+
/** Sets the heading text displayed above the task list. */
|
|
706
857
|
heading?: string;
|
|
707
858
|
static ɵfac: i0.ɵɵFactoryDeclaration<GoabPublicFormTaskList, never>;
|
|
708
859
|
static ɵcmp: i0.ɵɵComponentDeclaration<GoabPublicFormTaskList, "goab-public-form-task-list", never, { "heading": { "alias": "heading"; "required": false; }; }, {}, never, ["*"], true, never>;
|
|
709
860
|
}
|
|
710
861
|
|
|
711
862
|
declare class GoabFieldset {
|
|
863
|
+
/** Sets the id of the fieldset. */
|
|
712
864
|
id?: string;
|
|
865
|
+
/** Sets the section title displayed above the fieldset content. */
|
|
713
866
|
sectionTitle?: string;
|
|
867
|
+
/** Sets when changes will be dispatched to the form. @default "continue" */
|
|
714
868
|
dispatchOn: GoabFormDispatchOn;
|
|
869
|
+
/** Emits when the fieldset continues to the next step. Emits the continue detail. */
|
|
715
870
|
onContinue: EventEmitter<GoabFieldsetOnContinueDetail>;
|
|
716
871
|
_onContinue(event: Event): void;
|
|
717
872
|
static ɵfac: i0.ɵɵFactoryDeclaration<GoabFieldset, never>;
|
|
@@ -720,31 +875,35 @@ declare class GoabFieldset {
|
|
|
720
875
|
|
|
721
876
|
declare class GoabFormItem extends GoabBaseComponent implements OnInit {
|
|
722
877
|
private cdr;
|
|
878
|
+
/** Creates a label for the form item. */
|
|
723
879
|
label?: string;
|
|
880
|
+
/** Sets the label size. 'regular' for standard, 'large' for emphasis. */
|
|
724
881
|
labelSize?: GoabFormItemLabelSize;
|
|
882
|
+
/** Help text displayed under the form field to provide additional explanation. */
|
|
725
883
|
helpText?: string;
|
|
884
|
+
/** Error text displayed under the form field. Leave blank to indicate a valid field. */
|
|
726
885
|
error?: string;
|
|
886
|
+
/** Marks the field with an optional or required label indicator. */
|
|
727
887
|
requirement?: GoabFormItemRequirement;
|
|
888
|
+
/** Sets the maximum width of the form item. */
|
|
728
889
|
maxWidth?: string;
|
|
890
|
+
/** Sets the id attribute on the form item element. */
|
|
729
891
|
id?: string;
|
|
892
|
+
/** Specifies the input type for appropriate message spacing. Used with checkbox-list or radio-group. */
|
|
730
893
|
type?: GoabFormItemType;
|
|
731
|
-
/**
|
|
732
|
-
* Public form: to arrange fields in the summary
|
|
733
|
-
*/
|
|
894
|
+
/** Sets the display order within the form summary. For public-form use only. */
|
|
734
895
|
publicFormSummaryOrder?: number;
|
|
735
|
-
/**
|
|
736
|
-
* Public form: allow to override the label value within the form-summary to provide a shorter description of the value
|
|
737
|
-
*/
|
|
896
|
+
/** Overrides the label value within the form-summary to provide a shorter description. For public-form use only. */
|
|
738
897
|
name?: string;
|
|
739
898
|
isReady: boolean;
|
|
740
899
|
version: string;
|
|
741
|
-
constructor(cdr: ChangeDetectorRef);
|
|
742
900
|
ngOnInit(): void;
|
|
743
901
|
static ɵfac: i0.ɵɵFactoryDeclaration<GoabFormItem, never>;
|
|
744
902
|
static ɵcmp: i0.ɵɵComponentDeclaration<GoabFormItem, "goab-form-item", never, { "label": { "alias": "label"; "required": false; }; "labelSize": { "alias": "labelSize"; "required": false; }; "helpText": { "alias": "helpText"; "required": false; }; "error": { "alias": "error"; "required": false; }; "requirement": { "alias": "requirement"; "required": false; }; "maxWidth": { "alias": "maxWidth"; "required": false; }; "id": { "alias": "id"; "required": false; }; "type": { "alias": "type"; "required": false; }; "publicFormSummaryOrder": { "alias": "publicFormSummaryOrder"; "required": false; }; "name": { "alias": "name"; "required": false; }; }, {}, never, ["*", "goab-form-item-slot"], true, never>;
|
|
745
903
|
}
|
|
746
904
|
|
|
747
905
|
declare class GoabFormItemSlot {
|
|
906
|
+
/** @required Sets which form-item slot this content should render into. */
|
|
748
907
|
slot: "helptext" | "error";
|
|
749
908
|
static ɵfac: i0.ɵɵFactoryDeclaration<GoabFormItemSlot, never>;
|
|
750
909
|
static ɵcmp: i0.ɵɵComponentDeclaration<GoabFormItemSlot, "goab-form-item-slot", never, { "slot": { "alias": "slot"; "required": true; }; }, {}, never, ["*"], true, never>;
|
|
@@ -752,10 +911,11 @@ declare class GoabFormItemSlot {
|
|
|
752
911
|
|
|
753
912
|
declare class GoabFormStep implements OnInit {
|
|
754
913
|
private cdr;
|
|
914
|
+
/** The step label text displayed to users. */
|
|
755
915
|
text?: string;
|
|
916
|
+
/** The completion status of the step. Affects visual styling and icons. */
|
|
756
917
|
status?: GoabFormStepStatus;
|
|
757
918
|
isReady: boolean;
|
|
758
|
-
constructor(cdr: ChangeDetectorRef);
|
|
759
919
|
ngOnInit(): void;
|
|
760
920
|
static ɵfac: i0.ɵɵFactoryDeclaration<GoabFormStep, never>;
|
|
761
921
|
static ɵcmp: i0.ɵɵComponentDeclaration<GoabFormStep, "goab-form-step", never, { "text": { "alias": "text"; "required": false; }; "status": { "alias": "status"; "required": false; }; }, {}, never, never, true, never>;
|
|
@@ -763,10 +923,11 @@ declare class GoabFormStep implements OnInit {
|
|
|
763
923
|
|
|
764
924
|
declare class GoabFormStepper extends GoabBaseComponent implements OnInit {
|
|
765
925
|
private cdr;
|
|
926
|
+
/** The current step state value (1-based index). Leaving it blank (-1) will allow any step to be accessed. @default -1 */
|
|
766
927
|
step?: number;
|
|
928
|
+
/** Emits when the form stepper step changes. Emits the new step as GoabFormStepperOnChangeDetail. */
|
|
767
929
|
onChange: EventEmitter<GoabFormStepperOnChangeDetail>;
|
|
768
930
|
isReady: boolean;
|
|
769
|
-
constructor(cdr: ChangeDetectorRef);
|
|
770
931
|
ngOnInit(): void;
|
|
771
932
|
_onChange(e: Event): void;
|
|
772
933
|
static ɵfac: i0.ɵɵFactoryDeclaration<GoabFormStepper, never>;
|
|
@@ -776,9 +937,10 @@ declare class GoabFormStepper extends GoabBaseComponent implements OnInit {
|
|
|
776
937
|
declare class GoabGrid extends GoabBaseComponent implements OnInit {
|
|
777
938
|
private cdr;
|
|
778
939
|
isReady: boolean;
|
|
940
|
+
/** @required Minimum width of the child elements. */
|
|
779
941
|
minChildWidth: string;
|
|
942
|
+
/** Gap between child items. */
|
|
780
943
|
gap?: Spacing;
|
|
781
|
-
constructor(cdr: ChangeDetectorRef);
|
|
782
944
|
ngOnInit(): void;
|
|
783
945
|
static ɵfac: i0.ɵɵFactoryDeclaration<GoabGrid, never>;
|
|
784
946
|
static ɵcmp: i0.ɵɵComponentDeclaration<GoabGrid, "goab-grid", never, { "minChildWidth": { "alias": "minChildWidth"; "required": true; }; "gap": { "alias": "gap"; "required": false; }; }, {}, never, ["*"], true, never>;
|
|
@@ -786,15 +948,20 @@ declare class GoabGrid extends GoabBaseComponent implements OnInit {
|
|
|
786
948
|
|
|
787
949
|
declare class GoabAppHeader extends GoabBaseComponent implements OnInit {
|
|
788
950
|
private cdr;
|
|
951
|
+
/** Sets the URL to link from the alberta.ca logo. A full url is required. */
|
|
789
952
|
url?: string;
|
|
953
|
+
/** Sets the service name to display in the app header. */
|
|
790
954
|
heading?: string;
|
|
955
|
+
/** V2 only: Secondary text displayed under the service name. */
|
|
791
956
|
secondaryText?: string;
|
|
957
|
+
/** Maximum width of the content area. */
|
|
792
958
|
maxContentWidth?: string;
|
|
959
|
+
/** Sets the breakpoint in px for the full menu to display. */
|
|
793
960
|
fullMenuBreakpoint?: number;
|
|
794
961
|
isReady: boolean;
|
|
795
962
|
version: string;
|
|
796
|
-
constructor(cdr: ChangeDetectorRef);
|
|
797
963
|
ngOnInit(): void;
|
|
964
|
+
/** Emits when the menu button is clicked. Used for custom menu handling. */
|
|
798
965
|
onMenuClick: EventEmitter<any>;
|
|
799
966
|
_onMenuClick(): void;
|
|
800
967
|
static ɵfac: i0.ɵɵFactoryDeclaration<GoabAppHeader, never>;
|
|
@@ -804,12 +971,14 @@ declare class GoabAppHeader extends GoabBaseComponent implements OnInit {
|
|
|
804
971
|
|
|
805
972
|
declare class GoabAppHeaderMenu extends GoabBaseComponent implements OnInit {
|
|
806
973
|
private cdr;
|
|
974
|
+
/** Icon displayed before the heading text. */
|
|
807
975
|
leadingIcon?: GoabIconType;
|
|
976
|
+
/** The menu heading text displayed as the dropdown trigger. */
|
|
808
977
|
heading?: string;
|
|
978
|
+
/** Sets the slot name for the component. */
|
|
809
979
|
slotName?: string;
|
|
810
980
|
get hostSlot(): string | null;
|
|
811
981
|
isReady: boolean;
|
|
812
|
-
constructor(cdr: ChangeDetectorRef);
|
|
813
982
|
ngOnInit(): void;
|
|
814
983
|
static ɵfac: i0.ɵɵFactoryDeclaration<GoabAppHeaderMenu, never>;
|
|
815
984
|
static ɵcmp: i0.ɵɵComponentDeclaration<GoabAppHeaderMenu, "goab-app-header-menu", never, { "leadingIcon": { "alias": "leadingIcon"; "required": false; }; "heading": { "alias": "heading"; "required": false; }; "slotName": { "alias": "slotName"; "required": false; }; }, {}, never, ["*"], true, never>;
|
|
@@ -818,15 +987,22 @@ declare class GoabAppHeaderMenu extends GoabBaseComponent implements OnInit {
|
|
|
818
987
|
declare class GoabHeroBanner implements OnInit {
|
|
819
988
|
private cdr;
|
|
820
989
|
isReady: boolean;
|
|
990
|
+
/** Main heading text. */
|
|
821
991
|
heading?: string;
|
|
992
|
+
/** Background image url. */
|
|
822
993
|
backgroundUrl?: string;
|
|
994
|
+
/** Minimum height of the hero banner. Defaults to 600px when a background image is provided. */
|
|
823
995
|
minHeight?: string;
|
|
996
|
+
/** Sets a data-testid attribute for automated testing. */
|
|
824
997
|
testId?: string;
|
|
998
|
+
/** Maximum width of the content area. */
|
|
825
999
|
maxContentWidth?: string;
|
|
1000
|
+
/** Hero Banner background color when no background image is provided. */
|
|
826
1001
|
backgroundColor?: string;
|
|
1002
|
+
/** Text color within the hero banner. */
|
|
827
1003
|
textColor?: string;
|
|
1004
|
+
/** Angular template reference for the actions slot content. */
|
|
828
1005
|
actions: TemplateRef<any>;
|
|
829
|
-
constructor(cdr: ChangeDetectorRef);
|
|
830
1006
|
ngOnInit(): void;
|
|
831
1007
|
static ɵfac: i0.ɵɵFactoryDeclaration<GoabHeroBanner, never>;
|
|
832
1008
|
static ɵcmp: i0.ɵɵComponentDeclaration<GoabHeroBanner, "goab-hero-banner", never, { "heading": { "alias": "heading"; "required": false; }; "backgroundUrl": { "alias": "backgroundUrl"; "required": false; }; "minHeight": { "alias": "minHeight"; "required": false; }; "testId": { "alias": "testId"; "required": false; }; "maxContentWidth": { "alias": "maxContentWidth"; "required": false; }; "backgroundColor": { "alias": "backgroundColor"; "required": false; }; "textColor": { "alias": "textColor"; "required": false; }; "actions": { "alias": "actions"; "required": false; }; }, {}, never, ["*"], true, never>;
|
|
@@ -834,16 +1010,23 @@ declare class GoabHeroBanner implements OnInit {
|
|
|
834
1010
|
|
|
835
1011
|
declare class GoabIcon extends GoabBaseComponent implements OnInit {
|
|
836
1012
|
private cdr;
|
|
1013
|
+
/** @required The icon type to display. See GoabIconType for available icons. */
|
|
837
1014
|
type: GoabIconType | GoabIconOverridesType;
|
|
1015
|
+
/** Sets the size of the icon. Accepts numeric (1-6) or named sizes. @default "medium" */
|
|
838
1016
|
size?: GoabIconSize;
|
|
1017
|
+
/** Sets the icon theme. 'outline' shows stroked icons, 'filled' shows solid icons. */
|
|
839
1018
|
theme?: GoabIconTheme;
|
|
1019
|
+
/** When true, inverts the icon colors for use on dark backgrounds. */
|
|
840
1020
|
inverted?: boolean;
|
|
1021
|
+
/** Sets a custom fill color for the icon. Accepts any valid CSS color value. */
|
|
841
1022
|
fillColor?: string;
|
|
1023
|
+
/** Sets the opacity of the icon from 0 (transparent) to 1 (opaque). */
|
|
842
1024
|
opacity?: number;
|
|
1025
|
+
/** Adds an accessible title to the icon SVG. Used by screen readers. */
|
|
843
1026
|
title?: string;
|
|
1027
|
+
/** Defines how the icon will be announced by screen readers. */
|
|
844
1028
|
ariaLabel?: string;
|
|
845
1029
|
isReady: boolean;
|
|
846
|
-
constructor(cdr: ChangeDetectorRef);
|
|
847
1030
|
ngOnInit(): void;
|
|
848
1031
|
static ɵfac: i0.ɵɵFactoryDeclaration<GoabIcon, never>;
|
|
849
1032
|
static ɵcmp: i0.ɵɵComponentDeclaration<GoabIcon, "goab-icon", never, { "type": { "alias": "type"; "required": true; }; "size": { "alias": "size"; "required": false; }; "theme": { "alias": "theme"; "required": false; }; "inverted": { "alias": "inverted"; "required": false; }; "fillColor": { "alias": "fillColor"; "required": false; }; "opacity": { "alias": "opacity"; "required": false; }; "title": { "alias": "title"; "required": false; }; "ariaLabel": { "alias": "ariaLabel"; "required": false; }; }, {}, never, never, true, never>;
|
|
@@ -855,17 +1038,26 @@ declare class GoabIconButton extends GoabBaseComponent implements OnInit {
|
|
|
855
1038
|
private cdr;
|
|
856
1039
|
isReady: boolean;
|
|
857
1040
|
protected readonly JSON: JSON;
|
|
1041
|
+
/** @required Sets the icon. */
|
|
858
1042
|
icon: GoabIconType;
|
|
1043
|
+
/** Sets the size of button. @default "medium" */
|
|
859
1044
|
size?: GoabIconSize;
|
|
1045
|
+
/** Styles the button to show color, light, dark or destructive action. */
|
|
860
1046
|
variant?: GoabIconButtonVariant;
|
|
1047
|
+
/** Sets the title of the button. */
|
|
861
1048
|
title?: string;
|
|
1049
|
+
/** Disables the button. */
|
|
862
1050
|
disabled?: boolean;
|
|
1051
|
+
/** Sets the aria-label of the button. */
|
|
863
1052
|
ariaLabel?: string;
|
|
1053
|
+
/** Action identifier passed in click events for event delegation patterns. */
|
|
864
1054
|
action?: string;
|
|
1055
|
+
/** Single argument value passed with the action in click events. */
|
|
865
1056
|
actionArg?: string;
|
|
1057
|
+
/** Multiple argument values passed with the action in click events. */
|
|
866
1058
|
actionArgs?: Record<string, unknown>;
|
|
1059
|
+
/** Emits when the icon button is clicked. */
|
|
867
1060
|
onClick: EventEmitter<any>;
|
|
868
|
-
constructor(cdr: ChangeDetectorRef);
|
|
869
1061
|
ngOnInit(): void;
|
|
870
1062
|
_onClick(): void;
|
|
871
1063
|
static ɵfac: i0.ɵɵFactoryDeclaration<GoabIconButton, never>;
|
|
@@ -875,40 +1067,69 @@ declare class GoabIconButton extends GoabBaseComponent implements OnInit {
|
|
|
875
1067
|
|
|
876
1068
|
declare class GoabInput extends GoabControlValueAccessor implements OnInit {
|
|
877
1069
|
private cdr;
|
|
1070
|
+
/** Sets the type of the input field. @default "text" */
|
|
878
1071
|
type?: GoabInputType;
|
|
1072
|
+
/** Name of input value that is received in the onChange event. */
|
|
879
1073
|
name?: string;
|
|
1074
|
+
/** Debounce delay in milliseconds before firing the change event. 0 means no debounce. */
|
|
880
1075
|
debounce?: number;
|
|
1076
|
+
/** Controls whether and how text input is automatically capitalized as it is entered/edited by the user. This only works on mobile devices. */
|
|
881
1077
|
autoCapitalize?: GoabInputAutoCapitalize;
|
|
1078
|
+
/** Specifies the autocomplete attribute for the input field. */
|
|
882
1079
|
autoComplete?: string;
|
|
1080
|
+
/** Text displayed within the input when no value is set. */
|
|
883
1081
|
placeholder?: string;
|
|
1082
|
+
/** Icon shown to the left of the text. */
|
|
884
1083
|
leadingIcon?: GoabIconType;
|
|
1084
|
+
/** Icon shown to the right of the text. */
|
|
885
1085
|
trailingIcon?: GoabIconType;
|
|
1086
|
+
/** Sets the visual style variant. 'goa' for standard GoA styling, 'bare' for minimal styling. */
|
|
886
1087
|
variant?: string;
|
|
1088
|
+
/** Sets the cursor focus to the input. */
|
|
887
1089
|
focused?: boolean;
|
|
1090
|
+
/** Makes the input readonly. */
|
|
888
1091
|
readonly?: boolean;
|
|
1092
|
+
/** Sets the width of the text input area. */
|
|
889
1093
|
width?: string;
|
|
1094
|
+
/** @deprecated Use leadingContent slot instead. */
|
|
890
1095
|
prefix?: string;
|
|
1096
|
+
/** @deprecated Use trailingContent slot instead. */
|
|
891
1097
|
suffix?: string;
|
|
1098
|
+
/** Defines how the input will be translated for the screen reader. If not specified it will fall back to the name. */
|
|
892
1099
|
ariaLabel?: string;
|
|
1100
|
+
/** Sets the maximum number of characters (as UTF-16 code units) the user can enter into the input. */
|
|
893
1101
|
maxLength?: number;
|
|
1102
|
+
/** A string value that supports any number, or an ISO 8601 format if using the date or datetime type. */
|
|
894
1103
|
min?: string | number;
|
|
1104
|
+
/** A string value that supports any number, or an ISO 8601 format if using the date or datetime type. */
|
|
895
1105
|
max?: string | number;
|
|
1106
|
+
/** How much a number or date should change by. */
|
|
896
1107
|
step?: number;
|
|
1108
|
+
/** The aria-labelledby attribute identifies the element (or elements) that labels the input. */
|
|
897
1109
|
ariaLabelledBy?: string;
|
|
1110
|
+
/** Aria label for the trailing icon. Use only when the trailing icon is interactive. */
|
|
898
1111
|
trailingIconAriaLabel?: string;
|
|
1112
|
+
/** Sets the text alignment within the input field. @default "left" */
|
|
899
1113
|
textAlign?: "left" | "right";
|
|
1114
|
+
/** Sets the leading content slot, accepting a string or template reference. */
|
|
900
1115
|
leadingContent: string | TemplateRef<any>;
|
|
1116
|
+
/** Sets the trailing content slot, accepting a string or template reference. */
|
|
901
1117
|
trailingContent: string | TemplateRef<any>;
|
|
1118
|
+
/** Sets the size of the input. 'compact' reduces height for dense layouts. @default "default" */
|
|
902
1119
|
size?: GoabInputSize;
|
|
1120
|
+
/** Emits when the trailing icon is clicked. */
|
|
903
1121
|
onTrailingIconClick: EventEmitter<any>;
|
|
1122
|
+
/** Emits when the input receives focus. Emits focus detail including the current value. */
|
|
904
1123
|
onFocus: EventEmitter<GoabInputOnFocusDetail>;
|
|
1124
|
+
/** Emits when the input loses focus. Emits blur detail including the current value. */
|
|
905
1125
|
onBlur: EventEmitter<GoabInputOnBlurDetail>;
|
|
1126
|
+
/** Emits when a key is pressed in the input. Emits key press detail including the value and key pressed. */
|
|
906
1127
|
onKeyPress: EventEmitter<GoabInputOnKeyPressDetail>;
|
|
1128
|
+
/** Emits when the input value changes. Emits change detail including the new value. */
|
|
907
1129
|
onChange: EventEmitter<GoabInputOnChangeDetail>;
|
|
908
1130
|
version: string;
|
|
909
1131
|
isReady: boolean;
|
|
910
1132
|
handleTrailingIconClick: boolean;
|
|
911
|
-
constructor(cdr: ChangeDetectorRef, renderer: Renderer2);
|
|
912
1133
|
ngOnInit(): void;
|
|
913
1134
|
_onTrailingIconClick(_: Event): void;
|
|
914
1135
|
_onChange(e: Event): void;
|
|
@@ -931,45 +1152,81 @@ declare class GoabInput extends GoabControlValueAccessor implements OnInit {
|
|
|
931
1152
|
declare class GoabInputNumber implements ControlValueAccessor, OnInit {
|
|
932
1153
|
private cdr;
|
|
933
1154
|
isReady: boolean;
|
|
1155
|
+
/** Sets the type of the input field. @default "number" */
|
|
934
1156
|
type: GoabInputType;
|
|
1157
|
+
/** Name of input value that is received in the onChange event. */
|
|
935
1158
|
name?: string;
|
|
1159
|
+
/** Unique identifier for the input element. Used for label associations and accessibility. */
|
|
936
1160
|
id?: string;
|
|
1161
|
+
/** Debounce delay in milliseconds before firing the change event. 0 means no debounce. */
|
|
937
1162
|
debounce?: number;
|
|
1163
|
+
/** Disables this input. The input will not receive focus or events. */
|
|
938
1164
|
disabled?: boolean;
|
|
1165
|
+
/** Controls whether and how text input is automatically capitalized as it is entered/edited by the user. This only works on mobile devices. */
|
|
939
1166
|
autoCapitalize?: GoabInputAutoCapitalize;
|
|
1167
|
+
/** Text displayed within the input when no value is set. */
|
|
940
1168
|
placeholder?: string;
|
|
1169
|
+
/** Icon shown to the left of the text. */
|
|
941
1170
|
leadingIcon?: GoabIconType;
|
|
1171
|
+
/** Icon shown to the right of the text. */
|
|
942
1172
|
trailingIcon?: GoabIconType;
|
|
1173
|
+
/** Sets the visual style variant. 'goa' for standard GoA styling, 'bare' for minimal styling. */
|
|
943
1174
|
variant?: string;
|
|
1175
|
+
/** Sets the cursor focus to the input. */
|
|
944
1176
|
focused?: boolean;
|
|
1177
|
+
/** Makes the input readonly. */
|
|
945
1178
|
readonly?: boolean;
|
|
1179
|
+
/** Sets the input to an error state. */
|
|
946
1180
|
error?: boolean;
|
|
1181
|
+
/** Sets the width of the text input area. */
|
|
947
1182
|
width?: string;
|
|
1183
|
+
/** @deprecated Use leadingContent slot instead. */
|
|
948
1184
|
prefix?: string;
|
|
1185
|
+
/** @deprecated Use trailingContent slot instead. */
|
|
949
1186
|
suffix?: string;
|
|
1187
|
+
/** Sets a data-testid attribute for automated testing. */
|
|
950
1188
|
testId?: string;
|
|
1189
|
+
/** Defines how the input will be translated for the screen reader. If not specified it will fall back to the name. */
|
|
951
1190
|
ariaLabel?: string;
|
|
1191
|
+
/** Sets the maximum number of characters (as UTF-16 code units) the user can enter into the input. */
|
|
952
1192
|
maxLength?: number;
|
|
1193
|
+
/** A string value that supports any number, or an ISO 8601 format if using the date or datetime type. */
|
|
953
1194
|
min?: string | number;
|
|
1195
|
+
/** A string value that supports any number, or an ISO 8601 format if using the date or datetime type. */
|
|
954
1196
|
max?: string | number;
|
|
1197
|
+
/** How much a number or date should change by. */
|
|
955
1198
|
step?: number;
|
|
1199
|
+
/** The aria-labelledby attribute identifies the element (or elements) that labels the input. */
|
|
956
1200
|
ariaLabelledBy?: string;
|
|
1201
|
+
/** Top margin. */
|
|
957
1202
|
mt?: Spacing;
|
|
1203
|
+
/** Right margin. */
|
|
958
1204
|
mr?: Spacing;
|
|
1205
|
+
/** Bottom margin. */
|
|
959
1206
|
mb?: Spacing;
|
|
1207
|
+
/** Left margin. */
|
|
960
1208
|
ml?: Spacing;
|
|
1209
|
+
/** Aria label for the trailing icon. Use only when the trailing icon is interactive. */
|
|
961
1210
|
trailingIconAriaLabel?: string;
|
|
1211
|
+
/** Sets the text alignment within the input field. @default "right" */
|
|
962
1212
|
textAlign?: "left" | "right";
|
|
1213
|
+
/** Bound to value. */
|
|
963
1214
|
value: number | null;
|
|
1215
|
+
/** Sets the leading content slot, accepting a string or template reference. */
|
|
964
1216
|
leadingContent: string | TemplateRef<any>;
|
|
1217
|
+
/** Sets the trailing content slot, accepting a string or template reference. */
|
|
965
1218
|
trailingContent: string | TemplateRef<any>;
|
|
1219
|
+
/** Emits when the trailing icon is clicked. */
|
|
966
1220
|
onTrailingIconClick: EventEmitter<void>;
|
|
1221
|
+
/** Emits when the input receives focus. Emits focus detail including the current value. */
|
|
967
1222
|
onFocus: EventEmitter<GoabInputOnFocusDetail>;
|
|
1223
|
+
/** Emits when the input loses focus. Emits blur detail including the current value. */
|
|
968
1224
|
onBlur: EventEmitter<GoabInputOnBlurDetail>;
|
|
1225
|
+
/** Emits when a key is pressed in the input. Emits key press detail including the value and key pressed. */
|
|
969
1226
|
onKeyPress: EventEmitter<GoabInputOnKeyPressDetail>;
|
|
1227
|
+
/** Emits when the input value changes. Emits change detail including the new value. */
|
|
970
1228
|
onChange: EventEmitter<GoabInputOnChangeDetail>;
|
|
971
1229
|
handleTrailingIconClick: boolean;
|
|
972
|
-
constructor(cdr: ChangeDetectorRef);
|
|
973
1230
|
ngOnInit(): void;
|
|
974
1231
|
_onTrailingIconClick(_: Event): void;
|
|
975
1232
|
_onChange(e: Event): void;
|
|
@@ -1001,13 +1258,17 @@ declare class GoabInputNumber implements ControlValueAccessor, OnInit {
|
|
|
1001
1258
|
|
|
1002
1259
|
declare class GoabLinearProgress implements OnInit {
|
|
1003
1260
|
private cdr;
|
|
1261
|
+
/** Progress value (0-100). When undefined, shows an indeterminate loading animation. */
|
|
1004
1262
|
progress?: number | null | undefined;
|
|
1263
|
+
/** Controls visibility of the percentage text. */
|
|
1005
1264
|
percentVisibility?: "visible" | "hidden" | undefined;
|
|
1265
|
+
/** Accessible label for the progress bar. */
|
|
1006
1266
|
ariaLabel?: string;
|
|
1267
|
+
/** ID of the element that labels this progress bar. */
|
|
1007
1268
|
ariaLabelledBy?: string;
|
|
1269
|
+
/** Sets a data-testid attribute for automated testing. */
|
|
1008
1270
|
testid?: string;
|
|
1009
1271
|
isReady: boolean;
|
|
1010
|
-
constructor(cdr: ChangeDetectorRef);
|
|
1011
1272
|
ngOnInit(): void;
|
|
1012
1273
|
static ɵfac: i0.ɵɵFactoryDeclaration<GoabLinearProgress, never>;
|
|
1013
1274
|
static ɵcmp: i0.ɵɵComponentDeclaration<GoabLinearProgress, "goab-linear-progress", never, { "progress": { "alias": "progress"; "required": false; }; "percentVisibility": { "alias": "percentVisibility"; "required": false; }; "ariaLabel": { "alias": "ariaLabel"; "required": false; }; "ariaLabelledBy": { "alias": "ariaLabelledBy"; "required": false; }; "testid": { "alias": "testid"; "required": false; }; }, {}, never, never, true, never>;
|
|
@@ -1016,19 +1277,30 @@ declare class GoabLinearProgress implements OnInit {
|
|
|
1016
1277
|
declare class GoabLink implements OnInit {
|
|
1017
1278
|
private cdr;
|
|
1018
1279
|
isReady: boolean;
|
|
1280
|
+
/** Icon displayed before the link text. */
|
|
1019
1281
|
leadingIcon?: GoabIconType;
|
|
1282
|
+
/** Icon displayed after the link text. */
|
|
1020
1283
|
trailingIcon?: GoabIconType;
|
|
1284
|
+
/** Sets a data-testid attribute for automated testing. */
|
|
1021
1285
|
testId?: string;
|
|
1286
|
+
/** Custom action event name to dispatch when the link is clicked. */
|
|
1022
1287
|
action?: string;
|
|
1288
|
+
/** Sets the color theme. 'interactive' for blue, 'dark' for black, 'light' for white text. @default "interactive" */
|
|
1023
1289
|
color?: GoabLinkColor;
|
|
1290
|
+
/** Sets the text size and corresponding icon size. @default "medium" */
|
|
1024
1291
|
size?: GoabLinkSize;
|
|
1292
|
+
/** Single argument to pass with the action event (deprecated, use actionArgs). */
|
|
1025
1293
|
actionArg?: string;
|
|
1294
|
+
/** Object of arguments to pass with the action event. */
|
|
1026
1295
|
actionArgs?: Record<string, unknown>;
|
|
1296
|
+
/** Top margin. */
|
|
1027
1297
|
mt?: Spacing;
|
|
1298
|
+
/** Bottom margin. */
|
|
1028
1299
|
mb?: Spacing;
|
|
1300
|
+
/** Left margin. */
|
|
1029
1301
|
ml?: Spacing;
|
|
1302
|
+
/** Right margin. */
|
|
1030
1303
|
mr?: Spacing;
|
|
1031
|
-
constructor(cdr: ChangeDetectorRef);
|
|
1032
1304
|
ngOnInit(): void;
|
|
1033
1305
|
protected readonly JSON: JSON;
|
|
1034
1306
|
static ɵfac: i0.ɵɵFactoryDeclaration<GoabLink, never>;
|
|
@@ -1038,15 +1310,22 @@ declare class GoabLink implements OnInit {
|
|
|
1038
1310
|
declare class GoabMicrositeHeader implements OnInit {
|
|
1039
1311
|
private cdr;
|
|
1040
1312
|
isReady: boolean;
|
|
1313
|
+
/** @required The service type which determines the badge style. "live" shows official government site text, "alpha" and "beta" show development stage badges. */
|
|
1041
1314
|
type: GoabServiceLevel;
|
|
1315
|
+
/** @required App or service version displayed on the right side of the header. */
|
|
1042
1316
|
version: string | TemplateRef<any>;
|
|
1317
|
+
/** Url to feedback page that will be displayed when provided. */
|
|
1043
1318
|
feedbackUrl?: string;
|
|
1319
|
+
/** Sets a data-testid attribute for automated testing. */
|
|
1044
1320
|
testId?: string;
|
|
1321
|
+
/** Maximum width of the content area. */
|
|
1045
1322
|
maxContentWidth?: string;
|
|
1323
|
+
/** For internal feedback urls sets target. */
|
|
1046
1324
|
feedbackUrlTarget?: GoabLinkTarget;
|
|
1325
|
+
/** Sets the target attribute for the header link. */
|
|
1047
1326
|
headerUrlTarget?: GoabLinkTarget;
|
|
1048
|
-
constructor(cdr: ChangeDetectorRef);
|
|
1049
1327
|
ngOnInit(): void;
|
|
1328
|
+
/** Emits when the feedback link is clicked. */
|
|
1050
1329
|
onFeedbackClick: EventEmitter<any>;
|
|
1051
1330
|
getVersionAsString(): string;
|
|
1052
1331
|
getVersionAsTemplate(): TemplateRef<any> | null;
|
|
@@ -1059,21 +1338,29 @@ declare class GoabModal implements OnInit {
|
|
|
1059
1338
|
private cdr;
|
|
1060
1339
|
isReady: boolean;
|
|
1061
1340
|
version: string;
|
|
1062
|
-
constructor(cdr: ChangeDetectorRef);
|
|
1063
1341
|
ngOnInit(): void;
|
|
1342
|
+
/** Define the context and colour of the callout modal. It is required when type is set to callout. */
|
|
1064
1343
|
calloutVariant?: GoabModalCalloutVariant;
|
|
1344
|
+
/** Controls if modal is visible or not. */
|
|
1065
1345
|
open?: boolean;
|
|
1346
|
+
/** Set the max allowed width of the modal. */
|
|
1066
1347
|
maxWidth?: string;
|
|
1348
|
+
/** Show close icon and allow clicking the background to close the modal. */
|
|
1067
1349
|
closable: boolean;
|
|
1350
|
+
/** Sets the animation transition when opening/closing. 'fast' or 'slow' for animated, 'none' for instant. */
|
|
1068
1351
|
transition?: GoabModalTransition;
|
|
1352
|
+
/** Sets a data-testid attribute for automated testing. */
|
|
1069
1353
|
testId?: string;
|
|
1070
1354
|
/**
|
|
1071
1355
|
* @deprecated The role property is deprecated and will be removed in a future version.
|
|
1072
1356
|
* The modal will always use role="dialog".
|
|
1073
1357
|
*/
|
|
1074
1358
|
role?: string;
|
|
1359
|
+
/** The heading text displayed at the top of the modal. */
|
|
1075
1360
|
heading: string | TemplateRef<any>;
|
|
1361
|
+
/** Sets the template reference for the modal action buttons. */
|
|
1076
1362
|
actions: TemplateRef<any>;
|
|
1363
|
+
/** Emits when the modal is closed. */
|
|
1077
1364
|
onClose: EventEmitter<any>;
|
|
1078
1365
|
getHeadingAsString(): string;
|
|
1079
1366
|
getHeadingAsTemplate(): TemplateRef<any> | null;
|
|
@@ -1084,14 +1371,23 @@ declare class GoabModal implements OnInit {
|
|
|
1084
1371
|
}
|
|
1085
1372
|
|
|
1086
1373
|
declare class GoabMenuButton {
|
|
1374
|
+
/** The button label text. When provided, displays as a text button with a dropdown icon. */
|
|
1087
1375
|
text?: string;
|
|
1376
|
+
/** The button style variant. */
|
|
1088
1377
|
type?: GoabButtonType;
|
|
1378
|
+
/** Sets the size of the button. */
|
|
1089
1379
|
size?: GoabButtonSize;
|
|
1380
|
+
/** Sets the color variant for semantic meaning. */
|
|
1090
1381
|
variant?: GoabButtonVariant;
|
|
1382
|
+
/** Maximum width of the dropdown menu. */
|
|
1091
1383
|
maxWidth?: string;
|
|
1384
|
+
/** Icon displayed before the button text. When no text is provided, displays as an icon button. */
|
|
1092
1385
|
leadingIcon?: GoabIconType;
|
|
1386
|
+
/** Sets the aria-label for the icon button in icon-only mode. */
|
|
1093
1387
|
ariaLabel?: string;
|
|
1388
|
+
/** Sets a data-testid attribute for automated testing. */
|
|
1094
1389
|
testId?: string;
|
|
1390
|
+
/** Emits when a menu action is clicked. Emits the action detail. */
|
|
1095
1391
|
onAction: EventEmitter<GoabMenuButtonOnActionDetail>;
|
|
1096
1392
|
_onAction(e: Event): void;
|
|
1097
1393
|
static ɵfac: i0.ɵɵFactoryDeclaration<GoabMenuButton, never>;
|
|
@@ -1099,9 +1395,13 @@ declare class GoabMenuButton {
|
|
|
1099
1395
|
}
|
|
1100
1396
|
|
|
1101
1397
|
declare class GoabMenuAction {
|
|
1398
|
+
/** @required Display text for the menu action. */
|
|
1102
1399
|
text: string;
|
|
1400
|
+
/** @required Action identifier included in the click event. */
|
|
1103
1401
|
action: string;
|
|
1402
|
+
/** Icon displayed before the text. */
|
|
1104
1403
|
icon?: GoabIconType;
|
|
1404
|
+
/** Sets a data-testid attribute for automated testing. */
|
|
1105
1405
|
testId?: string;
|
|
1106
1406
|
static ɵfac: i0.ɵɵFactoryDeclaration<GoabMenuAction, never>;
|
|
1107
1407
|
static ɵcmp: i0.ɵɵComponentDeclaration<GoabMenuAction, "goab-menu-action", never, { "text": { "alias": "text"; "required": true; }; "action": { "alias": "action"; "required": true; }; "icon": { "alias": "icon"; "required": false; }; "testId": { "alias": "testId"; "required": false; }; }, {}, never, never, true, never>;
|
|
@@ -1111,14 +1411,20 @@ declare class GoabNotification implements OnInit {
|
|
|
1111
1411
|
private cdr;
|
|
1112
1412
|
isReady: boolean;
|
|
1113
1413
|
version: string;
|
|
1414
|
+
/** Define the context and colour of the notification. @default "information" */
|
|
1114
1415
|
type?: GoabNotificationType;
|
|
1416
|
+
/** Indicates how assistive technology should handle updates to the live region. */
|
|
1115
1417
|
ariaLive?: GoabAriaLiveType;
|
|
1418
|
+
/** Maximum width of the content area. */
|
|
1116
1419
|
maxContentWidth?: string;
|
|
1420
|
+
/** Sets the visual prominence. 'high' for full background, 'low' for medium. @default "high" */
|
|
1117
1421
|
emphasis?: GoabNotificationEmphasis;
|
|
1422
|
+
/** When true, reduces padding for a more compact notification. */
|
|
1118
1423
|
compact?: boolean;
|
|
1424
|
+
/** Sets a data-testid attribute for automated testing. */
|
|
1119
1425
|
testId?: string;
|
|
1120
|
-
constructor(cdr: ChangeDetectorRef);
|
|
1121
1426
|
ngOnInit(): void;
|
|
1427
|
+
/** Emits when the notification is dismissed. */
|
|
1122
1428
|
onDismiss: EventEmitter<any>;
|
|
1123
1429
|
_onDismiss(): void;
|
|
1124
1430
|
static ɵfac: i0.ɵɵFactoryDeclaration<GoabNotification, never>;
|
|
@@ -1129,9 +1435,10 @@ declare class GoabNotification implements OnInit {
|
|
|
1129
1435
|
declare class GoabPageBlock implements OnInit {
|
|
1130
1436
|
private cdr;
|
|
1131
1437
|
isReady: boolean;
|
|
1438
|
+
/** Maximum width of the content area. Use "full" for 100% width or a CSS dimension like "1200px". */
|
|
1132
1439
|
width?: GoabPageBlockSize;
|
|
1440
|
+
/** Sets a data-testid attribute for automated testing. */
|
|
1133
1441
|
testId?: string;
|
|
1134
|
-
constructor(cdr: ChangeDetectorRef);
|
|
1135
1442
|
ngOnInit(): void;
|
|
1136
1443
|
static ɵfac: i0.ɵɵFactoryDeclaration<GoabPageBlock, never>;
|
|
1137
1444
|
static ɵcmp: i0.ɵɵComponentDeclaration<GoabPageBlock, "goab-page-block", never, { "width": { "alias": "width"; "required": false; }; "testId": { "alias": "testId"; "required": false; }; }, {}, never, ["*"], true, never>;
|
|
@@ -1140,8 +1447,8 @@ declare class GoabPageBlock implements OnInit {
|
|
|
1140
1447
|
declare class GoabPages extends GoabBaseComponent implements OnInit {
|
|
1141
1448
|
private cdr;
|
|
1142
1449
|
isReady: boolean;
|
|
1450
|
+
/** The currently visible page (1-based index). */
|
|
1143
1451
|
current?: number;
|
|
1144
|
-
constructor(cdr: ChangeDetectorRef);
|
|
1145
1452
|
ngOnInit(): void;
|
|
1146
1453
|
static ɵfac: i0.ɵɵFactoryDeclaration<GoabPages, never>;
|
|
1147
1454
|
static ɵcmp: i0.ɵɵComponentDeclaration<GoabPages, "goab-pages", never, { "current": { "alias": "current"; "required": false; }; }, {}, never, ["*"], true, never>;
|
|
@@ -1152,12 +1459,16 @@ declare class GoabPagination extends GoabBaseComponent implements OnInit {
|
|
|
1152
1459
|
private cdr;
|
|
1153
1460
|
isReady: boolean;
|
|
1154
1461
|
version: string;
|
|
1462
|
+
/** @required Total number of data items within all pages. */
|
|
1155
1463
|
itemCount: number;
|
|
1464
|
+
/** @required The current page being viewed (non-zero based). */
|
|
1156
1465
|
pageNumber: number;
|
|
1466
|
+
/** Number of data items shown per page. @default 10 */
|
|
1157
1467
|
perPageCount?: number;
|
|
1468
|
+
/** Controls which nav controls are visible. @default "all" */
|
|
1158
1469
|
variant?: GoabPaginationVariant;
|
|
1159
|
-
constructor(cdr: ChangeDetectorRef);
|
|
1160
1470
|
ngOnInit(): void;
|
|
1471
|
+
/** Emits when the page changes. Emits the new page number as part of the change detail. */
|
|
1161
1472
|
onChange: EventEmitter<GoabPaginationOnChangeDetail>;
|
|
1162
1473
|
_onChange(e: Event): void;
|
|
1163
1474
|
static ɵfac: i0.ɵɵFactoryDeclaration<GoabPagination, never>;
|
|
@@ -1167,16 +1478,18 @@ declare class GoabPagination extends GoabBaseComponent implements OnInit {
|
|
|
1167
1478
|
declare class GoabPopover extends GoabBaseComponent implements OnInit {
|
|
1168
1479
|
private cdr;
|
|
1169
1480
|
isReady: boolean;
|
|
1481
|
+
/** Sets the maximum width of the popover container. @default "320px" */
|
|
1170
1482
|
maxWidth: string;
|
|
1483
|
+
/** Sets the minimum width of the popover container. */
|
|
1171
1484
|
minWidth?: string;
|
|
1485
|
+
/** Sets if the popover has padding. Use false when content needs to be flush with boundaries. @default true */
|
|
1172
1486
|
padded: boolean;
|
|
1487
|
+
/** Provides control to where the popover content is positioned. */
|
|
1173
1488
|
position?: GoabPopoverPosition;
|
|
1174
|
-
|
|
1175
|
-
* @deprecated This property has no effect and will be removed in a future version
|
|
1176
|
-
*/
|
|
1489
|
+
/** @deprecated This property has no effect and will be removed in a future version. */
|
|
1177
1490
|
relative?: boolean;
|
|
1491
|
+
/** @required Sets the target template reference for the popover trigger. */
|
|
1178
1492
|
target: TemplateRef<any>;
|
|
1179
|
-
constructor(cdr: ChangeDetectorRef);
|
|
1180
1493
|
ngOnInit(): void;
|
|
1181
1494
|
static ɵfac: i0.ɵɵFactoryDeclaration<GoabPopover, never>;
|
|
1182
1495
|
static ɵcmp: i0.ɵɵComponentDeclaration<GoabPopover, "goab-popover", never, { "maxWidth": { "alias": "maxWidth"; "required": false; }; "minWidth": { "alias": "minWidth"; "required": false; }; "padded": { "alias": "padded"; "required": false; }; "position": { "alias": "position"; "required": false; }; "relative": { "alias": "relative"; "required": false; }; "target": { "alias": "target"; "required": true; }; }, {}, never, ["*"], true, never>;
|
|
@@ -1185,14 +1498,19 @@ declare class GoabPopover extends GoabBaseComponent implements OnInit {
|
|
|
1185
1498
|
declare class GoabPushDrawer implements OnInit {
|
|
1186
1499
|
private cdr;
|
|
1187
1500
|
version: string;
|
|
1501
|
+
/** Sets the open state of the push drawer. */
|
|
1188
1502
|
open?: boolean;
|
|
1503
|
+
/** Sets the heading text or template for the push drawer. */
|
|
1189
1504
|
heading: string | TemplateRef<any>;
|
|
1505
|
+
/** Sets the width of the push drawer panel. */
|
|
1190
1506
|
width?: string;
|
|
1507
|
+
/** Sets a data-testid attribute for automated testing. */
|
|
1191
1508
|
testId?: string;
|
|
1509
|
+
/** Sets the template reference for the actions slot content. */
|
|
1192
1510
|
actions: TemplateRef<any>;
|
|
1511
|
+
/** Emits when the push drawer closes. */
|
|
1193
1512
|
onClose: EventEmitter<any>;
|
|
1194
1513
|
isReady: boolean;
|
|
1195
|
-
constructor(cdr: ChangeDetectorRef);
|
|
1196
1514
|
ngOnInit(): void;
|
|
1197
1515
|
_onClose(): void;
|
|
1198
1516
|
getHeadingAsString(): string;
|
|
@@ -1206,12 +1524,16 @@ declare class GoabRadioGroup extends GoabControlValueAccessor implements OnInit
|
|
|
1206
1524
|
private cdr;
|
|
1207
1525
|
isReady: boolean;
|
|
1208
1526
|
version: string;
|
|
1527
|
+
/** The name for the radio group. Used for accessibility and change events. */
|
|
1209
1528
|
name?: string;
|
|
1529
|
+
/** Sets the layout direction. 'vertical' stacks items, 'horizontal' places them in a row. */
|
|
1210
1530
|
orientation?: GoabRadioGroupOrientation;
|
|
1531
|
+
/** Defines how the radio group will be announced by screen readers. */
|
|
1211
1532
|
ariaLabel?: string;
|
|
1533
|
+
/** Sets the size of all radio items. 'compact' reduces spacing for dense layouts (V2 only). @default "default" */
|
|
1212
1534
|
size?: GoabRadioGroupSize;
|
|
1213
|
-
constructor(cdr: ChangeDetectorRef, renderer: Renderer2);
|
|
1214
1535
|
ngOnInit(): void;
|
|
1536
|
+
/** Emits when the selected radio item changes. Emits the name, value, and event of the selected item. */
|
|
1215
1537
|
onChange: EventEmitter<GoabRadioGroupOnChangeDetail>;
|
|
1216
1538
|
_onChange(e: Event): void;
|
|
1217
1539
|
static ɵfac: i0.ɵɵFactoryDeclaration<GoabRadioGroup, never>;
|
|
@@ -1220,21 +1542,32 @@ declare class GoabRadioGroup extends GoabControlValueAccessor implements OnInit
|
|
|
1220
1542
|
|
|
1221
1543
|
declare class GoabRadioItem extends GoabBaseComponent implements OnInit {
|
|
1222
1544
|
private cdr;
|
|
1545
|
+
/** The value of this radio option. Will be emitted when selected. */
|
|
1223
1546
|
value?: string;
|
|
1547
|
+
/** The display label for this radio option. Falls back to value if not provided. */
|
|
1224
1548
|
label?: string;
|
|
1549
|
+
/** The name of the radio group. Inherited from the parent RadioGroup if not set. */
|
|
1225
1550
|
name?: string;
|
|
1551
|
+
/** Additional description text displayed below the label. */
|
|
1226
1552
|
description: string | TemplateRef<any>;
|
|
1553
|
+
/** Sets the template reference for the reveal slot content. */
|
|
1227
1554
|
reveal?: TemplateRef<any>;
|
|
1555
|
+
/** Defines how this option will be announced by screen readers. */
|
|
1228
1556
|
ariaLabel?: string;
|
|
1557
|
+
/** Text announced by screen readers when the reveal slot content is displayed. */
|
|
1229
1558
|
revealAriaLabel?: string;
|
|
1559
|
+
/** Disables this radio option. Also disabled if the parent RadioGroup is disabled. */
|
|
1230
1560
|
disabled?: boolean;
|
|
1561
|
+
/** Sets this radio option as checked/selected. */
|
|
1231
1562
|
checked?: boolean;
|
|
1563
|
+
/** Shows an error state on this radio option. */
|
|
1232
1564
|
error?: boolean;
|
|
1565
|
+
/** Sets the maximum width of this radio item. */
|
|
1233
1566
|
maxWidth?: string;
|
|
1567
|
+
/** Enables compact layout for the radio item, reducing spacing for dense layouts. */
|
|
1234
1568
|
compact?: boolean;
|
|
1235
1569
|
isReady: boolean;
|
|
1236
1570
|
version: string;
|
|
1237
|
-
constructor(cdr: ChangeDetectorRef);
|
|
1238
1571
|
ngOnInit(): void;
|
|
1239
1572
|
getDescriptionAsString(): string;
|
|
1240
1573
|
getDescriptionAsTemplate(): TemplateRef<any> | null;
|
|
@@ -1250,8 +1583,8 @@ declare class GoabSideMenu implements OnInit {
|
|
|
1250
1583
|
private cdr;
|
|
1251
1584
|
isReady: boolean;
|
|
1252
1585
|
version: string;
|
|
1586
|
+
/** Sets a data-testid attribute for automated testing. */
|
|
1253
1587
|
testId?: string;
|
|
1254
|
-
constructor(cdr: ChangeDetectorRef);
|
|
1255
1588
|
ngOnInit(): void;
|
|
1256
1589
|
static ɵfac: i0.ɵɵFactoryDeclaration<GoabSideMenu, never>;
|
|
1257
1590
|
static ɵcmp: i0.ɵɵComponentDeclaration<GoabSideMenu, "goab-side-menu", never, { "testId": { "alias": "testId"; "required": false; }; }, {}, never, ["*"], true, never>;
|
|
@@ -1261,9 +1594,10 @@ declare class GoabSideMenuGroup extends GoabBaseComponent implements OnInit {
|
|
|
1261
1594
|
private cdr;
|
|
1262
1595
|
isReady: boolean;
|
|
1263
1596
|
version: string;
|
|
1597
|
+
/** @required The heading text for the menu group. */
|
|
1264
1598
|
heading: string;
|
|
1599
|
+
/** Icon displayed alongside the heading. */
|
|
1265
1600
|
icon?: GoabIconType;
|
|
1266
|
-
constructor(cdr: ChangeDetectorRef);
|
|
1267
1601
|
ngOnInit(): void;
|
|
1268
1602
|
static ɵfac: i0.ɵɵFactoryDeclaration<GoabSideMenuGroup, never>;
|
|
1269
1603
|
static ɵcmp: i0.ɵɵComponentDeclaration<GoabSideMenuGroup, "goab-side-menu-group", never, { "heading": { "alias": "heading"; "required": true; }; "icon": { "alias": "icon"; "required": false; }; }, {}, never, ["*"], true, never>;
|
|
@@ -1273,10 +1607,12 @@ declare class GoabSideMenuHeading implements OnInit {
|
|
|
1273
1607
|
private cdr;
|
|
1274
1608
|
isReady: boolean;
|
|
1275
1609
|
version: string;
|
|
1610
|
+
/** @required Icon displayed before the heading text. */
|
|
1276
1611
|
icon: GoabIconType;
|
|
1612
|
+
/** Sets a data-testid attribute for automated testing. */
|
|
1277
1613
|
testId?: string;
|
|
1614
|
+
/** Sets the template for the meta slot content. */
|
|
1278
1615
|
meta: TemplateRef<any>;
|
|
1279
|
-
constructor(cdr: ChangeDetectorRef);
|
|
1280
1616
|
ngOnInit(): void;
|
|
1281
1617
|
static ɵfac: i0.ɵɵFactoryDeclaration<GoabSideMenuHeading, never>;
|
|
1282
1618
|
static ɵcmp: i0.ɵɵComponentDeclaration<GoabSideMenuHeading, "goab-side-menu-heading", never, { "icon": { "alias": "icon"; "required": false; }; "testId": { "alias": "testId"; "required": false; }; "meta": { "alias": "meta"; "required": false; }; }, {}, never, ["*"], true, never>;
|
|
@@ -1285,11 +1621,14 @@ declare class GoabSideMenuHeading implements OnInit {
|
|
|
1285
1621
|
declare class GoabSkeleton extends GoabBaseComponent implements OnInit {
|
|
1286
1622
|
private cdr;
|
|
1287
1623
|
isReady: boolean;
|
|
1624
|
+
/** @required Sets the skeleton shape to represent your content. */
|
|
1288
1625
|
type: GoabSkeletonType;
|
|
1626
|
+
/** Sets the maximum width. Currently only used in card skeleton type. @default "300px" */
|
|
1289
1627
|
maxWidth: string;
|
|
1628
|
+
/** Size can affect either the height, width or both for different skeleton types. */
|
|
1290
1629
|
size?: GoabSkeletonSize;
|
|
1630
|
+
/** Used within components that contain multiple lines. Currently only used in card skeleton type. */
|
|
1291
1631
|
lineCount?: number;
|
|
1292
|
-
constructor(cdr: ChangeDetectorRef);
|
|
1293
1632
|
ngOnInit(): void;
|
|
1294
1633
|
static ɵfac: i0.ɵɵFactoryDeclaration<GoabSkeleton, never>;
|
|
1295
1634
|
static ɵcmp: i0.ɵɵComponentDeclaration<GoabSkeleton, "goab-skeleton", never, { "type": { "alias": "type"; "required": true; }; "maxWidth": { "alias": "maxWidth"; "required": false; }; "size": { "alias": "size"; "required": false; }; "lineCount": { "alias": "lineCount"; "required": false; }; }, {}, never, never, true, never>;
|
|
@@ -1299,10 +1638,12 @@ declare class GoabSkeleton extends GoabBaseComponent implements OnInit {
|
|
|
1299
1638
|
declare class GoabSpacer implements OnInit {
|
|
1300
1639
|
private cdr;
|
|
1301
1640
|
isReady: boolean;
|
|
1641
|
+
/** Horizontal spacing. */
|
|
1302
1642
|
hSpacing?: GoabSpacerHorizontalSpacing;
|
|
1643
|
+
/** Vertical spacing. */
|
|
1303
1644
|
vSpacing?: GoabSpacerVerticalSpacing;
|
|
1645
|
+
/** Sets a data-testid attribute for automated testing. */
|
|
1304
1646
|
testId?: string;
|
|
1305
|
-
constructor(cdr: ChangeDetectorRef);
|
|
1306
1647
|
ngOnInit(): void;
|
|
1307
1648
|
static ɵfac: i0.ɵɵFactoryDeclaration<GoabSpacer, never>;
|
|
1308
1649
|
static ɵcmp: i0.ɵɵComponentDeclaration<GoabSpacer, "goab-spacer", never, { "hSpacing": { "alias": "hSpacing"; "required": false; }; "vSpacing": { "alias": "vSpacing"; "required": false; }; "testId": { "alias": "testId"; "required": false; }; }, {}, never, never, true, never>;
|
|
@@ -1311,10 +1652,12 @@ declare class GoabSpacer implements OnInit {
|
|
|
1311
1652
|
declare class GoabTab implements OnInit {
|
|
1312
1653
|
private cdr;
|
|
1313
1654
|
isReady: boolean;
|
|
1655
|
+
/** The text label for this tab. Can also use the heading slot for custom content. */
|
|
1314
1656
|
heading: string | TemplateRef<any>;
|
|
1657
|
+
/** When true, disables the tab. */
|
|
1315
1658
|
disabled?: boolean;
|
|
1659
|
+
/** Sets the URL slug for the tab. */
|
|
1316
1660
|
slug?: string;
|
|
1317
|
-
constructor(cdr: ChangeDetectorRef);
|
|
1318
1661
|
ngOnInit(): void;
|
|
1319
1662
|
getHeadingAsString(): string;
|
|
1320
1663
|
getHeadingAsTemplate(): TemplateRef<any> | null;
|
|
@@ -1327,13 +1670,18 @@ declare class GoabTable extends GoabBaseComponent implements OnInit {
|
|
|
1327
1670
|
private cdr;
|
|
1328
1671
|
isReady: boolean;
|
|
1329
1672
|
version: string;
|
|
1673
|
+
/** Width of the table. By default it will fit the enclosed content. */
|
|
1330
1674
|
width?: string;
|
|
1675
|
+
/** Sets a relaxed variant of the table with more vertical padding for the cells. */
|
|
1331
1676
|
variant?: GoabTableVariant;
|
|
1677
|
+
/** Sets sort mode: "single" allows one column, "multi" allows up to 2 columns. */
|
|
1332
1678
|
sortMode?: GoabTableSortMode;
|
|
1679
|
+
/** When true, alternates row background colors for improved readability. */
|
|
1333
1680
|
striped?: boolean;
|
|
1334
|
-
constructor(cdr: ChangeDetectorRef);
|
|
1335
1681
|
ngOnInit(): void;
|
|
1682
|
+
/** Emits when a table column is sorted. Emits the sort column and direction as GoabTableOnSortDetail. */
|
|
1336
1683
|
onSort: EventEmitter<GoabTableOnSortDetail>;
|
|
1684
|
+
/** Emits when multi-column sorting changes. Emits an array of sort entries as GoabTableOnMultiSortDetail. */
|
|
1337
1685
|
onMultiSort: EventEmitter<GoabTableOnMultiSortDetail>;
|
|
1338
1686
|
_onSort(e: Event): void;
|
|
1339
1687
|
_onMultiSort(e: Event): void;
|
|
@@ -1345,10 +1693,12 @@ declare class GoabTable extends GoabBaseComponent implements OnInit {
|
|
|
1345
1693
|
declare class GoabTableSortHeader implements OnInit {
|
|
1346
1694
|
private cdr;
|
|
1347
1695
|
isReady: boolean;
|
|
1696
|
+
/** Column name identifier for sorting. */
|
|
1348
1697
|
name?: string;
|
|
1698
|
+
/** Sets the sort direction indicator. @default "none" */
|
|
1349
1699
|
direction?: GoabTableSortDirection;
|
|
1700
|
+
/** Sort order number for multi-column sort display ("1", "2", etc). */
|
|
1350
1701
|
sortOrder?: GoabTableSortOrder;
|
|
1351
|
-
constructor(cdr: ChangeDetectorRef);
|
|
1352
1702
|
ngOnInit(): void;
|
|
1353
1703
|
static ɵfac: i0.ɵɵFactoryDeclaration<GoabTableSortHeader, never>;
|
|
1354
1704
|
static ɵcmp: i0.ɵɵComponentDeclaration<GoabTableSortHeader, "goab-table-sort-header", never, { "name": { "alias": "name"; "required": false; }; "direction": { "alias": "direction"; "required": false; }; "sortOrder": { "alias": "sortOrder"; "required": false; }; }, {}, never, ["*"], true, never>;
|
|
@@ -1358,14 +1708,18 @@ declare class GoabTabs implements OnInit {
|
|
|
1358
1708
|
private cdr;
|
|
1359
1709
|
isReady: boolean;
|
|
1360
1710
|
version: string;
|
|
1711
|
+
/** The initially active tab (1-based index). If not set, the first tab is active. */
|
|
1361
1712
|
initialTab?: number;
|
|
1713
|
+
/** Sets a data-testid attribute for automated testing. */
|
|
1362
1714
|
testId?: string;
|
|
1715
|
+
/** Visual style variant. "segmented" shows pill-style tabs with animation. */
|
|
1363
1716
|
variant?: GoabTabsVariant;
|
|
1364
1717
|
/** Tab layout orientation. "auto" stacks vertically on mobile (default), "horizontal" keeps horizontal on all screen sizes. */
|
|
1365
1718
|
orientation?: GoabTabsOrientation;
|
|
1719
|
+
/** Sets the navigation mode for tab switching. "hash" updates the URL hash when switching tabs. */
|
|
1366
1720
|
navigation?: GoabTabsNavigation;
|
|
1367
|
-
constructor(cdr: ChangeDetectorRef);
|
|
1368
1721
|
ngOnInit(): void;
|
|
1722
|
+
/** Emits when the active tab changes. Emits the new tab index as GoabTabsOnChangeDetail. */
|
|
1369
1723
|
onChange: EventEmitter<GoabTabsOnChangeDetail>;
|
|
1370
1724
|
_onChange(e: Event): void;
|
|
1371
1725
|
static ɵfac: i0.ɵɵFactoryDeclaration<GoabTabs, never>;
|
|
@@ -1378,10 +1732,12 @@ type SnackbarHorizontalPosition = "left" | "center" | "right";
|
|
|
1378
1732
|
declare class GoabTemporaryNotificationCtrl implements OnInit {
|
|
1379
1733
|
private cdr;
|
|
1380
1734
|
isReady: boolean;
|
|
1735
|
+
/** Vertical position of the notification container. @default "bottom" */
|
|
1381
1736
|
verticalPosition: SnackbarVerticalPosition;
|
|
1737
|
+
/** Horizontal position of the notification container. @default "center" */
|
|
1382
1738
|
horizontalPosition: SnackbarHorizontalPosition;
|
|
1739
|
+
/** Sets a data-testid attribute for automated testing. */
|
|
1383
1740
|
testId?: string;
|
|
1384
|
-
constructor(cdr: ChangeDetectorRef);
|
|
1385
1741
|
ngOnInit(): void;
|
|
1386
1742
|
static ɵfac: i0.ɵɵFactoryDeclaration<GoabTemporaryNotificationCtrl, never>;
|
|
1387
1743
|
static ɵcmp: i0.ɵɵComponentDeclaration<GoabTemporaryNotificationCtrl, "goab-temporary-notification-ctrl", never, { "verticalPosition": { "alias": "verticalPosition"; "required": false; }; "horizontalPosition": { "alias": "horizontalPosition"; "required": false; }; "testId": { "alias": "testId"; "required": false; }; }, {}, never, never, true, never>;
|
|
@@ -1389,18 +1745,26 @@ declare class GoabTemporaryNotificationCtrl implements OnInit {
|
|
|
1389
1745
|
|
|
1390
1746
|
declare class GoabText implements OnInit {
|
|
1391
1747
|
private cdr;
|
|
1748
|
+
/** The HTML element to render. Use semantic elements like 'h1'-'h6' for headings. */
|
|
1392
1749
|
tag?: GoabTextTextElement | GoabTextHeadingElement;
|
|
1750
|
+
/** Overrides the text size. */
|
|
1393
1751
|
size?: GoabTextSize;
|
|
1752
|
+
/** Sets the max width. */
|
|
1394
1753
|
maxWidth?: GoabTextMaxWidth;
|
|
1754
|
+
/** Sets the text colour. */
|
|
1395
1755
|
color?: GoabTextColor;
|
|
1756
|
+
/** Sets the id attribute on the host element. */
|
|
1396
1757
|
id?: string;
|
|
1397
1758
|
get hostId(): string | undefined;
|
|
1759
|
+
/** Top margin. */
|
|
1398
1760
|
mt?: Spacing;
|
|
1761
|
+
/** Bottom margin. */
|
|
1399
1762
|
mb?: Spacing;
|
|
1763
|
+
/** Left margin. */
|
|
1400
1764
|
ml?: Spacing;
|
|
1765
|
+
/** Right margin. */
|
|
1401
1766
|
mr?: Spacing;
|
|
1402
1767
|
isReady: boolean;
|
|
1403
|
-
constructor(cdr: ChangeDetectorRef);
|
|
1404
1768
|
ngOnInit(): void;
|
|
1405
1769
|
static ɵfac: i0.ɵɵFactoryDeclaration<GoabText, never>;
|
|
1406
1770
|
static ɵcmp: i0.ɵɵComponentDeclaration<GoabText, "goab-text", never, { "tag": { "alias": "tag"; "required": false; }; "size": { "alias": "size"; "required": false; }; "maxWidth": { "alias": "maxWidth"; "required": false; }; "color": { "alias": "color"; "required": false; }; "id": { "alias": "id"; "required": false; }; "mt": { "alias": "mt"; "required": false; }; "mb": { "alias": "mb"; "required": false; }; "ml": { "alias": "ml"; "required": false; }; "mr": { "alias": "mr"; "required": false; }; }, {}, never, ["*"], true, never>;
|
|
@@ -1408,23 +1772,36 @@ declare class GoabText implements OnInit {
|
|
|
1408
1772
|
|
|
1409
1773
|
declare class GoabTextArea extends GoabControlValueAccessor implements OnInit {
|
|
1410
1774
|
private cdr;
|
|
1775
|
+
/** Name of the input value that is received in the _change event. */
|
|
1411
1776
|
name?: string;
|
|
1777
|
+
/** Text displayed within the input when no value is set. */
|
|
1412
1778
|
placeholder?: string;
|
|
1779
|
+
/** Set the number of rows. @default 3 */
|
|
1413
1780
|
rows?: number;
|
|
1781
|
+
/** Sets the input to a read only state. */
|
|
1414
1782
|
readOnly?: boolean;
|
|
1783
|
+
/** Width of the text area. */
|
|
1415
1784
|
width?: string;
|
|
1785
|
+
/** Defines how the text will be translated for the screen reader. If not specified it will fall back to the name. */
|
|
1416
1786
|
ariaLabel?: string;
|
|
1787
|
+
/** Counting interval for characters or words, specifying whether to count every character or word. @default "" */
|
|
1417
1788
|
countBy?: GoabTextAreaCountBy;
|
|
1789
|
+
/** Maximum number of characters or words allowed. @default -1 */
|
|
1418
1790
|
maxCount?: number;
|
|
1791
|
+
/** Maximum width of the text area. */
|
|
1419
1792
|
maxWidth?: string;
|
|
1793
|
+
/** Specifies the autocomplete attribute for the textarea input. @default "on" */
|
|
1420
1794
|
autoComplete?: string;
|
|
1795
|
+
/** Sets the size variant of the textarea. @default "default" */
|
|
1421
1796
|
size?: GoabTextAreaSize;
|
|
1797
|
+
/** Emits when the textarea value changes. Emits the name and new value. */
|
|
1422
1798
|
onChange: EventEmitter<GoabTextAreaOnChangeDetail>;
|
|
1799
|
+
/** Emits when a key is pressed in the textarea. Emits the name, value, and key. */
|
|
1423
1800
|
onKeyPress: EventEmitter<GoabTextAreaOnKeyPressDetail>;
|
|
1801
|
+
/** Emits when the textarea loses focus. Emits the name and current value. */
|
|
1424
1802
|
onBlur: EventEmitter<GoabTextAreaOnBlurDetail>;
|
|
1425
1803
|
isReady: boolean;
|
|
1426
1804
|
version: string;
|
|
1427
|
-
constructor(cdr: ChangeDetectorRef, renderer: Renderer2);
|
|
1428
1805
|
ngOnInit(): void;
|
|
1429
1806
|
_onChange(e: Event): void;
|
|
1430
1807
|
_onKeyPress(e: Event): void;
|
|
@@ -1438,11 +1815,14 @@ declare class GoabTextArea extends GoabControlValueAccessor implements OnInit {
|
|
|
1438
1815
|
declare class GoabTooltip extends GoabBaseComponent implements OnInit {
|
|
1439
1816
|
private cdr;
|
|
1440
1817
|
isReady: boolean;
|
|
1818
|
+
/** Position with respect to the child element. @default "top" */
|
|
1441
1819
|
position?: GoabTooltipPosition;
|
|
1820
|
+
/** The content of the tooltip. */
|
|
1442
1821
|
content?: string | TemplateRef<unknown>;
|
|
1822
|
+
/** Horizontal alignment to the child element. @default "center" */
|
|
1443
1823
|
hAlign?: GoabTooltipHorizontalAlignment;
|
|
1824
|
+
/** Sets the maximum width of the tooltip. Must use 'px' unit. */
|
|
1444
1825
|
maxWidth?: string;
|
|
1445
|
-
constructor(cdr: ChangeDetectorRef);
|
|
1446
1826
|
ngOnInit(): void;
|
|
1447
1827
|
getContentAsString(): string;
|
|
1448
1828
|
getContentAsTemplate(): TemplateRef<unknown> | null;
|
|
@@ -1452,19 +1832,29 @@ declare class GoabTooltip extends GoabBaseComponent implements OnInit {
|
|
|
1452
1832
|
|
|
1453
1833
|
declare class GoabWorkSideMenu implements OnInit {
|
|
1454
1834
|
private cdr;
|
|
1835
|
+
/** @required The application name displayed in the header. */
|
|
1455
1836
|
heading: string;
|
|
1837
|
+
/** @required URL for the header link. Clicking the logo/heading navigates to this URL. */
|
|
1456
1838
|
url: string;
|
|
1839
|
+
/** User's name displayed in the profile section. */
|
|
1457
1840
|
userName?: string;
|
|
1841
|
+
/** Secondary text displayed below the user's name, such as role or email. */
|
|
1458
1842
|
userSecondaryText?: string;
|
|
1843
|
+
/** Controls whether the side menu is expanded or collapsed. */
|
|
1459
1844
|
open?: boolean;
|
|
1845
|
+
/** Sets a data-testid attribute for automated testing. */
|
|
1460
1846
|
testId?: string;
|
|
1847
|
+
/** Template reference for the primary navigation slot content. */
|
|
1461
1848
|
primaryContent: TemplateRef<any>;
|
|
1849
|
+
/** Template reference for the secondary navigation slot content. */
|
|
1462
1850
|
secondaryContent: TemplateRef<any>;
|
|
1851
|
+
/** Template reference for the account slot content. */
|
|
1463
1852
|
accountContent: TemplateRef<any>;
|
|
1853
|
+
/** Emits when the side menu is toggled open or closed. */
|
|
1464
1854
|
onToggle: EventEmitter<any>;
|
|
1855
|
+
/** Emits when a navigation link is clicked. Emits the URL as a string. */
|
|
1465
1856
|
onNavigate: EventEmitter<string>;
|
|
1466
1857
|
isReady: boolean;
|
|
1467
|
-
constructor(cdr: ChangeDetectorRef);
|
|
1468
1858
|
ngOnInit(): void;
|
|
1469
1859
|
_onToggle(): void;
|
|
1470
1860
|
_onNavigate(e: Event): void;
|
|
@@ -1475,12 +1865,15 @@ declare class GoabWorkSideMenu implements OnInit {
|
|
|
1475
1865
|
|
|
1476
1866
|
declare class GoabWorkSideMenuGroup implements OnInit {
|
|
1477
1867
|
private cdr;
|
|
1868
|
+
/** @required The text displayed in the group heading. */
|
|
1478
1869
|
heading: string;
|
|
1870
|
+
/** Icon displayed before the group label. When omitted, no icon is rendered and no space is reserved. */
|
|
1479
1871
|
icon?: GoabIconType;
|
|
1872
|
+
/** Whether the group is open. */
|
|
1480
1873
|
open?: boolean;
|
|
1874
|
+
/** Sets a data-testid attribute for automated testing. */
|
|
1481
1875
|
testId?: string;
|
|
1482
1876
|
isReady: boolean;
|
|
1483
|
-
constructor(cdr: ChangeDetectorRef);
|
|
1484
1877
|
ngOnInit(): void;
|
|
1485
1878
|
static ɵfac: i0.ɵɵFactoryDeclaration<GoabWorkSideMenuGroup, never>;
|
|
1486
1879
|
static ɵcmp: i0.ɵɵComponentDeclaration<GoabWorkSideMenuGroup, "goab-work-side-menu-group", never, { "heading": { "alias": "heading"; "required": true; }; "icon": { "alias": "icon"; "required": false; }; "open": { "alias": "open"; "required": false; }; "testId": { "alias": "testId"; "required": false; }; }, {}, never, ["*"], true, never>;
|
|
@@ -1489,17 +1882,25 @@ declare class GoabWorkSideMenuGroup implements OnInit {
|
|
|
1489
1882
|
|
|
1490
1883
|
declare class GoabWorkSideMenuItem implements OnInit {
|
|
1491
1884
|
private cdr;
|
|
1885
|
+
/** @required The text label displayed for the menu item. */
|
|
1492
1886
|
label: string;
|
|
1887
|
+
/** The URL the menu item links to. Optional — when absent, renders as a button instead of a link. */
|
|
1493
1888
|
url?: string;
|
|
1889
|
+
/** Badge text displayed alongside the menu item (e.g., notification count). */
|
|
1494
1890
|
badge?: string;
|
|
1891
|
+
/** When true, indicates this is the currently active menu item. */
|
|
1495
1892
|
current?: boolean;
|
|
1893
|
+
/** When true, displays a divider line above this menu item. */
|
|
1496
1894
|
divider?: boolean;
|
|
1895
|
+
/** Icon displayed before the menu item label. */
|
|
1497
1896
|
icon?: string;
|
|
1897
|
+
/** Sets a data-testid attribute for automated testing. */
|
|
1498
1898
|
testId?: string;
|
|
1899
|
+
/** Sets the visual style of the badge. Use "emergency" for urgent items, "success" for positive status. @default "normal" */
|
|
1499
1900
|
type?: GoabWorkSideMenuItemType;
|
|
1901
|
+
/** Template reference for the popover content slot. */
|
|
1500
1902
|
popoverContent: TemplateRef<any>;
|
|
1501
1903
|
isReady: boolean;
|
|
1502
|
-
constructor(cdr: ChangeDetectorRef);
|
|
1503
1904
|
ngOnInit(): void;
|
|
1504
1905
|
static ɵfac: i0.ɵɵFactoryDeclaration<GoabWorkSideMenuItem, never>;
|
|
1505
1906
|
static ɵcmp: i0.ɵɵComponentDeclaration<GoabWorkSideMenuItem, "goab-work-side-menu-item", never, { "label": { "alias": "label"; "required": true; }; "url": { "alias": "url"; "required": false; }; "badge": { "alias": "badge"; "required": false; }; "current": { "alias": "current"; "required": false; }; "divider": { "alias": "divider"; "required": false; }; "icon": { "alias": "icon"; "required": false; }; "testId": { "alias": "testId"; "required": false; }; "type": { "alias": "type"; "required": false; }; "popoverContent": { "alias": "popoverContent"; "required": false; }; }, {}, never, ["*"], true, never>;
|
|
@@ -1507,16 +1908,23 @@ declare class GoabWorkSideMenuItem implements OnInit {
|
|
|
1507
1908
|
|
|
1508
1909
|
declare class GoabWorkSideNotificationItem implements OnInit {
|
|
1509
1910
|
private cdr;
|
|
1911
|
+
/** Sets the visual style of the notification item. */
|
|
1510
1912
|
type?: GoabWorkSideNotificationItemType;
|
|
1913
|
+
/** The timestamp for when the notification was created. */
|
|
1511
1914
|
timestamp?: string;
|
|
1915
|
+
/** The title text of the notification item. */
|
|
1512
1916
|
title?: string;
|
|
1917
|
+
/** @required The description text of the notification item. */
|
|
1513
1918
|
description: string;
|
|
1919
|
+
/** Indicates whether the notification is read or unread. */
|
|
1514
1920
|
readStatus?: GoabWorkSideNotificationReadStatus;
|
|
1921
|
+
/** Sets the priority level of the notification. */
|
|
1515
1922
|
priority?: GoabWorkSideNotificationPriority;
|
|
1923
|
+
/** Sets a data-testid attribute for automated testing. */
|
|
1516
1924
|
testId?: string;
|
|
1925
|
+
/** Emits when the notification item is clicked. */
|
|
1517
1926
|
onClick: EventEmitter<void>;
|
|
1518
1927
|
isReady: boolean;
|
|
1519
|
-
constructor(cdr: ChangeDetectorRef);
|
|
1520
1928
|
ngOnInit(): void;
|
|
1521
1929
|
_onClick(): void;
|
|
1522
1930
|
static ɵfac: i0.ɵɵFactoryDeclaration<GoabWorkSideNotificationItem, never>;
|
|
@@ -1525,13 +1933,17 @@ declare class GoabWorkSideNotificationItem implements OnInit {
|
|
|
1525
1933
|
|
|
1526
1934
|
declare class GoabWorkSideNotificationPanel implements OnInit {
|
|
1527
1935
|
private cdr;
|
|
1936
|
+
/** The heading text displayed at the top of the notification panel. */
|
|
1528
1937
|
heading?: string;
|
|
1938
|
+
/** Sets the initially active tab in the notification panel. */
|
|
1529
1939
|
activeTab?: GoabWorkSideNotificationActiveTabType;
|
|
1940
|
+
/** Sets a data-testid attribute for automated testing. */
|
|
1530
1941
|
testId?: string;
|
|
1942
|
+
/** Emits when the user clicks "Mark all as read". */
|
|
1531
1943
|
onMarkAllRead: EventEmitter<void>;
|
|
1944
|
+
/** Emits when the user clicks "View all". */
|
|
1532
1945
|
onViewAll: EventEmitter<void>;
|
|
1533
1946
|
isReady: boolean;
|
|
1534
|
-
constructor(cdr: ChangeDetectorRef);
|
|
1535
1947
|
ngOnInit(): void;
|
|
1536
1948
|
_onMarkAllRead(): void;
|
|
1537
1949
|
_onViewAll(): void;
|