@abgov/angular-components 5.0.0-dev.5 → 5.0.0-dev.7

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