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

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