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

package/types/abgov-angular-components.d.ts

@@ -61,18 +61,27 @@ declare class AngularComponentsModule {
 }
 
 declare abstract class GoabBaseComponent {
+    /** Sets the top margin spacing token. */
     mt?: Spacing;
+    /** Sets the bottom margin spacing token. */
     mb?: Spacing;
+    /** Sets the left margin spacing token. */
     ml?: Spacing;
+    /** Sets the right margin spacing token. */
     mr?: Spacing;
+    /** Sets the data-testid attribute for automated testing. */
     testId?: string;
     static ɵfac: i0.ɵɵFactoryDeclaration<GoabBaseComponent, never>;
     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>;
 }
 declare abstract class GoabControlValueAccessor extends GoabBaseComponent implements ControlValueAccessor {
+    /** Sets the id attribute of the underlying web component. */
     id?: string;
+    /** Sets the disabled state for the control. */
     disabled?: boolean;
+    /** Sets the error state for the control. */
     error?: boolean;
+    /** Sets the control value used by Angular forms and one-way binding. */
     value?: unknown | null | undefined;
     /**
      * Function to handle changes in the form control value.
@@ -132,13 +141,21 @@ declare abstract class GoabControlValueAccessor extends GoabBaseComponent implem
 
 declare class GoabAccordion extends GoabBaseComponent implements OnInit {
     private cdr;
+    /** Sets the heading text. */
     heading?: string;
+    /** Sets secondary text. */
     secondaryText?: string;
+    /** Sets the state of the accordion container open or closed. */
     open?: boolean;
+    /** Sets the heading size of the accordion container heading. */
     headingSize?: GoabAccordionHeadingSize;
+    /** Sets the heading content template reference. */
     headingContent: TemplateRef<any>;
+    /** Sets the maximum width of the accordion. */
     maxWidth?: string;
+    /** Sets the position of the expand/collapse icon. */
     iconPosition?: GoabAccordionIconPosition;
+    /** Emits when the accordion opens or closes. Emits the new open state as a boolean. */
     onChange: EventEmitter<boolean>;
     isReady: boolean;
     ngOnInit(): void;
@@ -150,12 +167,19 @@ declare class GoabAccordion extends GoabBaseComponent implements OnInit {
 
 declare class GoabBadge extends GoabBaseComponent implements OnInit {
     private cdr;
+    /** Sets the context and colour of the badge. */
     type?: GoabBadgeType;
+    /** Sets the text label of the badge. */
     content?: string;
+    /** @deprecated Use icontype instead. Includes an icon in the badge. */
     icon?: boolean;
+    /** Sets the icon type to display in the badge. */
     iconType?: GoabIconType;
+    /** Sets the size of the badge. @default "medium" */
     size?: GoabBadgeSize;
+    /** Sets the visual emphasis. 'subtle' for less prominent, 'strong' for more emphasis. @default "strong" */
     emphasis?: GoabBadgeEmphasis;
+    /** Sets the accessible label for screen readers. */
     ariaLabel?: string;
     isReady: boolean;
     version: string;
@@ -167,11 +191,17 @@ declare class GoabBadge extends GoabBaseComponent implements OnInit {
 
 declare class GoabBlock extends GoabBaseComponent implements OnInit {
     private cdr;
+    /** Sets the spacing between items. Uses design system spacing tokens. */
     gap?: Spacing;
+    /** Sets the stacking direction of child components. */
     direction?: GoabBlockDirection;
+    /** Sets the primary axis alignment of child components. */
     alignment?: GoabBlockAlignment;
+    /** Sets the width of the block container. Defaults to max-content. */
     width?: string;
+    /** Sets the minimum width of the block container. */
     minWidth?: string;
+    /** Sets the maximum width of the block container. */
     maxWidth?: string;
     isReady: boolean;
     ngOnInit(): void;
@@ -181,16 +211,27 @@ declare class GoabBlock extends GoabBaseComponent implements OnInit {
 
 declare class GoabButton extends GoabBaseComponent implements OnInit {
     private cdr;
+    /** 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" */
     type?: GoabButtonType;
+    /** Sets the size of the button. Use "compact" for inline actions or space-constrained layouts. @default "normal" */
     size?: GoabButtonSize;
+    /** Sets the color variant for semantic meaning. Use "destructive" for delete or irreversible actions, "inverse" for dark backgrounds. @default "normal" */
     variant?: GoabButtonVariant;
+    /** Sets the disabled state. When true, prevents user interaction and applies disabled styling. */
     disabled?: boolean;
+    /** Sets the icon displayed before the button text. */
     leadingIcon?: GoabIconType;
+    /** Icon displayed after the button text. */
     trailingIcon?: GoabIconType;
+    /** Sets a custom width for the button (e.g., "200px" or "100%"). */
     width?: string;
+    /** Action identifier passed in click events for event delegation patterns. */
     action?: string;
+    /** Single argument value passed with the action in click events. */
     actionArg?: string;
+    /** Multiple argument values passed with the action in click events. */
     actionArgs?: Record<string, unknown>;
+    /** Emits when the button is clicked. */
     onClick: EventEmitter<any>;
     isReady: boolean;
     version: string;
@@ -204,7 +245,9 @@ declare class GoabButton extends GoabBaseComponent implements OnInit {
 
 declare class GoabButtonGroup extends GoabBaseComponent implements OnInit {
     private cdr;
+    /** Positions the button group in the page layout. */
     alignment?: GoabButtonGroupAlignment;
+    /** Sets the spacing between buttons in the button group. */
     gap?: GoabButtonGroupGap;
     isReady: boolean;
     ngOnInit(): void;
@@ -215,10 +258,15 @@ declare class GoabButtonGroup extends GoabBaseComponent implements OnInit {
 declare class GoabCalendar extends GoabBaseComponent implements OnInit {
     private cdr;
     version: string;
+    /** Name identifier for the calendar, included in change events. */
     name?: string;
+    /** The currently selected date value in YYYY-MM-DD format. */
     value?: Date | string;
+    /** The minimum selectable date in YYYY-MM-DD format. Defaults to 5 years in the past. */
     min?: Date | string | undefined;
+    /** The maximum selectable date in YYYY-MM-DD format. Defaults to 5 years in the future. */
     max?: Date | string | undefined;
+    /** Emits when the selected date changes. Emits the selected date details as GoabCalendarOnChangeDetail. */
     onChange: EventEmitter<GoabCalendarOnChangeDetail>;
     isReady: boolean;
     private once;
@@ -237,12 +285,19 @@ declare class GoabCallout extends GoabBaseComponent implements OnInit {
     isReady: boolean;
     version: string;
     ngOnInit(): void;
+    /** Define the context and colour of the callout. @default "information" */
     type?: GoabCalloutType;
+    /** Callout heading text. */
     heading?: string;
+    /** Sets the size of the callout. 'medium' has reduced padding and type size for compact areas. @default "large" */
     size?: GoabCalloutSize;
+    /** Sets the maximum width of the callout. */
     maxWidth?: string;
+    /** Indicates how assistive technology should handle updates to the live region. @default "off" */
     ariaLive?: GoabCalloutAriaLive;
+    /** Sets the icon theme. 'outline' for stroked icons, 'filled' for solid icons. @default "outline" */
     iconTheme?: GoabCalloutIconTheme;
+    /** Sets the visual prominence. 'high' for full background, 'medium' for subtle, 'low' for minimal. @default "medium" */
     emphasis?: GoabCalloutEmphasis;
     static ɵfac: i0.ɵɵFactoryDeclaration<GoabCallout, never>;
     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 {
     private cdr;
     isReady: boolean;
     ngOnInit(): void;
+    /** Adds a shadow to the card. 0 shows a border, 1-3 increase shadow intensity. */
     elevation?: number;
+    /** Sets the width of the card. */
     width?: string;
     static ɵfac: i0.ɵɵFactoryDeclaration<GoabCard, never>;
     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 {
 
 declare class GoabCardImage implements OnInit {
     private cdr;
+    /** @required The URL of the image to display. */
     src: string;
+    /** @required Height of the image container. Accepts CSS values like "200px" or "100%". */
     height: string;
     isReady: boolean;
     ngOnInit(): void;
@@ -290,17 +349,29 @@ declare class GoabCheckbox extends GoabControlValueAccessor implements OnInit {
     isReady: boolean;
     version: string;
     ngOnInit(): void;
+    /** Sets the name of the checkbox input for form submission. */
     name?: string;
+    /** Marks the checkbox item as selected. */
     checked?: boolean;
+    /** Shows a mixed/partial selection state. Used for 'Select All' checkboxes when some items are selected. */
     indeterminate?: boolean;
+    /** Label shown beside the checkbox. */
     text?: string;
+    /** The value binding. */
     value?: string | number | boolean | null;
+    /** Defines how the text will be translated for the screen reader. If not specified it will fall back to the name. */
     ariaLabel?: string;
+    /** Sets additional description content displayed below the checkbox label. Accepts plain text or a template. */
     description: string | TemplateRef<any>;
+    /** Sets the template for the expandable reveal slot content. */
     reveal?: TemplateRef<any>;
+    /** Text announced by screen readers when the reveal slot content is displayed. */
     revealArialLabel?: string;
+    /** Sets the maximum width of the checkbox. */
     maxWidth?: string;
+    /** Sets the size of the checkbox. 'compact' reduces spacing for dense layouts. @default "default" */
     size?: GoabCheckboxSize;
+    /** Emits when the checkbox value changes. Emits the new checkbox state as a GoabCheckboxOnChangeDetail object. */
     onChange: EventEmitter<GoabCheckboxOnChangeDetail>;
     getDescriptionAsString(): string;
     getDescriptionAsTemplate(): TemplateRef<any> | null;
@@ -316,11 +387,16 @@ declare class GoabCheckboxList extends GoabControlValueAccessor implements OnIni
     private cdr;
     isReady: boolean;
     version: string;
+    /** @required The name for the checkbox list group. Used as group identifier in change events. */
     name: string;
+    /** Sets the maximum width of the checkbox list container. */
     maxWidth?: string;
+    /** Sets the size of the checkbox list. 'compact' reduces spacing between items. @default "default" */
     size?: GoabCheckboxSize;
+    /** Array of currently selected checkbox values. */
     value?: string[];
     ngOnInit(): void;
+    /** Emits when a checkbox selection changes. Emits the change detail including name, value array, and event. */
     onChange: EventEmitter<GoabCheckboxListOnChangeDetail>;
     _onChange(e: Event): void;
     writeValue(value: string[] | null): void;
@@ -332,12 +408,19 @@ declare class GoabChip extends GoabBaseComponent implements OnInit {
     private cdr;
     isReady: boolean;
     ngOnInit(): void;
+    /** @deprecated Use GoAFilterChip instead. Icon displayed at the start of the chip. */
     leadingIcon?: GoabIconType | null;
+    /** @deprecated Use GoAFilterChip instead. Shows an error state on the chip. */
     error?: boolean;
+    /** @deprecated Use GoAFilterChip instead. When true, shows a delete icon and makes chip clickable. */
     deletable?: boolean;
+    /** @deprecated Use GoAFilterChip instead. The text content displayed in the chip. */
     content?: string;
+    /** @deprecated Use GoAFilterChip instead. The chip variant style. */
     variant?: GoabChipVariant;
+    /** @deprecated Use GoAFilterChip instead. The icon theme - outline or filled. */
     iconTheme?: GoabChipTheme;
+    /** Emits when the chip is clicked. */
     onClick: EventEmitter<any>;
     _onClick(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<GoabChip, never>;
@@ -348,11 +431,17 @@ declare class GoabChip extends GoabBaseComponent implements OnInit {
 
 declare class GoabCircularProgress implements OnInit {
     private cdr;
+    /** Stretch across the full screen or use it inline. */
     variant?: GoabCircularProgressVariant;
+    /** Size of the progress indicator. */
     size?: GoabCircularProgressSize;
+    /** Loading message displayed under the progress indicator. */
     message?: string;
+    /** Show/hide the page loader. This allows for fade transition to be applied in each transition. */
     visible?: boolean;
+    /** Set the progress value. Setting this value will change the type from infinite to progress. */
     progress?: number;
+    /** Sets a data-testid attribute for automated testing. */
     testId?: string;
     isReady: boolean;
     ngOnInit(): void;
@@ -373,14 +462,23 @@ declare class GoabColumnLayout implements OnInit {
 
 declare class GoabContainer extends GoabBaseComponent implements OnInit {
     private cdr;
+    /** Sets the container and accent bar styling. @default "interactive" */
     type?: GoabContainerType;
+    /** Sets the style of accent on the container. @default "filled" */
     accent?: GoabContainerAccent;
+    /** Sets the amount of white space in the container. @default "relaxed" */
     padding?: GoabContainerPadding;
+    /** Sets the width of the container. @default "full" */
     width?: GoabContainerWidth;
+    /** Sets the maximum width of the container. */
     maxWidth?: string;
+    /** Sets the minimum height of the container. */
     minHeight?: string;
+    /** Sets the maximum height of the container. */
     maxHeight?: string;
+    /** Sets the template for the title slot content. */
     title: TemplateRef<any>;
+    /** Sets the template for the actions slot content. */
     actions: TemplateRef<any>;
     isReady: boolean;
     ngOnInit(): void;
@@ -390,8 +488,11 @@ declare class GoabContainer extends GoabBaseComponent implements OnInit {
 
 declare class GoabDataGrid implements OnInit {
     private cdr;
+    /** Controls visibility of the keyboard navigation indicator icon. Use "visible" to show or "hidden" to hide. @default "visible" */
     keyboardIconVisibility: "visible" | "hidden";
+    /** Position of the keyboard navigation indicator icon. @default "left" */
     keyboardIconPosition: "left" | "right";
+    /** @required Navigation mode. "table" navigates like a table (up/down between rows), "layout" allows wrapping between rows with left/right arrows. */
     keyboardNav: "layout" | "table";
     isReady: boolean;
     ngOnInit(): void;
@@ -404,16 +505,21 @@ declare class GoabDatePicker extends GoabControlValueAccessor implements OnInit
     private cdr;
     isReady: boolean;
     version: string;
+    /** Sets the name of the date field. */
     name?: string;
+    /** Sets the value of the calendar date. */
     value?: Date | string | null | undefined;
+    /** Sets the minimum date value allowed. */
     min?: Date | string;
+    /** Sets the maximum date value allowed. */
     max?: Date | string;
+    /** Sets the date picker type. 'calendar' shows a calendar popup, 'input' shows just a date input. @default "calendar" */
     type?: GoabDatePickerInputType;
-    /***
-     * @deprecated This property has no effect and will be removed in a future version
-     */
+    /** @deprecated This property has no effect and will be removed in a future version. */
     relative?: boolean;
+    /** Sets the width of the date picker input. */
     width?: string;
+    /** Emits when the selected date changes. Emits the date picker change detail including name and value. */
     onChange: EventEmitter<GoabDatePickerOnChangeDetail>;
     private once;
     private formatValue;
@@ -431,8 +537,11 @@ declare class GoabDatePicker extends GoabControlValueAccessor implements OnInit
 
 declare class GoabDetails extends GoabBaseComponent implements OnInit {
     private cdr;
+    /** @required The title heading. */
     heading: string;
+    /** Controls if details is expanded or not. */
     open?: boolean;
+    /** Sets the maximum width of the details. */
     maxWidth?: string;
     isReady: boolean;
     ngOnInit(): void;
@@ -452,12 +561,19 @@ declare class GoabDivider extends GoabBaseComponent implements OnInit {
 declare class GoabDrawer implements OnInit {
     private cdr;
     version: string;
+    /** @required Whether the drawer is open. */
     open: boolean;
+    /** @required The position of the drawer. */
     position: GoabDrawerPosition;
+    /** The heading text displayed at the top of the drawer. */
     heading: string | TemplateRef<any>;
+    /** Sets max height on bottom position, sets width on left and right position. */
     maxSize?: GoabDrawerSize;
+    /** Sets a data-testid attribute for automated testing. */
     testId?: string;
+    /** Sets the actions area content using an Angular template reference. */
     actions: TemplateRef<any>;
+    /** Emits when the drawer is closed. */
     onClose: EventEmitter<any>;
     isReady: boolean;
     ngOnInit(): void;
@@ -471,23 +587,35 @@ declare class GoabDrawer implements OnInit {
 
 declare class GoabDropdown extends GoabControlValueAccessor implements OnInit {
     private cdr;
+    /** Identifier for the dropdown. Should be unique. */
     name?: string;
+    /** Defines how the selected value will be translated for the screen reader. If not specified it will fall back to the name. */
     ariaLabel?: string;
+    /** 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. */
     ariaLabelledBy?: string;
+    /** When true the dropdown will have the ability to filter options by typing into the input field. */
     filterable?: boolean;
+    /** Icon shown to the left of the dropdown input. */
     leadingIcon?: GoabIconType;
+    /** Maximum height of the dropdown menu. Non-native only. */
     maxHeight?: string;
+    /** When true, allows multiple items to be selected. Not currently exposed. */
     multiselect?: boolean;
+    /** When true will render the native select HTML element. */
     native?: boolean;
+    /** The text displayed for the dropdown before a selection is made. Non-native only. */
     placeholder?: string;
+    /** Overrides the autosized menu width. Non-native only. */
     width?: string;
+    /** Sets the maximum width of the dropdown. Use a CSS unit (px, %, ch, rem, em). */
     maxWidth?: string;
+    /** Specifies the autocomplete attribute for the dropdown input. Native only. */
     autoComplete?: string;
+    /** Sets the size of the dropdown. Compact reduces height for dense layouts. @default "default" */
     size?: GoabDropdownSize;
-    /***
-     * @deprecated This property has no effect and will be removed in a future version
-     */
+    /** @deprecated This property has no effect and will be removed in a future version. */
     relative?: boolean;
+    /** Emits when the user selects a value from the dropdown. Emits a GoabDropdownOnChangeDetail object with the new value. */
     onChange: EventEmitter<GoabDropdownOnChangeDetail>;
     isReady: boolean;
     version: string;
@@ -502,10 +630,15 @@ declare class GoabDropdown extends GoabControlValueAccessor implements OnInit {
 
 declare class GoabDropdownItem implements OnInit {
     private cdr;
+    /** The value submitted when this item is selected. */
     value?: string;
+    /** Text used to filter and match this item in typeahead search. */
     filter?: string;
+    /** Display label for the dropdown item. */
     label?: string;
+    /** Sets the name attribute of the dropdown item. */
     name?: string;
+    /** Controls how the item is registered with the parent dropdown. */
     mountType?: GoabDropdownItemMountType;
     isReady: boolean;
     ngOnInit(): void;
@@ -515,13 +648,21 @@ declare class GoabDropdownItem implements OnInit {
 
 declare class GoabFileUploadCard implements OnInit {
     private cdr;
+    /** @required The name of the uploaded file to display. */
     filename: string;
-    size?: number;
+    /** @required The file size in bytes. Displayed in a human-readable format (KB, MB). */
+    size: number;
+    /** The MIME type of the file. Used to determine the file type icon. */
     type?: string;
+    /** Upload progress percentage from 0-100. Use -1 to indicate upload is complete. */
     progress?: number;
+    /** Error message to display. When set, the card shows an error state with a cancel button. */
     error?: string;
+    /** Sets a data-testid attribute for automated testing. */
     testId?: string;
+    /** Emits when the user cancels a file upload. Emits a GoabFileUploadOnCancelDetail object with the filename. */
     onCancel: EventEmitter<GoabFileUploadOnCancelDetail>;
+    /** Emits when the user removes an uploaded file. Emits a GoabFileUploadOnDeleteDetail object with the filename. */
     onDelete: EventEmitter<GoabFileUploadOnDeleteDetail>;
     isReady: boolean;
     version: string;
@@ -529,34 +670,46 @@ declare class GoabFileUploadCard implements OnInit {
     _onCancel(event: Event): void;
     _onDelete(event: Event): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<GoabFileUploadCard, never>;
-    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>;
+    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>;
     static ngAcceptInputType_size: unknown;
     static ngAcceptInputType_progress: unknown;
 }
 
 declare class GoabFileUploadInput extends GoabBaseComponent implements OnInit {
     private cdr;
+    /** Sets the id attribute on the file upload input element. */
     id?: string;
-    variant: GoabFileUploadInputVariant;
+    /** The input display variant. "dragdrop" shows a drag-and-drop area, "button" shows a simple button. @default "dragdrop" */
+    variant?: GoabFileUploadInputVariant;
+    /** Maximum file size with unit (e.g., "5MB", "100KB", "1GB"). Files exceeding this will be rejected. @default "5MB" */
     maxFileSize?: string;
+    /** Accepted file types as a comma-separated list of MIME types or file extensions (e.g., "image/*,.pdf"). */
     accept?: string;
+    /** Emits when a file is selected. Emits the selected file details. */
     onSelectFile: EventEmitter<GoabFileUploadInputOnSelectFileDetail>;
     isReady: boolean;
     version: string;
     ngOnInit(): void;
     _onSelectFile(e: Event): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<GoabFileUploadInput, never>;
-    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>;
+    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>;
 }
 
 declare class GoabFilterChip extends GoabBaseComponent implements OnInit {
     private cdr;
+    /** Shows an error state. */
     error?: boolean;
+    /** Marks the chip as deletable. */
     deletable?: boolean;
+    /** Text label of the chip. */
     content?: string;
+    /** Sets the icon theme style for the filter chip. */
     iconTheme?: GoabChipTheme;
+    /** Secondary text displayed in a smaller size before the main content. */
     secondaryText?: string;
+    /** Icon displayed at the start of the chip. */
     leadingIcon?: GoabIconType | null;
+    /** Emits when the filter chip delete button is clicked. */
     onClick: EventEmitter<any>;
     isReady: boolean;
     version: string;
@@ -570,8 +723,11 @@ declare class GoabFilterChip extends GoabBaseComponent implements OnInit {
 
 declare class GoabAppFooter implements OnInit {
     private cdr;
+    /** The maximum width of the main content area. */
     maxContentWidth?: string;
+    /** Sets a data-testid attribute for automated testing. */
     testId?: string;
+    /** URL for the Government of Alberta logo link. Set to empty string to disable the link. */
     url?: string;
     isReady: boolean;
     version: string;
@@ -582,8 +738,9 @@ declare class GoabAppFooter implements OnInit {
 
 declare class GoabAppFooterMetaSection implements OnInit {
     private cdr;
+    /** Sets a data-testid attribute for automated testing. */
     testId?: string;
-    /** "slot" is required and must equal to "meta" so it can be rendered in the correct position **/
+    /** @required Sets the slot to "meta" to render the section in the correct footer position. */
     slot: "meta";
     isReady: boolean;
     ngOnInit(): void;
@@ -593,10 +750,13 @@ declare class GoabAppFooterMetaSection implements OnInit {
 
 declare class GoabAppFooterNavSection implements OnInit {
     private cdr;
+    /** The section heading displayed above the navigation links. */
     heading?: string;
+    /** Maximum number of columns to display links in on larger screens. @default 1 */
     maxColumnCount?: number | undefined;
+    /** Sets a data-testid attribute for automated testing. */
     testId?: string;
-    /** "slot" is required and must equal to "nav" so it can be rendered in the correct position **/
+    /** @required Sets the slot to "nav" to render the section in the correct footer position. */
     slot: "nav";
     isReady: boolean;
     ngOnInit(): void;
@@ -605,10 +765,15 @@ declare class GoabAppFooterNavSection implements OnInit {
 }
 
 declare class GoabPublicForm {
+    /** The initialization status of the form. Set to "initializing" while loading external state, then "complete" when ready. @default "complete" */
     status?: GoabPublicFormStatus;
+    /** A name identifier for the form. Useful for debugging complex forms with multiple nested forms. */
     name?: string;
+    /** Emits when the form is initialized. */
     onInit: EventEmitter<Event>;
+    /** Emits when the form is complete. Emits the form state. */
     onComplete: EventEmitter<GoabFormState>;
+    /** Emits when the form state changes. Emits the updated form state. */
     onStateChange: EventEmitter<GoabFormState>;
     _onInit(e: Event): void;
     _onComplete(e: Event): void;
@@ -618,18 +783,25 @@ declare class GoabPublicForm {
 }
 
 declare class GoabPublicFormPage extends GoabBaseComponent {
+    /** Sets the id of the form page. */
     id: string;
+    /** Sets the main heading text of the form page. */
     heading: string;
+    /** Sets the sub-heading text displayed below the main heading. */
     subHeading: string;
+    /** Sets the heading used in the summary view for this page. */
     summaryHeading: string;
+    /** Sets the section title displayed above the heading. */
     sectionTitle: string;
+    /** Sets the URL for the back navigation link. */
     backUrl: string;
+    /** Sets the type of the form page step. @default "step" */
     type: GoabPublicFormPageStep;
+    /** Sets the text for the continue or confirm button. */
     buttonText: string;
+    /** Sets the visibility of the continue button. @default "visible" */
     buttonVisibility: GoabPublicFormPageButtonVisibility;
-    /**
-     * triggers when the form page continues to the next step
-     */
+    /** Emits when the form page continues to the next step. */
     onContinue: EventEmitter<Event>;
     _onContinue(event: Event): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<GoabPublicFormPage, never>;
@@ -637,16 +809,22 @@ declare class GoabPublicFormPage extends GoabBaseComponent {
 }
 
 declare class GoabPublicFormSummary {
+    /** Sets the heading text displayed above the form summary. */
     heading?: string;
     static ɵfac: i0.ɵɵFactoryDeclaration<GoabPublicFormSummary, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<GoabPublicFormSummary, "goab-public-form-summary", never, { "heading": { "alias": "heading"; "required": false; }; }, {}, never, ["*"], true, never>;
 }
 
 declare class GoabPublicSubform extends GoabBaseComponent {
+    /** Sets the id of the subform. */
     id?: string;
+    /** Sets the name identifier for the subform. */
     name?: string;
+    /** Sets the text for the continue button. */
     continueMsg?: string;
+    /** Emits when the subform is initialized. */
     onInit: EventEmitter<Event>;
+    /** Emits when the subform state changes. */
     onStateChange: EventEmitter<Event>;
     _onInit(e: Event): void;
     _onStateChange(e: Event): void;
@@ -655,30 +833,40 @@ declare class GoabPublicSubform extends GoabBaseComponent {
 }
 
 declare class GoabPublicSubformIndex extends GoabBaseComponent {
+    /** Sets the heading text of the subform index page. */
     heading?: string;
+    /** Sets the section title displayed above the heading. */
     sectionTitle?: string;
+    /** Sets the text for the action button that navigates to the subform. */
     actionButtonText?: string;
+    /** Sets the visibility of the continue button. @default "hidden" */
     buttonVisibility?: "visible" | "hidden";
     static ɵfac: i0.ɵɵFactoryDeclaration<GoabPublicSubformIndex, never>;
     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>;
 }
 
 declare class GoabPublicFormTask {
+    /** Sets the status of the task, which determines its badge display. */
     status?: GoabPublicFormTaskStatus;
     static ɵfac: i0.ɵɵFactoryDeclaration<GoabPublicFormTask, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<GoabPublicFormTask, "goab-public-form-task", never, { "status": { "alias": "status"; "required": false; }; }, {}, never, ["*"], true, never>;
 }
 
 declare class GoabPublicFormTaskList extends GoabBaseComponent {
+    /** Sets the heading text displayed above the task list. */
     heading?: string;
     static ɵfac: i0.ɵɵFactoryDeclaration<GoabPublicFormTaskList, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<GoabPublicFormTaskList, "goab-public-form-task-list", never, { "heading": { "alias": "heading"; "required": false; }; }, {}, never, ["*"], true, never>;
 }
 
 declare class GoabFieldset {
+    /** Sets the id of the fieldset. */
     id?: string;
+    /** Sets the section title displayed above the fieldset content. */
     sectionTitle?: string;
+    /** Sets when changes will be dispatched to the form. @default "continue" */
     dispatchOn: GoabFormDispatchOn;
+    /** Emits when the fieldset continues to the next step. Emits the continue detail. */
     onContinue: EventEmitter<GoabFieldsetOnContinueDetail>;
     _onContinue(event: Event): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<GoabFieldset, never>;
@@ -687,21 +875,25 @@ declare class GoabFieldset {
 
 declare class GoabFormItem extends GoabBaseComponent implements OnInit {
     private cdr;
+    /** Creates a label for the form item. */
     label?: string;
+    /** Sets the label size. 'regular' for standard, 'large' for emphasis. */
     labelSize?: GoabFormItemLabelSize;
+    /** Help text displayed under the form field to provide additional explanation. */
     helpText?: string;
+    /** Error text displayed under the form field. Leave blank to indicate a valid field. */
     error?: string;
+    /** Marks the field with an optional or required label indicator. */
     requirement?: GoabFormItemRequirement;
+    /** Sets the maximum width of the form item. */
     maxWidth?: string;
+    /** Sets the id attribute on the form item element. */
     id?: string;
+    /** Specifies the input type for appropriate message spacing. Used with checkbox-list or radio-group. */
     type?: GoabFormItemType;
-    /**
-     * Public form: to arrange fields in the summary
-     */
+    /** Sets the display order within the form summary. For public-form use only. */
     publicFormSummaryOrder?: number;
-    /**
-     * Public form: allow to override the label value within the form-summary to provide a shorter description of the value
-     */
+    /** Overrides the label value within the form-summary to provide a shorter description. For public-form use only. */
     name?: string;
     isReady: boolean;
     version: string;
@@ -711,6 +903,7 @@ declare class GoabFormItem extends GoabBaseComponent implements OnInit {
 }
 
 declare class GoabFormItemSlot {
+    /** @required Sets which form-item slot this content should render into. */
     slot: "helptext" | "error";
     static ɵfac: i0.ɵɵFactoryDeclaration<GoabFormItemSlot, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<GoabFormItemSlot, "goab-form-item-slot", never, { "slot": { "alias": "slot"; "required": true; }; }, {}, never, ["*"], true, never>;
@@ -718,7 +911,9 @@ declare class GoabFormItemSlot {
 
 declare class GoabFormStep implements OnInit {
     private cdr;
+    /** The step label text displayed to users. */
     text?: string;
+    /** The completion status of the step. Affects visual styling and icons. */
     status?: GoabFormStepStatus;
     isReady: boolean;
     ngOnInit(): void;
@@ -728,7 +923,9 @@ declare class GoabFormStep implements OnInit {
 
 declare class GoabFormStepper extends GoabBaseComponent implements OnInit {
     private cdr;
+    /** The current step state value (1-based index). Leaving it blank (-1) will allow any step to be accessed. @default -1 */
     step?: number;
+    /** Emits when the form stepper step changes. Emits the new step as GoabFormStepperOnChangeDetail. */
     onChange: EventEmitter<GoabFormStepperOnChangeDetail>;
     isReady: boolean;
     ngOnInit(): void;
@@ -740,7 +937,9 @@ declare class GoabFormStepper extends GoabBaseComponent implements OnInit {
 declare class GoabGrid extends GoabBaseComponent implements OnInit {
     private cdr;
     isReady: boolean;
+    /** @required Minimum width of the child elements. */
     minChildWidth: string;
+    /** Gap between child items. */
     gap?: Spacing;
     ngOnInit(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<GoabGrid, never>;
@@ -749,14 +948,20 @@ declare class GoabGrid extends GoabBaseComponent implements OnInit {
 
 declare class GoabAppHeader extends GoabBaseComponent implements OnInit {
     private cdr;
+    /** Sets the URL to link from the alberta.ca logo. A full url is required. */
     url?: string;
+    /** Sets the service name to display in the app header. */
     heading?: string;
+    /** V2 only: Secondary text displayed under the service name. */
     secondaryText?: string;
+    /** Maximum width of the content area. */
     maxContentWidth?: string;
+    /** Sets the breakpoint in px for the full menu to display. */
     fullMenuBreakpoint?: number;
     isReady: boolean;
     version: string;
     ngOnInit(): void;
+    /** Emits when the menu button is clicked. Used for custom menu handling. */
     onMenuClick: EventEmitter<any>;
     _onMenuClick(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<GoabAppHeader, never>;
@@ -766,8 +971,11 @@ declare class GoabAppHeader extends GoabBaseComponent implements OnInit {
 
 declare class GoabAppHeaderMenu extends GoabBaseComponent implements OnInit {
     private cdr;
+    /** Icon displayed before the heading text. */
     leadingIcon?: GoabIconType;
+    /** The menu heading text displayed as the dropdown trigger. */
     heading?: string;
+    /** Sets the slot name for the component. */
     slotName?: string;
     get hostSlot(): string | null;
     isReady: boolean;
@@ -779,13 +987,21 @@ declare class GoabAppHeaderMenu extends GoabBaseComponent implements OnInit {
 declare class GoabHeroBanner implements OnInit {
     private cdr;
     isReady: boolean;
+    /** Main heading text. */
     heading?: string;
+    /** Background image url. */
     backgroundUrl?: string;
+    /** Minimum height of the hero banner. Defaults to 600px when a background image is provided. */
     minHeight?: string;
+    /** Sets a data-testid attribute for automated testing. */
     testId?: string;
+    /** Maximum width of the content area. */
     maxContentWidth?: string;
+    /** Hero Banner background color when no background image is provided. */
     backgroundColor?: string;
+    /** Text color within the hero banner. */
     textColor?: string;
+    /** Angular template reference for the actions slot content. */
     actions: TemplateRef<any>;
     ngOnInit(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<GoabHeroBanner, never>;
@@ -794,13 +1010,21 @@ declare class GoabHeroBanner implements OnInit {
 
 declare class GoabIcon extends GoabBaseComponent implements OnInit {
     private cdr;
+    /** @required The icon type to display. See GoabIconType for available icons. */
     type: GoabIconType | GoabIconOverridesType;
+    /** Sets the size of the icon. Accepts numeric (1-6) or named sizes. @default "medium" */
     size?: GoabIconSize;
+    /** Sets the icon theme. 'outline' shows stroked icons, 'filled' shows solid icons. */
     theme?: GoabIconTheme;
+    /** When true, inverts the icon colors for use on dark backgrounds. */
     inverted?: boolean;
+    /** Sets a custom fill color for the icon. Accepts any valid CSS color value. */
     fillColor?: string;
+    /** Sets the opacity of the icon from 0 (transparent) to 1 (opaque). */
     opacity?: number;
+    /** Adds an accessible title to the icon SVG. Used by screen readers. */
     title?: string;
+    /** Defines how the icon will be announced by screen readers. */
     ariaLabel?: string;
     isReady: boolean;
     ngOnInit(): void;
@@ -814,15 +1038,25 @@ declare class GoabIconButton extends GoabBaseComponent implements OnInit {
     private cdr;
     isReady: boolean;
     protected readonly JSON: JSON;
+    /** @required Sets the icon. */
     icon: GoabIconType;
+    /** Sets the size of button. @default "medium" */
     size?: GoabIconSize;
+    /** Styles the button to show color, light, dark or destructive action. */
     variant?: GoabIconButtonVariant;
+    /** Sets the title of the button. */
     title?: string;
+    /** Disables the button. */
     disabled?: boolean;
+    /** Sets the aria-label of the button. */
     ariaLabel?: string;
+    /** Action identifier passed in click events for event delegation patterns. */
     action?: string;
+    /** Single argument value passed with the action in click events. */
     actionArg?: string;
+    /** Multiple argument values passed with the action in click events. */
     actionArgs?: Record<string, unknown>;
+    /** Emits when the icon button is clicked. */
     onClick: EventEmitter<any>;
     ngOnInit(): void;
     _onClick(): void;
@@ -833,35 +1067,65 @@ declare class GoabIconButton extends GoabBaseComponent implements OnInit {
 
 declare class GoabInput extends GoabControlValueAccessor implements OnInit {
     private cdr;
+    /** Sets the type of the input field. @default "text" */
     type?: GoabInputType;
+    /** Name of input value that is received in the onChange event. */
     name?: string;
+    /** Debounce delay in milliseconds before firing the change event. 0 means no debounce. */
     debounce?: number;
+    /** Controls whether and how text input is automatically capitalized as it is entered/edited by the user. This only works on mobile devices. */
     autoCapitalize?: GoabInputAutoCapitalize;
+    /** Specifies the autocomplete attribute for the input field. */
     autoComplete?: string;
+    /** Text displayed within the input when no value is set. */
     placeholder?: string;
+    /** Icon shown to the left of the text. */
     leadingIcon?: GoabIconType;
+    /** Icon shown to the right of the text. */
     trailingIcon?: GoabIconType;
+    /** Sets the visual style variant. 'goa' for standard GoA styling, 'bare' for minimal styling. */
     variant?: string;
+    /** Sets the cursor focus to the input. */
     focused?: boolean;
+    /** Makes the input readonly. */
     readonly?: boolean;
+    /** Sets the width of the text input area. */
     width?: string;
+    /** @deprecated Use leadingContent slot instead. */
     prefix?: string;
+    /** @deprecated Use trailingContent slot instead. */
     suffix?: string;
+    /** Defines how the input will be translated for the screen reader. If not specified it will fall back to the name. */
     ariaLabel?: string;
+    /** Sets the maximum number of characters (as UTF-16 code units) the user can enter into the input. */
     maxLength?: number;
+    /** A string value that supports any number, or an ISO 8601 format if using the date or datetime type. */
     min?: string | number;
+    /** A string value that supports any number, or an ISO 8601 format if using the date or datetime type. */
     max?: string | number;
+    /** How much a number or date should change by. */
     step?: number;
+    /** The aria-labelledby attribute identifies the element (or elements) that labels the input. */
     ariaLabelledBy?: string;
+    /** Aria label for the trailing icon. Use only when the trailing icon is interactive. */
     trailingIconAriaLabel?: string;
+    /** Sets the text alignment within the input field. @default "left" */
     textAlign?: "left" | "right";
+    /** Sets the leading content slot, accepting a string or template reference. */
     leadingContent: string | TemplateRef<any>;
+    /** Sets the trailing content slot, accepting a string or template reference. */
     trailingContent: string | TemplateRef<any>;
+    /** Sets the size of the input. 'compact' reduces height for dense layouts. @default "default" */
     size?: GoabInputSize;
+    /** Emits when the trailing icon is clicked. */
     onTrailingIconClick: EventEmitter<any>;
+    /** Emits when the input receives focus. Emits focus detail including the current value. */
     onFocus: EventEmitter<GoabInputOnFocusDetail>;
+    /** Emits when the input loses focus. Emits blur detail including the current value. */
     onBlur: EventEmitter<GoabInputOnBlurDetail>;
+    /** Emits when a key is pressed in the input. Emits key press detail including the value and key pressed. */
     onKeyPress: EventEmitter<GoabInputOnKeyPressDetail>;
+    /** Emits when the input value changes. Emits change detail including the new value. */
     onChange: EventEmitter<GoabInputOnChangeDetail>;
     version: string;
     isReady: boolean;
@@ -888,42 +1152,79 @@ declare class GoabInput extends GoabControlValueAccessor implements OnInit {
 declare class GoabInputNumber implements ControlValueAccessor, OnInit {
     private cdr;
     isReady: boolean;
+    /** Sets the type of the input field. @default "number" */
     type: GoabInputType;
+    /** Name of input value that is received in the onChange event. */
     name?: string;
+    /** Unique identifier for the input element. Used for label associations and accessibility. */
     id?: string;
+    /** Debounce delay in milliseconds before firing the change event. 0 means no debounce. */
     debounce?: number;
+    /** Disables this input. The input will not receive focus or events. */
     disabled?: boolean;
+    /** Controls whether and how text input is automatically capitalized as it is entered/edited by the user. This only works on mobile devices. */
     autoCapitalize?: GoabInputAutoCapitalize;
+    /** Text displayed within the input when no value is set. */
     placeholder?: string;
+    /** Icon shown to the left of the text. */
     leadingIcon?: GoabIconType;
+    /** Icon shown to the right of the text. */
     trailingIcon?: GoabIconType;
+    /** Sets the visual style variant. 'goa' for standard GoA styling, 'bare' for minimal styling. */
     variant?: string;
+    /** Sets the cursor focus to the input. */
     focused?: boolean;
+    /** Makes the input readonly. */
     readonly?: boolean;
+    /** Sets the input to an error state. */
     error?: boolean;
+    /** Sets the width of the text input area. */
     width?: string;
+    /** @deprecated Use leadingContent slot instead. */
     prefix?: string;
+    /** @deprecated Use trailingContent slot instead. */
     suffix?: string;
+    /** Sets a data-testid attribute for automated testing. */
     testId?: string;
+    /** Defines how the input will be translated for the screen reader. If not specified it will fall back to the name. */
     ariaLabel?: string;
+    /** Sets the maximum number of characters (as UTF-16 code units) the user can enter into the input. */
     maxLength?: number;
+    /** A string value that supports any number, or an ISO 8601 format if using the date or datetime type. */
     min?: string | number;
+    /** A string value that supports any number, or an ISO 8601 format if using the date or datetime type. */
     max?: string | number;
+    /** How much a number or date should change by. */
     step?: number;
+    /** The aria-labelledby attribute identifies the element (or elements) that labels the input. */
     ariaLabelledBy?: string;
+    /** Top margin. */
     mt?: Spacing;
+    /** Right margin. */
     mr?: Spacing;
+    /** Bottom margin. */
     mb?: Spacing;
+    /** Left margin. */
     ml?: Spacing;
+    /** Aria label for the trailing icon. Use only when the trailing icon is interactive. */
     trailingIconAriaLabel?: string;
+    /** Sets the text alignment within the input field. @default "right" */
     textAlign?: "left" | "right";
+    /** Bound to value. */
     value: number | null;
+    /** Sets the leading content slot, accepting a string or template reference. */
     leadingContent: string | TemplateRef<any>;
+    /** Sets the trailing content slot, accepting a string or template reference. */
     trailingContent: string | TemplateRef<any>;
+    /** Emits when the trailing icon is clicked. */
     onTrailingIconClick: EventEmitter<void>;
+    /** Emits when the input receives focus. Emits focus detail including the current value. */
     onFocus: EventEmitter<GoabInputOnFocusDetail>;
+    /** Emits when the input loses focus. Emits blur detail including the current value. */
     onBlur: EventEmitter<GoabInputOnBlurDetail>;
+    /** Emits when a key is pressed in the input. Emits key press detail including the value and key pressed. */
     onKeyPress: EventEmitter<GoabInputOnKeyPressDetail>;
+    /** Emits when the input value changes. Emits change detail including the new value. */
     onChange: EventEmitter<GoabInputOnChangeDetail>;
     handleTrailingIconClick: boolean;
     ngOnInit(): void;
@@ -957,10 +1258,15 @@ declare class GoabInputNumber implements ControlValueAccessor, OnInit {
 
 declare class GoabLinearProgress implements OnInit {
     private cdr;
+    /** Progress value (0-100). When undefined, shows an indeterminate loading animation. */
     progress?: number | null | undefined;
+    /** Controls visibility of the percentage text. */
     percentVisibility?: "visible" | "hidden" | undefined;
+    /** Accessible label for the progress bar. */
     ariaLabel?: string;
+    /** ID of the element that labels this progress bar. */
     ariaLabelledBy?: string;
+    /** Sets a data-testid attribute for automated testing. */
     testid?: string;
     isReady: boolean;
     ngOnInit(): void;
@@ -971,17 +1277,29 @@ declare class GoabLinearProgress implements OnInit {
 declare class GoabLink implements OnInit {
     private cdr;
     isReady: boolean;
+    /** Icon displayed before the link text. */
     leadingIcon?: GoabIconType;
+    /** Icon displayed after the link text. */
     trailingIcon?: GoabIconType;
+    /** Sets a data-testid attribute for automated testing. */
     testId?: string;
+    /** Custom action event name to dispatch when the link is clicked. */
     action?: string;
+    /** Sets the color theme. 'interactive' for blue, 'dark' for black, 'light' for white text. @default "interactive" */
     color?: GoabLinkColor;
+    /** Sets the text size and corresponding icon size. @default "medium" */
     size?: GoabLinkSize;
+    /** Single argument to pass with the action event (deprecated, use actionArgs). */
     actionArg?: string;
+    /** Object of arguments to pass with the action event. */
     actionArgs?: Record<string, unknown>;
+    /** Top margin. */
     mt?: Spacing;
+    /** Bottom margin. */
     mb?: Spacing;
+    /** Left margin. */
     ml?: Spacing;
+    /** Right margin. */
     mr?: Spacing;
     ngOnInit(): void;
     protected readonly JSON: JSON;
@@ -992,14 +1310,22 @@ declare class GoabLink implements OnInit {
 declare class GoabMicrositeHeader implements OnInit {
     private cdr;
     isReady: boolean;
+    /** @required The service type which determines the badge style. "live" shows official government site text, "alpha" and "beta" show development stage badges. */
     type: GoabServiceLevel;
+    /** @required App or service version displayed on the right side of the header. */
     version: string | TemplateRef<any>;
+    /** Url to feedback page that will be displayed when provided. */
     feedbackUrl?: string;
+    /** Sets a data-testid attribute for automated testing. */
     testId?: string;
+    /** Maximum width of the content area. */
     maxContentWidth?: string;
+    /** For internal feedback urls sets target. */
     feedbackUrlTarget?: GoabLinkTarget;
+    /** Sets the target attribute for the header link. */
     headerUrlTarget?: GoabLinkTarget;
     ngOnInit(): void;
+    /** Emits when the feedback link is clicked. */
     onFeedbackClick: EventEmitter<any>;
     getVersionAsString(): string;
     getVersionAsTemplate(): TemplateRef<any> | null;
@@ -1013,19 +1339,28 @@ declare class GoabModal implements OnInit {
     isReady: boolean;
     version: string;
     ngOnInit(): void;
+    /** Define the context and colour of the callout modal. It is required when type is set to callout. */
     calloutVariant?: GoabModalCalloutVariant;
+    /** Controls if modal is visible or not. */
     open?: boolean;
+    /** Set the max allowed width of the modal. */
     maxWidth?: string;
+    /** Show close icon and allow clicking the background to close the modal. */
     closable: boolean;
+    /** Sets the animation transition when opening/closing. 'fast' or 'slow' for animated, 'none' for instant. */
     transition?: GoabModalTransition;
+    /** Sets a data-testid attribute for automated testing. */
     testId?: string;
     /**
      * @deprecated The role property is deprecated and will be removed in a future version.
      * The modal will always use role="dialog".
      */
     role?: string;
+    /** The heading text displayed at the top of the modal. */
     heading: string | TemplateRef<any>;
+    /** Sets the template reference for the modal action buttons. */
     actions: TemplateRef<any>;
+    /** Emits when the modal is closed. */
     onClose: EventEmitter<any>;
     getHeadingAsString(): string;
     getHeadingAsTemplate(): TemplateRef<any> | null;
@@ -1036,14 +1371,23 @@ declare class GoabModal implements OnInit {
 }
 
 declare class GoabMenuButton {
+    /** The button label text. When provided, displays as a text button with a dropdown icon. */
     text?: string;
+    /** The button style variant. */
     type?: GoabButtonType;
+    /** Sets the size of the button. */
     size?: GoabButtonSize;
+    /** Sets the color variant for semantic meaning. */
     variant?: GoabButtonVariant;
+    /** Maximum width of the dropdown menu. */
     maxWidth?: string;
+    /** Icon displayed before the button text. When no text is provided, displays as an icon button. */
     leadingIcon?: GoabIconType;
+    /** Sets the aria-label for the icon button in icon-only mode. */
     ariaLabel?: string;
+    /** Sets a data-testid attribute for automated testing. */
     testId?: string;
+    /** Emits when a menu action is clicked. Emits the action detail. */
     onAction: EventEmitter<GoabMenuButtonOnActionDetail>;
     _onAction(e: Event): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<GoabMenuButton, never>;
@@ -1051,9 +1395,13 @@ declare class GoabMenuButton {
 }
 
 declare class GoabMenuAction {
+    /** @required Display text for the menu action. */
     text: string;
+    /** @required Action identifier included in the click event. */
     action: string;
+    /** Icon displayed before the text. */
     icon?: GoabIconType;
+    /** Sets a data-testid attribute for automated testing. */
     testId?: string;
     static ɵfac: i0.ɵɵFactoryDeclaration<GoabMenuAction, never>;
     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 +1411,20 @@ declare class GoabNotification implements OnInit {
     private cdr;
     isReady: boolean;
     version: string;
+    /** Define the context and colour of the notification. @default "information" */
     type?: GoabNotificationType;
+    /** Indicates how assistive technology should handle updates to the live region. */
     ariaLive?: GoabAriaLiveType;
+    /** Maximum width of the content area. */
     maxContentWidth?: string;
+    /** Sets the visual prominence. 'high' for full background, 'low' for medium. @default "high" */
     emphasis?: GoabNotificationEmphasis;
+    /** When true, reduces padding for a more compact notification. */
     compact?: boolean;
+    /** Sets a data-testid attribute for automated testing. */
     testId?: string;
     ngOnInit(): void;
+    /** Emits when the notification is dismissed. */
     onDismiss: EventEmitter<any>;
     _onDismiss(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<GoabNotification, never>;
@@ -1080,7 +1435,9 @@ declare class GoabNotification implements OnInit {
 declare class GoabPageBlock implements OnInit {
     private cdr;
     isReady: boolean;
+    /** Maximum width of the content area. Use "full" for 100% width or a CSS dimension like "1200px". */
     width?: GoabPageBlockSize;
+    /** Sets a data-testid attribute for automated testing. */
     testId?: string;
     ngOnInit(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<GoabPageBlock, never>;
@@ -1090,6 +1447,7 @@ declare class GoabPageBlock implements OnInit {
 declare class GoabPages extends GoabBaseComponent implements OnInit {
     private cdr;
     isReady: boolean;
+    /** The currently visible page (1-based index). */
     current?: number;
     ngOnInit(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<GoabPages, never>;
@@ -1101,11 +1459,16 @@ declare class GoabPagination extends GoabBaseComponent implements OnInit {
     private cdr;
     isReady: boolean;
     version: string;
+    /** @required Total number of data items within all pages. */
     itemCount: number;
+    /** @required The current page being viewed (non-zero based). */
     pageNumber: number;
+    /** Number of data items shown per page. @default 10 */
     perPageCount?: number;
+    /** Controls which nav controls are visible. @default "all" */
     variant?: GoabPaginationVariant;
     ngOnInit(): void;
+    /** Emits when the page changes. Emits the new page number as part of the change detail. */
     onChange: EventEmitter<GoabPaginationOnChangeDetail>;
     _onChange(e: Event): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<GoabPagination, never>;
@@ -1115,14 +1478,17 @@ declare class GoabPagination extends GoabBaseComponent implements OnInit {
 declare class GoabPopover extends GoabBaseComponent implements OnInit {
     private cdr;
     isReady: boolean;
+    /** Sets the maximum width of the popover container. @default "320px" */
     maxWidth: string;
+    /** Sets the minimum width of the popover container. */
     minWidth?: string;
+    /** Sets if the popover has padding. Use false when content needs to be flush with boundaries. @default true */
     padded: boolean;
+    /** Provides control to where the popover content is positioned. */
     position?: GoabPopoverPosition;
-    /***
-     * @deprecated This property has no effect and will be removed in a future version
-     */
+    /** @deprecated This property has no effect and will be removed in a future version. */
     relative?: boolean;
+    /** @required Sets the target template reference for the popover trigger. */
     target: TemplateRef<any>;
     ngOnInit(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<GoabPopover, never>;
@@ -1132,11 +1498,17 @@ declare class GoabPopover extends GoabBaseComponent implements OnInit {
 declare class GoabPushDrawer implements OnInit {
     private cdr;
     version: string;
+    /** Sets the open state of the push drawer. */
     open?: boolean;
+    /** Sets the heading text or template for the push drawer. */
     heading: string | TemplateRef<any>;
+    /** Sets the width of the push drawer panel. */
     width?: string;
+    /** Sets a data-testid attribute for automated testing. */
     testId?: string;
+    /** Sets the template reference for the actions slot content. */
     actions: TemplateRef<any>;
+    /** Emits when the push drawer closes. */
     onClose: EventEmitter<any>;
     isReady: boolean;
     ngOnInit(): void;
@@ -1152,11 +1524,16 @@ declare class GoabRadioGroup extends GoabControlValueAccessor implements OnInit
     private cdr;
     isReady: boolean;
     version: string;
+    /** The name for the radio group. Used for accessibility and change events. */
     name?: string;
+    /** Sets the layout direction. 'vertical' stacks items, 'horizontal' places them in a row. */
     orientation?: GoabRadioGroupOrientation;
+    /** Defines how the radio group will be announced by screen readers. */
     ariaLabel?: string;
+    /** Sets the size of all radio items. 'compact' reduces spacing for dense layouts (V2 only). @default "default" */
     size?: GoabRadioGroupSize;
     ngOnInit(): void;
+    /** Emits when the selected radio item changes. Emits the name, value, and event of the selected item. */
     onChange: EventEmitter<GoabRadioGroupOnChangeDetail>;
     _onChange(e: Event): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<GoabRadioGroup, never>;
@@ -1165,17 +1542,29 @@ declare class GoabRadioGroup extends GoabControlValueAccessor implements OnInit
 
 declare class GoabRadioItem extends GoabBaseComponent implements OnInit {
     private cdr;
+    /** The value of this radio option. Will be emitted when selected. */
     value?: string;
+    /** The display label for this radio option. Falls back to value if not provided. */
     label?: string;
+    /** The name of the radio group. Inherited from the parent RadioGroup if not set. */
     name?: string;
+    /** Additional description text displayed below the label. */
     description: string | TemplateRef<any>;
+    /** Sets the template reference for the reveal slot content. */
     reveal?: TemplateRef<any>;
+    /** Defines how this option will be announced by screen readers. */
     ariaLabel?: string;
+    /** Text announced by screen readers when the reveal slot content is displayed. */
     revealAriaLabel?: string;
+    /** Disables this radio option. Also disabled if the parent RadioGroup is disabled. */
     disabled?: boolean;
+    /** Sets this radio option as checked/selected. */
     checked?: boolean;
+    /** Shows an error state on this radio option. */
     error?: boolean;
+    /** Sets the maximum width of this radio item. */
     maxWidth?: string;
+    /** Enables compact layout for the radio item, reducing spacing for dense layouts. */
     compact?: boolean;
     isReady: boolean;
     version: string;
@@ -1194,6 +1583,7 @@ declare class GoabSideMenu implements OnInit {
     private cdr;
     isReady: boolean;
     version: string;
+    /** Sets a data-testid attribute for automated testing. */
     testId?: string;
     ngOnInit(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<GoabSideMenu, never>;
@@ -1204,7 +1594,9 @@ declare class GoabSideMenuGroup extends GoabBaseComponent implements OnInit {
     private cdr;
     isReady: boolean;
     version: string;
+    /** @required The heading text for the menu group. */
     heading: string;
+    /** Icon displayed alongside the heading. */
     icon?: GoabIconType;
     ngOnInit(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<GoabSideMenuGroup, never>;
@@ -1215,8 +1607,11 @@ declare class GoabSideMenuHeading implements OnInit {
     private cdr;
     isReady: boolean;
     version: string;
+    /** @required Icon displayed before the heading text. */
     icon: GoabIconType;
+    /** Sets a data-testid attribute for automated testing. */
     testId?: string;
+    /** Sets the template for the meta slot content. */
     meta: TemplateRef<any>;
     ngOnInit(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<GoabSideMenuHeading, never>;
@@ -1226,9 +1621,13 @@ declare class GoabSideMenuHeading implements OnInit {
 declare class GoabSkeleton extends GoabBaseComponent implements OnInit {
     private cdr;
     isReady: boolean;
+    /** @required Sets the skeleton shape to represent your content. */
     type: GoabSkeletonType;
+    /** Sets the maximum width. Currently only used in card skeleton type. @default "300px" */
     maxWidth: string;
+    /** Size can affect either the height, width or both for different skeleton types. */
     size?: GoabSkeletonSize;
+    /** Used within components that contain multiple lines. Currently only used in card skeleton type. */
     lineCount?: number;
     ngOnInit(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<GoabSkeleton, never>;
@@ -1239,8 +1638,11 @@ declare class GoabSkeleton extends GoabBaseComponent implements OnInit {
 declare class GoabSpacer implements OnInit {
     private cdr;
     isReady: boolean;
+    /** Horizontal spacing. */
     hSpacing?: GoabSpacerHorizontalSpacing;
+    /** Vertical spacing. */
     vSpacing?: GoabSpacerVerticalSpacing;
+    /** Sets a data-testid attribute for automated testing. */
     testId?: string;
     ngOnInit(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<GoabSpacer, never>;
@@ -1250,8 +1652,11 @@ declare class GoabSpacer implements OnInit {
 declare class GoabTab implements OnInit {
     private cdr;
     isReady: boolean;
+    /** The text label for this tab. Can also use the heading slot for custom content. */
     heading: string | TemplateRef<any>;
+    /** When true, disables the tab. */
     disabled?: boolean;
+    /** Sets the URL slug for the tab. */
     slug?: string;
     ngOnInit(): void;
     getHeadingAsString(): string;
@@ -1265,12 +1670,18 @@ declare class GoabTable extends GoabBaseComponent implements OnInit {
     private cdr;
     isReady: boolean;
     version: string;
+    /** Width of the table. By default it will fit the enclosed content. */
     width?: string;
+    /** Sets a relaxed variant of the table with more vertical padding for the cells. */
     variant?: GoabTableVariant;
+    /** Sets sort mode: "single" allows one column, "multi" allows up to 2 columns. */
     sortMode?: GoabTableSortMode;
+    /** When true, alternates row background colors for improved readability. */
     striped?: boolean;
     ngOnInit(): void;
+    /** Emits when a table column is sorted. Emits the sort column and direction as GoabTableOnSortDetail. */
     onSort: EventEmitter<GoabTableOnSortDetail>;
+    /** Emits when multi-column sorting changes. Emits an array of sort entries as GoabTableOnMultiSortDetail. */
     onMultiSort: EventEmitter<GoabTableOnMultiSortDetail>;
     _onSort(e: Event): void;
     _onMultiSort(e: Event): void;
@@ -1282,8 +1693,11 @@ declare class GoabTable extends GoabBaseComponent implements OnInit {
 declare class GoabTableSortHeader implements OnInit {
     private cdr;
     isReady: boolean;
+    /** Column name identifier for sorting. */
     name?: string;
+    /** Sets the sort direction indicator. @default "none" */
     direction?: GoabTableSortDirection;
+    /** Sort order number for multi-column sort display ("1", "2", etc). */
     sortOrder?: GoabTableSortOrder;
     ngOnInit(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<GoabTableSortHeader, never>;
@@ -1294,13 +1708,18 @@ declare class GoabTabs implements OnInit {
     private cdr;
     isReady: boolean;
     version: string;
+    /** The initially active tab (1-based index). If not set, the first tab is active. */
     initialTab?: number;
+    /** Sets a data-testid attribute for automated testing. */
     testId?: string;
+    /** Visual style variant. "segmented" shows pill-style tabs with animation. */
     variant?: GoabTabsVariant;
     /** Tab layout orientation. "auto" stacks vertically on mobile (default), "horizontal" keeps horizontal on all screen sizes. */
     orientation?: GoabTabsOrientation;
+    /** Sets the navigation mode for tab switching. "hash" updates the URL hash when switching tabs. */
     navigation?: GoabTabsNavigation;
     ngOnInit(): void;
+    /** Emits when the active tab changes. Emits the new tab index as GoabTabsOnChangeDetail. */
     onChange: EventEmitter<GoabTabsOnChangeDetail>;
     _onChange(e: Event): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<GoabTabs, never>;
@@ -1313,8 +1732,11 @@ type SnackbarHorizontalPosition = "left" | "center" | "right";
 declare class GoabTemporaryNotificationCtrl implements OnInit {
     private cdr;
     isReady: boolean;
+    /** Vertical position of the notification container. @default "bottom" */
     verticalPosition: SnackbarVerticalPosition;
+    /** Horizontal position of the notification container. @default "center" */
     horizontalPosition: SnackbarHorizontalPosition;
+    /** Sets a data-testid attribute for automated testing. */
     testId?: string;
     ngOnInit(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<GoabTemporaryNotificationCtrl, never>;
@@ -1323,15 +1745,24 @@ declare class GoabTemporaryNotificationCtrl implements OnInit {
 
 declare class GoabText implements OnInit {
     private cdr;
+    /** The HTML element to render. Use semantic elements like 'h1'-'h6' for headings. */
     tag?: GoabTextTextElement | GoabTextHeadingElement;
+    /** Overrides the text size. */
     size?: GoabTextSize;
+    /** Sets the max width. */
     maxWidth?: GoabTextMaxWidth;
+    /** Sets the text colour. */
     color?: GoabTextColor;
+    /** Sets the id attribute on the host element. */
     id?: string;
     get hostId(): string | undefined;
+    /** Top margin. */
     mt?: Spacing;
+    /** Bottom margin. */
     mb?: Spacing;
+    /** Left margin. */
     ml?: Spacing;
+    /** Right margin. */
     mr?: Spacing;
     isReady: boolean;
     ngOnInit(): void;
@@ -1341,19 +1772,33 @@ declare class GoabText implements OnInit {
 
 declare class GoabTextArea extends GoabControlValueAccessor implements OnInit {
     private cdr;
+    /** Name of the input value that is received in the _change event. */
     name?: string;
+    /** Text displayed within the input when no value is set. */
     placeholder?: string;
+    /** Set the number of rows. @default 3 */
     rows?: number;
+    /** Sets the input to a read only state. */
     readOnly?: boolean;
+    /** Width of the text area. */
     width?: string;
+    /** Defines how the text will be translated for the screen reader. If not specified it will fall back to the name. */
     ariaLabel?: string;
+    /** Counting interval for characters or words, specifying whether to count every character or word. @default "" */
     countBy?: GoabTextAreaCountBy;
+    /** Maximum number of characters or words allowed. @default -1 */
     maxCount?: number;
+    /** Maximum width of the text area. */
     maxWidth?: string;
+    /** Specifies the autocomplete attribute for the textarea input. @default "on" */
     autoComplete?: string;
+    /** Sets the size variant of the textarea. @default "default" */
     size?: GoabTextAreaSize;
+    /** Emits when the textarea value changes. Emits the name and new value. */
     onChange: EventEmitter<GoabTextAreaOnChangeDetail>;
+    /** Emits when a key is pressed in the textarea. Emits the name, value, and key. */
     onKeyPress: EventEmitter<GoabTextAreaOnKeyPressDetail>;
+    /** Emits when the textarea loses focus. Emits the name and current value. */
     onBlur: EventEmitter<GoabTextAreaOnBlurDetail>;
     isReady: boolean;
     version: string;
@@ -1370,9 +1815,13 @@ declare class GoabTextArea extends GoabControlValueAccessor implements OnInit {
 declare class GoabTooltip extends GoabBaseComponent implements OnInit {
     private cdr;
     isReady: boolean;
+    /** Position with respect to the child element. @default "top" */
     position?: GoabTooltipPosition;
+    /** The content of the tooltip. */
     content?: string | TemplateRef<unknown>;
+    /** Horizontal alignment to the child element. @default "center" */
     hAlign?: GoabTooltipHorizontalAlignment;
+    /** Sets the maximum width of the tooltip. Must use 'px' unit. */
     maxWidth?: string;
     ngOnInit(): void;
     getContentAsString(): string;
@@ -1383,16 +1832,27 @@ declare class GoabTooltip extends GoabBaseComponent implements OnInit {
 
 declare class GoabWorkSideMenu implements OnInit {
     private cdr;
+    /** @required The application name displayed in the header. */
     heading: string;
+    /** @required URL for the header link. Clicking the logo/heading navigates to this URL. */
     url: string;
+    /** User's name displayed in the profile section. */
     userName?: string;
+    /** Secondary text displayed below the user's name, such as role or email. */
     userSecondaryText?: string;
+    /** Controls whether the side menu is expanded or collapsed. */
     open?: boolean;
+    /** Sets a data-testid attribute for automated testing. */
     testId?: string;
+    /** Template reference for the primary navigation slot content. */
     primaryContent: TemplateRef<any>;
+    /** Template reference for the secondary navigation slot content. */
     secondaryContent: TemplateRef<any>;
+    /** Template reference for the account slot content. */
     accountContent: TemplateRef<any>;
+    /** Emits when the side menu is toggled open or closed. */
     onToggle: EventEmitter<any>;
+    /** Emits when a navigation link is clicked. Emits the URL as a string. */
     onNavigate: EventEmitter<string>;
     isReady: boolean;
     ngOnInit(): void;
@@ -1405,9 +1865,13 @@ declare class GoabWorkSideMenu implements OnInit {
 
 declare class GoabWorkSideMenuGroup implements OnInit {
     private cdr;
+    /** @required The text displayed in the group heading. */
     heading: string;
+    /** Icon displayed before the group label. When omitted, no icon is rendered and no space is reserved. */
     icon?: GoabIconType;
+    /** Whether the group is open. */
     open?: boolean;
+    /** Sets a data-testid attribute for automated testing. */
     testId?: string;
     isReady: boolean;
     ngOnInit(): void;
@@ -1418,14 +1882,23 @@ declare class GoabWorkSideMenuGroup implements OnInit {
 
 declare class GoabWorkSideMenuItem implements OnInit {
     private cdr;
+    /** @required The text label displayed for the menu item. */
     label: string;
+    /** The URL the menu item links to. Optional — when absent, renders as a button instead of a link. */
     url?: string;
+    /** Badge text displayed alongside the menu item (e.g., notification count). */
     badge?: string;
+    /** When true, indicates this is the currently active menu item. */
     current?: boolean;
+    /** When true, displays a divider line above this menu item. */
     divider?: boolean;
+    /** Icon displayed before the menu item label. */
     icon?: string;
+    /** Sets a data-testid attribute for automated testing. */
     testId?: string;
+    /** Sets the visual style of the badge. Use "emergency" for urgent items, "success" for positive status. @default "normal" */
     type?: GoabWorkSideMenuItemType;
+    /** Template reference for the popover content slot. */
     popoverContent: TemplateRef<any>;
     isReady: boolean;
     ngOnInit(): void;
@@ -1435,13 +1908,21 @@ declare class GoabWorkSideMenuItem implements OnInit {
 
 declare class GoabWorkSideNotificationItem implements OnInit {
     private cdr;
+    /** Sets the visual style of the notification item. */
     type?: GoabWorkSideNotificationItemType;
+    /** The timestamp for when the notification was created. */
     timestamp?: string;
+    /** The title text of the notification item. */
     title?: string;
+    /** @required The description text of the notification item. */
     description: string;
+    /** Indicates whether the notification is read or unread. */
     readStatus?: GoabWorkSideNotificationReadStatus;
+    /** Sets the priority level of the notification. */
     priority?: GoabWorkSideNotificationPriority;
+    /** Sets a data-testid attribute for automated testing. */
     testId?: string;
+    /** Emits when the notification item is clicked. */
     onClick: EventEmitter<void>;
     isReady: boolean;
     ngOnInit(): void;
@@ -1452,10 +1933,15 @@ declare class GoabWorkSideNotificationItem implements OnInit {
 
 declare class GoabWorkSideNotificationPanel implements OnInit {
     private cdr;
+    /** The heading text displayed at the top of the notification panel. */
     heading?: string;
+    /** Sets the initially active tab in the notification panel. */
     activeTab?: GoabWorkSideNotificationActiveTabType;
+    /** Sets a data-testid attribute for automated testing. */
     testId?: string;
+    /** Emits when the user clicks "Mark all as read". */
     onMarkAllRead: EventEmitter<void>;
+    /** Emits when the user clicks "View all". */
     onViewAll: EventEmitter<void>;
     isReady: boolean;
     ngOnInit(): void;