@abgov/react-components 7.0.0-dev.2 → 7.0.0-dev.4

package/lib/file-upload-card/file-upload-card.d.ts

@@ -18,14 +18,23 @@ declare module "react" {
     }
 }
 export interface GoabFileUploadCardProps extends DataAttributes {
+    /** @required The name of the uploaded file to display. */
     filename: string;
+    /** @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. @default -1 */
     progress?: number;
+    /** Sets a data-testid attribute for automated testing. */
     testId?: string;
+    /** Error message to display. When set, the card shows an error state with a cancel button. */
     error?: string;
+    /** Callback fired when the user clicks the remove button on an uploaded file. */
     onDelete?: (detail: GoabFileUploadOnDeleteDetail) => void;
+    /** Callback fired when the user clicks the cancel button during file upload. */
     onCancel?: (detail: GoabFileUploadOnCancelDetail) => void;
 }
+/** Display uploaded file with actions. */
 export declare function GoabFileUploadCard({ onDelete, onCancel, filename, ...rest }: GoabFileUploadCardProps): import("react/jsx-runtime").JSX.Element;
 export default GoabFileUploadCard;

package/lib/file-upload-input/file-upload-input.d.ts

@@ -16,11 +16,17 @@ declare module "react" {
     }
 }
 export interface GoabFileUploadInputProps extends DataAttributes {
+    /** @required Callback fired when a valid file is selected or dropped. */
+    onSelectFile: (detail: GoabFileUploadInputOnSelectFileDetail) => void;
+    /** The input display variant. "dragdrop" shows a drag-and-drop area, "button" shows a simple button. @default "dragdrop" */
     variant?: GoabFileUploadInputVariant;
+    /** Accepted file types as a comma-separated list of MIME types or file extensions (e.g., "image/*,.pdf"). */
     accept?: string;
+    /** Maximum file size with unit (e.g., "5MB", "100KB", "1GB"). Files exceeding this will be rejected. @default "5MB" */
     maxFileSize?: string;
+    /** Sets a data-testid attribute for automated testing. */
     testId?: string;
-    onSelectFile: (detail: GoabFileUploadInputOnSelectFileDetail) => void;
 }
+/** Help users select and upload a file. */
 export declare function GoabFileUploadInput({ onSelectFile, ...rest }: GoabFileUploadInputProps): import("react/jsx-runtime").JSX.Element;
 export default GoabFileUploadInput;

package/lib/filter-chip/filter-chip.d.ts

@@ -18,13 +18,21 @@ declare module "react" {
     }
 }
 export interface GoabFilterChipProps extends Margins, DataAttributes {
-    onClick?: () => void;
+    /** @required Text label of the chip. */
+    content: string;
+    /** Theme style of the leading icon. @default "outline" */
     iconTheme?: GoabFilterChipTheme;
+    /** Shows an error state. */
     error?: boolean;
-    content: string;
+    /** Secondary text displayed in a smaller size before the main content. */
     secondaryText?: string;
+    /** Icon displayed at the start of the chip. */
     leadingIcon?: GoabIconType;
+    /** Sets a data-testid attribute for automated testing. */
     testId?: string;
+    /** Callback fired when the filter chip is clicked to remove it. */
+    onClick?: () => void;
 }
+/** Allow the user to enter information, filter content, and make selections. */
 export declare const GoabFilterChip: ({ iconTheme, error, onClick, ...rest }: GoabFilterChipProps) => import("react/jsx-runtime").JSX.Element;
 export default GoabFilterChip;

package/lib/footer/footer.d.ts

@@ -14,10 +14,15 @@ declare module "react" {
     }
 }
 export interface GoabAppFooterProps extends DataAttributes {
+    /** The maximum width of the main content area. */
     maxContentWidth?: string;
-    children?: ReactNode;
-    testId?: string;
+    /** URL for the Government of Alberta logo link. Set to empty string to disable the link. @default "https://alberta.ca" */
     url?: string;
+    /** Sets a data-testid attribute for automated testing. */
+    testId?: string;
+    /** Content rendered inside the footer, typically navigation and meta sections. */
+    children?: ReactNode;
 }
+/** Provides information related your service at the bottom of every page. */
 export declare function GoabAppFooter({ children, ...rest }: GoabAppFooterProps): JSX.Element;
 export default GoabAppFooter;

package/lib/footer-meta-section/footer-meta-section.d.ts

@@ -11,8 +11,11 @@ declare module "react" {
     }
 }
 export interface GoabAppFooterMetaSectionProps extends DataAttributes {
+    /** Sets a data-testid attribute for automated testing. */
     testId?: string;
+    /** Anchor link elements rendered as footer meta navigation links. */
     children?: ReactNode;
 }
+/** Copyright and legal links in footer. */
 export declare function GoabAppFooterMetaSection({ children, ...rest }: GoabAppFooterMetaSectionProps): import("react/jsx-runtime").JSX.Element;
 export default GoabAppFooterMetaSection;

package/lib/footer-nav-section/footer-nav-section.d.ts

@@ -13,10 +13,15 @@ declare module "react" {
     }
 }
 export interface GoabFooterNavSectionProps extends DataAttributes {
-    maxColumnCount?: number;
+    /** 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;
+    /** Sets a data-testid attribute for automated testing. */
     testId?: string;
+    /** Anchor link elements rendered as footer navigation links. */
     children?: ReactNode;
 }
+/** Navigation links section in footer. */
 export declare function GoabAppFooterNavSection({ children, ...rest }: GoabFooterNavSectionProps): import("react/jsx-runtime").JSX.Element;
 export default GoabAppFooterNavSection;

package/lib/form/fieldset.d.ts

@@ -15,11 +15,17 @@ declare module "react" {
     }
 }
 interface GoabFieldsetProps extends DataAttributes {
+    /** Content rendered inside the fieldset. */
+    children: ReactNode;
+    /** Sets the unique identifier for the fieldset. */
     id?: string;
+    /** Sets the section title of the fieldset. */
     sectionTitle?: string;
+    /** Sets when form field changes are dispatched to the form. @default "continue" */
     dispatchOn?: GoabFormDispatchOn;
+    /** Callback fired when the fieldset continue action is triggered. */
     onContinue?: (event: GoabFieldsetOnContinueDetail) => void;
-    children: ReactNode;
 }
+/** Container for form inputs and validation. */
 export declare function GoabFieldset({ onContinue, children, ...rest }: GoabFieldsetProps): JSX.Element;
 export default GoabFieldset;

package/lib/form/public-form-page.d.ts

@@ -21,21 +21,29 @@ declare module "react" {
     }
 }
 interface GoabPublicFormPageProps extends Margins, DataAttributes {
+    /** Content rendered inside the form page. */
+    children: ReactNode;
+    /** Sets the unique identifier for the form page. */
     id?: string;
+    /** Sets the heading text displayed at the top of the form page. */
     heading?: string;
+    /** Sets the subheading text displayed below the main heading. */
     subHeading?: string;
+    /** Sets the heading text used when this page appears in the form summary. */
     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. @default "step" */
     type?: GoabPublicFormPageStep;
+    /** Sets the text label for the continue or confirm button. */
     buttonText?: string;
+    /** Sets the visibility of the continue button. @default "visible" */
     buttonVisibility?: GoabPublicFormPageButtonVisibility;
-    /**
-     * Triggered when the form page continues to the next step
-     * @param event - The continue event details
-     */
+    /** Callback fired when the form page continues to the next step. */
     onContinue?: (event: Event) => void;
-    children: ReactNode;
 }
+/** Container for form inputs and validation. */
 export declare function GoabPublicFormPage({ onContinue, children, ...rest }: GoabPublicFormPageProps): import("react/jsx-runtime").JSX.Element;
 export default GoabPublicFormPage;

package/lib/form/public-form-summary.d.ts

@@ -10,7 +10,9 @@ declare module "react" {
     }
 }
 interface GoabPublicFormSummaryProps extends DataAttributes {
+    /** Sets the heading text displayed above the form summary content. */
     heading?: string;
 }
+/** Container for form inputs and validation. */
 export declare function GoabPublicFormSummary({ heading, ...rest }: GoabPublicFormSummaryProps): import("react/jsx-runtime").JSX.Element;
 export default GoabPublicFormSummary;

package/lib/form/public-form.d.ts

@@ -14,12 +14,19 @@ declare module "react" {
     }
 }
 interface GoabPublicFormProps extends DataAttributes {
+    /** Content rendered inside the public form. */
+    children: ReactNode;
+    /** 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;
+    /** Callback fired when the form is initialized. */
     onInit?: (event: Event) => void;
+    /** Callback fired when the form is completed. */
     onComplete?: (event: GoabFormState) => void;
+    /** Callback fired when the form state changes. */
     onStateChange?: (event: GoabFormState) => void;
-    children: ReactNode;
 }
+/** Container for form inputs and validation. */
 export declare function GoabPublicForm({ onInit, onComplete, onStateChange, children, ...rest }: GoabPublicFormProps): import("react/jsx-runtime").JSX.Element;
 export default GoabPublicForm;

package/lib/form/public-subform-index.d.ts

@@ -14,11 +14,17 @@ declare module "react" {
     }
 }
 interface GoabPublicSubformIndexProps extends Margins, DataAttributes {
+    /** Content rendered inside the subform index. */
+    children: ReactNode;
+    /** Sets the heading text displayed at the top of the subform index page. */
     heading?: string;
+    /** Sets the section title displayed above the heading. */
     sectionTitle?: string;
+    /** Sets the text label for the action button that adds a new subform entry. */
     actionButtonText?: string;
+    /** Sets the visibility of the action button. @default "hidden" */
     buttonVisibility?: "visible" | "hidden";
-    children: ReactNode;
 }
+/** Container for form inputs and validation. */
 export declare function GoabPublicSubformIndex({ heading, sectionTitle, actionButtonText, buttonVisibility, children, ...rest }: GoabPublicSubformIndexProps): import("react/jsx-runtime").JSX.Element;
 export default GoabPublicSubformIndex;

package/lib/form/public-subform.d.ts

@@ -15,12 +15,19 @@ declare module "react" {
     }
 }
 interface GoabPublicSubformProps extends Margins, DataAttributes {
+    /** Content rendered inside the subform. */
+    children: ReactNode;
+    /** Sets the unique identifier for the subform. */
     id?: string;
+    /** Sets the name identifier for the subform. */
     name?: string;
+    /** Sets the message displayed on the continue button. */
     continueMsg?: string;
+    /** Callback fired when the subform is initialized. */
     onInit?: (event: Event) => void;
+    /** Callback fired when the subform state changes. */
     onStateChange?: (event: Event) => void;
-    children: ReactNode;
 }
+/** Container for form inputs and validation. */
 export declare function GoabPublicSubform({ id, name, continueMsg, onInit, onStateChange, children, ...rest }: GoabPublicSubformProps): import("react/jsx-runtime").JSX.Element;
 export default GoabPublicSubform;

package/lib/form/task-list.d.ts

@@ -11,8 +11,11 @@ declare module "react" {
     }
 }
 interface GoabPublicFormTaskListProps extends Margins, DataAttributes {
-    heading?: string;
+    /** Content rendered inside the task list, typically GoabPublicFormTask items. */
     children: ReactNode;
+    /** Sets the heading text displayed above the task list. */
+    heading?: string;
 }
+/** Container for form inputs and validation. */
 export declare function GoabPublicFormTaskList({ children, ...rest }: GoabPublicFormTaskListProps): import("react/jsx-runtime").JSX.Element;
 export default GoabPublicFormTaskList;

package/lib/form/task.d.ts

@@ -11,8 +11,11 @@ declare module "react" {
     }
 }
 interface GoabPublicFormTaskProps extends DataAttributes {
-    status?: GoabPublicFormTaskStatus;
+    /** Content rendered inside the task item, typically the task name or description. */
     children: ReactNode;
+    /** Sets the status of the task, which determines the badge displayed. @default "cannot-start" */
+    status?: GoabPublicFormTaskStatus;
 }
+/** Container for form inputs and validation. */
 export declare function GoabPublicFormTask({ status, children, ...rest }: GoabPublicFormTaskProps): import("react/jsx-runtime").JSX.Element;
 export default GoabPublicFormTask;

package/lib/form-item/form-item.d.ts

@@ -22,24 +22,31 @@ declare module "react" {
     }
 }
 export interface GoabFormItemProps extends Margins, DataAttributes {
+    /** Creates a label for the form item. */
     label?: string;
+    /** Sets the label size. 'regular' for standard, 'large' for emphasis. @default "regular" */
     labelSize?: GoabFormItemLabelSize;
+    /** Marks the field with an optional or required label indicator. */
     requirement?: GoabFormItemRequirement;
+    /** Error text displayed under the form field. Leave blank to indicate a valid field. Accepts a string or ReactNode for custom error content. */
     error?: string | React.ReactNode;
+    /** Help text displayed under the form field to provide additional explanation. Accepts a string or ReactNode for custom help content. */
     helpText?: string | React.ReactNode;
+    /** Sets the maximum width of the form item. @default "none" */
     maxWidth?: 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;
+    /** Content rendered inside the form item, typically an input component. */
     children?: React.ReactNode;
+    /** Sets a data-testid attribute for automated testing. */
     testId?: string;
+    /** Sets the id attribute on the form item element. */
     id?: string;
 }
+/** Wraps an input control with a text label, requirement label, helper text, and error text. */
 export declare function GoabFormItem({ error, helpText, publicFormSummaryOrder, children, type, ...rest }: GoabFormItemProps): JSX.Element;
 export default GoabFormItem;

package/lib/form-step/form-step.d.ts

@@ -11,8 +11,11 @@ declare module "react" {
     }
 }
 export interface GoabFormStepProps {
+    /** @required The step label text displayed to users. */
     text: string;
+    /** The completion status of the step. Affects visual styling and icons. */
     status?: GoabFormStepStatus;
 }
+/** Individual step in a multi-step form. */
 export declare function GoabFormStep(props: GoabFormStepProps): import("react/jsx-runtime").JSX.Element;
 export default GoabFormStep;

package/lib/form-stepper/form-stepper.d.ts

@@ -13,10 +13,15 @@ declare module "react" {
     }
 }
 export interface GoabFormStepperProps extends Margins {
+    /** The current step state value (1-based index). Leaving it blank (-1) will allow any step to be accessed. */
     step?: number;
+    /** Sets a data-testid attribute for automated testing. */
     testId?: string;
+    /** Content rendered inside the form stepper, typically GoabFormStep components. */
     children?: ReactNode;
+    /** Callback fired when the active step changes. */
     onChange?: (detail: GoabFormStepperOnChangeDetail) => void;
 }
+/** Provides a visual representation of a form through a series of steps. */
 export declare function GoabFormStepper({ testId, step, mt, mb, ml, mr, onChange, children, }: GoabFormStepperProps): import("react/jsx-runtime").JSX.Element;
 export default GoabFormStepper;

package/lib/grid/grid.d.ts

@@ -13,10 +13,15 @@ declare module "react" {
     }
 }
 export interface GoabGridProps extends Margins {
-    gap?: Spacing;
+    /** @required Minimum width of the child elements. */
     minChildWidth: string;
+    /** Gap between child items. @default "m" */
+    gap?: Spacing;
+    /** Sets a data-testid attribute for automated testing. */
     testId?: string;
+    /** Content rendered inside the grid layout. */
     children?: React.ReactNode;
 }
+/** Arrange a number of components into a responsive grid pattern. */
 export declare function GoabGrid({ gap, minChildWidth, mt, mr, mb, ml, testId, children, }: GoabGridProps): JSX.Element;
 export default GoabGrid;

package/lib/hero-banner/hero-banner-actions.d.ts

@@ -1,6 +1,8 @@
 import { JSX } from 'react';
 export type GoabHeroBannerActionsType = {
+    /** Content rendered inside the hero banner actions slot, typically buttons or links. */
     children?: React.ReactNode;
 };
+/** Displays action content in the hero banner actions area. */
 export declare function GoabHeroBannerActions({ children, }: GoabHeroBannerActionsType): JSX.Element;
 export default GoabHeroBannerActions;

package/lib/hero-banner/hero-banner.d.ts

@@ -16,14 +16,23 @@ declare module "react" {
     }
 }
 export interface GoabHeroBannerProps {
+    /** @required 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;
+    /** Content rendered inside the hero banner body. */
     children?: React.ReactNode;
+    /** Maximum width of the content area. @default "100%" */
     maxContentWidth?: string;
+    /** Hero Banner background color when no background image is provided. @default "#f8f8f8" */
     backgroundColor?: string;
+    /** Text color within the hero banner. */
     textColor?: string;
 }
+/** A visual band of text, including an image and a call to action. */
 export declare function GoabHeroBanner({ heading, backgroundUrl, minHeight, maxContentWidth, backgroundColor, textColor, children, testId, }: GoabHeroBannerProps): JSX.Element;
 export default GoabHeroBanner;

package/lib/icon/icon.d.ts

@@ -10,14 +10,23 @@ declare module "react" {
     }
 }
 export interface GoabIconProps extends Margins, DataAttributes {
+    /** @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. @default "outline" */
     theme?: GoabIconTheme;
+    /** When true, inverts the icon colors for use on dark backgrounds. */
     inverted?: string | 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). @default 1 */
     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;
+    /** Sets a data-testid attribute for automated testing. */
     testId?: string;
 }
 interface WCProps extends Margins {
@@ -31,5 +40,6 @@ interface WCProps extends Margins {
     arialabel?: string;
     testid?: string;
 }
+/** A simple and universal graphic symbol representing an action, object, or concept to help guide the user. */
 export declare function GoabIcon({ inverted, ...rest }: GoabIconProps): JSX.Element;
 export {};

package/lib/icon-button/icon-button.d.ts

@@ -22,18 +22,31 @@ declare module "react" {
     }
 }
 export interface GoabIconButtonProps extends Margins, DataAttributes {
+    /** @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. @default "color" */
     variant?: GoabIconButtonVariant;
+    /** Sets the title of the button. */
     title?: string;
+    /** Disables the button. */
     disabled?: boolean;
+    /** Callback fired when the icon button is clicked. */
     onClick?: () => void;
+    /** Sets a data-testid attribute for automated testing. */
     testId?: string;
+    /** Sets the aria-label of the button. */
     ariaLabel?: string;
+    /** Action identifier passed in click events for event delegation patterns. */
     action?: string;
+    /** Multiple argument values passed with the action in click events. */
     actionArgs?: Record<string, unknown>;
+    /** Single argument value passed with the action in click events. */
     actionArg?: string;
+    /** Content rendered inside the icon button. */
     children?: ReactNode;
 }
+/** A compact button with an icon and no text. */
 export declare function GoabIconButton({ variant, size, disabled, onClick, actionArgs, actionArg, children, ...rest }: GoabIconButtonProps): JSX.Element;
 export {};

package/lib/input/input.d.ts

@@ -1,8 +1,5 @@
 import { JSX } from 'react';
 import { GoabAutoCapitalize, GoabDate, GoabIconType, GoabInputOnBlurDetail, GoabInputOnChangeDetail, GoabInputOnFocusDetail, GoabInputOnKeyPressDetail, GoabInputSize, GoabInputType, Margins, DataAttributes } from '@abgov/ui-components-common';
-export interface IgnoreMe {
-    ignore: string;
-}
 interface WCProps extends Margins {
     type?: GoabInputType;
     name: string;
@@ -44,30 +41,55 @@ declare module "react" {
     }
 }
 interface BaseProps extends Margins, DataAttributes {
+    /** Name of input value that is received in event detail payloads. */
     name: string;
+    /** Sets the id attribute of the input element. */
     id?: string;
+    /** Debounce delay in milliseconds before firing the change event. 0 means no debounce. */
     debounce?: number;
+    /** Sets the input disabled state. */
     disabled?: boolean;
+    /** Controls automatic capitalization behavior on supported mobile browsers. */
     autoCapitalize?: GoabAutoCapitalize;
+    /** Sets the autocomplete attribute for the input element. */
     autoComplete?: string;
+    /** Sets placeholder text when the input is empty. */
     placeholder?: string;
+    /** Sets the icon shown before the value. */
     leadingIcon?: GoabIconType;
+    /** Sets the icon shown after the value. */
     trailingIcon?: GoabIconType;
+    /** Callback fired when the trailing icon is clicked. */
     onTrailingIconClick?: () => void;
+    /** Sets the visual style variant. @default "goa" */
     variant?: "goa" | "bare";
+    /** Sets focus on initial render or controlled updates. */
     focused?: boolean;
+    /** Sets the readonly state. */
     readonly?: boolean;
+    /** Sets the error state styling. */
     error?: boolean;
+    /** Sets the width of the input field. */
     width?: string;
+    /** @deprecated Use leadingContent instead. */
     prefix?: string;
+    /** @deprecated Use trailingContent instead. */
     suffix?: string;
+    /** Sets a data-testid attribute for automated testing. */
     testId?: string;
+    /** Sets the aria-label used by assistive technologies. */
     ariaLabel?: string;
+    /** Sets content in the leading slot. */
     leadingContent?: React.ReactNode;
+    /** Sets content in the trailing slot. */
     trailingContent?: React.ReactNode;
+    /** Sets the maximum number of characters. */
     maxLength?: number;
+    /** Sets the aria-label for an interactive trailing icon. */
     trailingIconAriaLabel?: string;
+    /** Sets text alignment. @default "left" */
     textAlign?: "left" | "right";
+    /** Sets the input size. @default "default" */
     size?: GoabInputSize;
 }
 type OnChange<T = string> = (detail: GoabInputOnChangeDetail<T>) => void;
@@ -75,13 +97,21 @@ type OnFocus<T = string> = (detail: GoabInputOnFocusDetail<T>) => void;
 type OnBlur<T = string> = (detail: GoabInputOnBlurDetail<T>) => void;
 type OnKeyPress<T = string> = (detail: GoabInputOnKeyPressDetail<T>) => void;
 export interface GoabInputProps extends BaseProps {
+    /** Callback fired when the input value changes. Receives GoabInputOnChangeDetail. */
     onChange?: OnChange<string>;
+    /** Bound to the current value of the input field. */
     value?: string;
+    /** Minimum value. Supports any number, or ISO 8601 format for date/datetime types. */
     min?: number | string;
+    /** Maximum value. Supports any number, or ISO 8601 format for date/datetime types. */
     max?: number | string;
+    /** How much a number or date value should change by. @default 1 */
     step?: number;
+    /** Callback fired when the input receives focus. Receives GoabInputOnFocusDetail. */
     onFocus?: OnFocus<string>;
+    /** Callback fired when the input loses focus. Receives GoabInputOnBlurDetail. */
     onBlur?: OnBlur<string>;
+    /** Callback fired when a key is pressed in the input. Receives GoabInputOnKeyPressDetail. */
     onKeyPress?: OnKeyPress<string>;
 }
 interface GoabNumberInputProps extends BaseProps {
@@ -104,20 +134,34 @@ interface GoabDateInputProps extends BaseProps {
     onBlur?: OnBlur<GoabDate>;
     onKeyPress?: OnKeyPress<GoabDate>;
 }
+/** A single-line field where users can input and edit text. */
 export declare function GoabInput({ variant, textAlign, size, focused, disabled, readonly, error, leadingContent, trailingContent, onTrailingIconClick, onChange, onFocus, onBlur, onKeyPress, ...rest }: GoabInputProps & {
     type?: GoabInputType;
 }): JSX.Element;
+/** A single-line field where users can input and edit text. */
 export declare function GoabInputText(props: GoabInputProps): JSX.Element;
+/** A single-line field where users can enter masked password text. */
 export declare function GoabInputPassword(props: GoabInputProps): JSX.Element;
+/** A single-line field where users can enter or select a date. */
 export declare function GoabInputDate({ value, min, max, ...props }: GoabDateInputProps): JSX.Element;
+/** A single-line field where users can enter or select a time. */
 export declare function GoabInputTime({ value, min, max, ...props }: GoabInputProps): JSX.Element;
+/** A single-line field where users can enter a date and time. */
 export declare function GoabInputDateTime({ value, min, max, ...props }: GoabDateInputProps): JSX.Element;
+/** A single-line field where users can enter an email address. */
 export declare function GoabInputEmail(props: GoabInputProps): JSX.Element;
+/** A single-line field where users can enter search terms. */
 export declare function GoabInputSearch(props: GoabInputProps): JSX.Element;
+/** A single-line field where users can enter a URL. */
 export declare function GoabInputUrl(props: GoabInputProps): JSX.Element;
+/** A single-line field where users can enter a phone number. */
 export declare function GoabInputTel(props: GoabInputProps): JSX.Element;
+/** A control that allows users to select a file for upload. */
 export declare function GoabInputFile(props: GoabInputProps): JSX.Element;
+/** A single-line field where users can enter or select a month. */
 export declare function GoabInputMonth(props: GoabInputProps): JSX.Element;
+/** A single-line field where users can input and edit numeric values. */
 export declare function GoabInputNumber({ min, max, value, textAlign, ...props }: GoabNumberInputProps): JSX.Element;
+/** A range input where users can choose a numeric value within minimum and maximum limits. */
 export declare function GoabInputRange(props: GoabInputProps): JSX.Element;
 export default GoabInput;

package/lib/linear-progress/linear-progress.d.ts

@@ -13,11 +13,17 @@ declare module "react" {
     }
 }
 export interface GoabLinearProgressProps {
+    /** Progress value (0-100). When undefined, shows an indeterminate loading animation. */
     progress?: number | null;
+    /** Controls visibility of the percentage text. @default "visible" */
     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;
 }
+/** Provide visual feedback to users while loading. */
 export declare const GoabLinearProgress: ({ progress, percentVisibility, ariaLabel, ariaLabelledBy, testId, }: GoabLinearProgressProps) => import("react/jsx-runtime").JSX.Element;
 export default GoabLinearProgress;

package/lib/link/link.d.ts

@@ -18,15 +18,25 @@ declare module "react" {
     }
 }
 export interface GoabLinkProps extends Margins, DataAttributes {
+    /** @required Content rendered inside the link. */
+    children: ReactNode;
+    /** Icon displayed before the link text. */
     leadingIcon?: GoabIconType;
+    /** Icon displayed after the link text. */
     trailingIcon?: GoabIconType;
+    /** Custom action event name to dispatch when the link is clicked. */
     action?: string;
+    /** Object of arguments to pass with the action event. */
     actionArgs?: Record<string, unknown>;
+    /** Single argument to pass with the action event. Deprecated, use actionArgs instead. */
     actionArg?: 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;
+    /** Sets a data-testid attribute for automated testing. */
     testId?: string;
-    children: ReactNode;
 }
+/** Wraps an anchor element to add icons or margins. */
 export declare function GoabLink({ actionArgs, actionArg, color, size, children, ...rest }: GoabLinkProps): import("react/jsx-runtime").JSX.Element;
 export default GoabLink;