@abgov/react-components 7.0.0-next.1 → 7.1.0

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;

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

@@ -13,8 +13,11 @@ declare module "react" {
     }
 }
 interface GoALinkButtonProps extends Margins, DataAttributes {
+    /** @deprecated Use GoabButton instead. Sets the type of button. */
     type?: GoabLinkButtonType;
+    /** @deprecated Use GoabButton instead. Icon displayed before the button text. */
     leadingIcon?: GoabIconType;
+    /** @deprecated Use GoabButton instead. Icon displayed after the button text. */
     trailingIcon?: GoabIconType;
     children: ReactNode;
 }

package/lib/menu-button/menu-action.d.ts

@@ -14,10 +14,15 @@ declare module "react" {
     }
 }
 export interface GoabMenuActionProps extends DataAttributes {
+    /** @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;
 }
+/** Individual action item within a menu button. */
 export declare function GoabMenuAction(props: GoabMenuActionProps): JSX.Element;
 export default GoabMenuAction;

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

@@ -19,16 +19,27 @@ declare module "react" {
     }
 }
 export interface GoabMenuButtonProps extends DataAttributes {
+    /** The button label text. When provided, displays as a text button with a dropdown icon. */
     text?: string;
+    /** The button style variant. @default "primary" */
     type?: GoabButtonType;
+    /** Sets the size of the button. @default "normal" */
     size?: GoabButtonSize;
+    /** Sets the color variant for semantic meaning. @default "normal" */
     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. @default "Open menu" */
     ariaLabel?: string;
+    /** Sets a data-testid attribute for automated testing. */
     testId?: string;
+    /** Callback fired when a menu action is selected. */
     onAction?: (detail: GoabMenuButtonOnActionDetail) => void;
+    /** Content rendered inside the menu button, typically GoabMenuAction items. */
     children?: ReactNode;
 }
+/** A button with more than one action. */
 export declare function GoabMenuButton({ type, testId, onAction, children, ...rest }: GoabMenuButtonProps): JSX.Element;
 export default GoabMenuButton;

package/lib/microsite-header/microsite-header.d.ts

@@ -19,14 +19,23 @@ interface WCProps {
     testid?: string;
 }
 export interface GoabHeaderProps {
+    /** @required The service type which determines the badge style. "live" shows official government site text, "alpha" and "beta" show development stage badges. */
     type: GoabServiceLevel;
+    /** App or service version displayed on the right side of the header. Accepts a string or custom ReactNode for rich content. */
     version?: string | React.ReactNode;
+    /** URL to a feedback page displayed when provided. */
     feedbackUrl?: string;
+    /** Sets a data-testid attribute for automated testing. */
     testId?: string;
+    /** Maximum width of the content area. @default "100%" */
     maxContentWidth?: string;
+    /** Sets the target attribute for the feedback URL link. @default "blank" */
     feedbackUrlTarget?: GoabLinkTarget;
+    /** Sets the target attribute for the header link. @default "blank" */
     headerUrlTarget?: GoabLinkTarget;
+    /** Callback fired when the feedback link is clicked, enables custom feedback handling. */
     onFeedbackClick?: () => void;
 }
+/** Communicate what stage the service is at, connect to Alberta.ca, and gather feedback on your service. */
 export declare function GoabMicrositeHeader({ type, version, feedbackUrl, maxContentWidth, feedbackUrlTarget, headerUrlTarget, testId, onFeedbackClick, }: GoabHeaderProps): JSX.Element;
 export default GoabMicrositeHeader;

package/lib/modal/modal.d.ts

@@ -24,14 +24,23 @@ declare module "react" {
     }
 }
 export interface GoabModalProps {
+    /** The heading text displayed at the top of the modal. */
     heading?: ReactNode;
+    /** Set the max allowed width of the modal. @default "60ch" */
     maxWidth?: string;
+    /** Content rendered in the modal's actions slot, typically action buttons. */
     actions?: ReactElement<any>;
+    /** Callback fired when the modal is closed. When provided, enables the close button and backdrop click-to-close behavior. */
     onClose?: () => void;
+    /** Sets the animation transition when opening/closing. 'fast' or 'slow' for animated, 'none' for instant. */
     transition?: GoabModalTransition;
+    /** Content rendered inside the modal body. */
     children?: ReactNode;
+    /** Controls if the modal is visible or not. */
     open?: boolean;
+    /** Sets the context and colour of the callout modal. Required when used as a callout type. */
     calloutVariant?: GoabModalCalloutVariant;
+    /** Sets a data-testid attribute for automated testing. */
     testId?: string;
     /**
      * @deprecated The role property is deprecated and will be removed in a future version.
@@ -39,5 +48,6 @@ export interface GoabModalProps {
      */
     role?: GoabModalRole;
 }
+/** An overlay that appears in front of all other content, and requires a user to take an action before continuing. */
 export declare function GoabModal({ heading, children, maxWidth, open, actions, transition, calloutVariant, onClose, testId, }: GoabModalProps): JSX.Element;
 export default GoabModal;

package/lib/notification/notification.d.ts

@@ -17,14 +17,23 @@ declare module "react" {
     }
 }
 export interface GoabNotificationProps {
+    /** Define the context and colour of the notification. */
     type?: GoabNotificationType;
+    /** Indicates how assistive technology should handle updates to the live region. @default "polite" */
     ariaLive?: GoabAriaLiveType;
+    /** Maximum width of the content area. @default "100%" */
     maxContentWidth?: string;
+    /** Sets the visual prominence. 'high' for full background, 'low' for a bordered style. @default "high" */
     emphasis?: GoabNotificationEmphasis;
+    /** When true, reduces padding for a more compact notification. */
     compact?: boolean;
+    /** Content rendered inside the notification. */
     children?: React.ReactNode;
+    /** Callback fired when the notification is dismissed. */
     onDismiss?: () => void;
+    /** Sets a data-testid attribute for automated testing. */
     testId?: string;
 }
+/** Display important page level information or notifications. */
 export declare const GoabNotification: ({ type, emphasis, compact, ariaLive, maxContentWidth, children, testId, onDismiss, }: GoabNotificationProps) => import("react/jsx-runtime").JSX.Element;
 export default GoabNotification;

package/lib/one-column-layout/one-column-layout.d.ts

@@ -7,8 +7,10 @@ declare module "react" {
     }
 }
 export interface GoabPageProps {
+    /** Content rendered inside the one-column layout. */
     children?: ReactNode;
 }
 export type PageProps = GoabPageProps;
+/** Organizes page content in a single responsive column. */
 export declare function GoabOneColumnLayout(props: GoabPageProps): JSX.Element;
 export default GoabOneColumnLayout;

package/lib/page-block/page-block.d.ts

@@ -12,10 +12,14 @@ declare module "react" {
     }
 }
 export interface GoabPageBlockProps {
+    /** Maximum width of the content area. Use "full" for 100% width or a CSS dimension like "1200px". @default "full" */
     width?: GoabPageBlockSize;
+    /** Sets a data-testid attribute for automated testing. */
     testId?: string;
+    /** Content rendered inside the page block. */
     children?: ReactNode;
 }
 export type PageBlockProps = GoabPageBlockProps;
+/** Full-width section with optional background. */
 export declare function GoabPageBlock(props: PageBlockProps): JSX.Element;
 export {};

package/lib/pages/pages.d.ts

@@ -11,8 +11,11 @@ declare module "react" {
     }
 }
 export interface GoabPagesProps extends Margins {
+    /** The currently visible page (1-based index). @default 1 */
     current?: number;
+    /** Page content to show or hide based on the current page index. */
     children?: ReactNode;
 }
+/** Container for paginated content views. */
 export declare function GoabPages(props: GoabPagesProps): JSX.Element;
 export default GoabPages;

package/lib/pagination/pagination.d.ts

@@ -16,13 +16,20 @@ declare module "react" {
     }
 }
 export interface GoabPaginationProps extends Margins {
+    /** @required Total number of data items within all pages. */
     itemCount: number;
-    perPageCount?: number;
+    /** @required The current page being viewed (non-zero based). */
     pageNumber: number;
-    variant?: "all" | "links-only";
+    /** @required Callback fired when the user navigates to a different page. */
     onChange: (detail: GoabPaginationOnChangeDetail) => void;
+    /** Number of data items shown per page. @default 10 */
+    perPageCount?: number;
+    /** Controls which nav controls are visible. @default "all" */
+    variant?: "all" | "links-only";
+    /** Sets a data-testid attribute for automated testing. */
     testId?: string;
 }
 export type PaginationProps = GoabPaginationProps;
+/** Help users navigation between multiple pages or screens as part of a set. */
 export declare function GoabPagination({ onChange, ...props }: GoabPaginationProps): import("react/jsx-runtime").JSX.Element;
 export default GoabPagination;

package/lib/popover/popover.d.ts

@@ -16,17 +16,23 @@ declare module "react" {
     }
 }
 export interface GoabPopoverProps extends Margins, DataAttributes {
-    target?: ReactNode;
+    /** Content rendered inside the popover body. */
+    children: ReactNode;
+    /** @required Sets the element used as the popover trigger. */
+    target: ReactNode;
+    /** Sets a data-testid attribute for automated testing. */
     testId?: string;
+    /** 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. @default "auto" */
     position?: GoabPopoverPosition;
-    children: ReactNode;
-    /***
-     * @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;
 }
+/** A small overlay that opens on demand, used in other components. */
 export declare function GoabPopover({ target, padded, relative, children, ...rest }: GoabPopoverProps): JSX.Element;
 export default GoabPopover;

package/lib/push-drawer/push-drawer.d.ts

@@ -15,13 +15,21 @@ declare module "react" {
     }
 }
 export interface GoabPushDrawerProps {
+    /** @required Content rendered inside the push drawer body. */
+    children: ReactNode;
+    /** @required Callback fired when the push drawer is closed. */
+    onClose: () => void;
+    /** Controls the open/closed state of the push drawer. */
     open?: boolean;
+    /** Sets the heading text or custom heading content. */
     heading?: string | ReactNode;
+    /** Sets the width of the push drawer panel. @default "492px" */
     width?: string;
+    /** Sets a data-testid attribute for automated testing. */
     testId?: string;
+    /** Content rendered in the actions slot, typically action buttons. */
     actions?: ReactNode;
-    children: ReactNode;
-    onClose: () => void;
 }
+/** A panel that pushes the main page content aside on desktop, falling back to an overlay drawer on smaller screens. */
 export declare function GoabPushDrawer({ open, heading, width, testId, actions, children, onClose, }: GoabPushDrawerProps): JSX.Element;
 export default GoabPushDrawer;

package/lib/radio-group/radio-group.d.ts

@@ -23,17 +23,29 @@ declare module "react" {
     }
 }
 export interface GoabRadioGroupProps extends Margins, DataAttributes {
+    /** @required The name for the radio group. Used for accessibility and change events. */
     name: string;
+    /** The currently selected value in the radio group. */
     value?: string;
+    /** The identifier for the radio group element. */
     id?: string;
+    /** Disables all radio items in the group. */
     disabled?: boolean;
+    /** Sets the layout direction. 'vertical' stacks items, 'horizontal' places them in a row. @default "vertical" */
     orientation?: GoabRadioGroupOrientation;
+    /** Sets the size of all radio items. 'compact' reduces spacing for dense layouts. @default "default" */
     size?: GoabRadioGroupSize;
+    /** Sets a data-testid attribute for automated testing. */
     testId?: string;
+    /** Shows an error state on all radio items in the group. */
     error?: boolean;
+    /** Defines how the radio group will be announced by screen readers. */
     ariaLabel?: string;
+    /** Radio items to render inside the group. */
     children?: React.ReactNode;
+    /** Callback fired when the selected radio item changes. */
     onChange?: (detail: GoabRadioGroupOnChangeDetail) => void;
 }
+/** Allow users to select one option from a set. */
 export declare function GoabRadioGroup({ disabled, error, onChange, name, children, size, ...rest }: GoabRadioGroupProps): JSX.Element;
 export default GoabRadioGroup;

package/lib/radio-group/radio.d.ts

@@ -23,19 +23,33 @@ declare module "react" {
     }
 }
 export interface GoabRadioItemProps extends Margins {
+    /** 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 | React.ReactNode;
+    /** Content revealed below the radio option when it is selected. */
     reveal?: React.ReactNode;
+    /** Text announced by screen readers when the reveal content is displayed. */
     revealAriaLabel?: string;
+    /** Sets the maximum width of this radio item. */
     maxWidth?: 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;
+    /** Reduces spacing for dense layouts. */
     compact?: boolean;
+    /** Additional content rendered inside the radio item. */
     children?: React.ReactNode;
+    /** Defines how this option will be announced by screen readers. */
     ariaLabel?: string;
 }
+/** Individual radio option within a group. */
 export declare function GoabRadioItem({ name, label, value, description, reveal, revealAriaLabel, maxWidth, disabled, checked, error, compact, ariaLabel, children, mt, mr, mb, ml, }: GoabRadioItemProps): JSX.Element;
 export default GoabRadioItem;

package/lib/side-menu/side-menu.d.ts

@@ -11,8 +11,11 @@ declare module "react" {
     }
 }
 export interface GoabSideMenuProps {
-    testId?: string;
+    /** @required Navigation links and groups rendered inside the side menu. */
     children: ReactNode;
+    /** Sets a data-testid attribute for automated testing. */
+    testId?: string;
 }
+/** A side navigation that helps the user navigate between pages. */
 export declare function GoabSideMenu({ testId, children }: GoabSideMenuProps): JSX.Element;
 export default GoabSideMenu;

package/lib/side-menu-group/side-menu-group.d.ts

@@ -14,10 +14,15 @@ declare module "react" {
     }
 }
 export interface GoabSideMenuGroupProps extends Margins {
+    /** @required The heading text for the menu group. */
     heading: string;
+    /** Icon displayed alongside the heading. */
     icon?: GoabIconType;
+    /** Sets a data-testid attribute for automated testing. */
     testId?: string;
+    /** Navigation links rendered inside the menu group. */
     children?: ReactNode;
 }
+/** Group of related side menu items. */
 export declare function GoabSideMenuGroup({ heading, icon, testId, children, mt, mr, mb, ml, }: GoabSideMenuGroupProps): JSX.Element;
 export default GoabSideMenuGroup;

package/lib/side-menu-heading/side-menu-heading.d.ts

@@ -13,10 +13,15 @@ declare module "react" {
     }
 }
 export interface GoabSideMenuHeadingProps {
+    /** Icon displayed before the heading text. */
+    icon?: GoabIconType;
+    /** Content rendered in the meta slot, displayed alongside the heading. */
     meta?: ReactNode;
+    /** Sets a data-testid attribute for automated testing. */
     testId?: string;
-    icon?: GoabIconType;
+    /** The heading text or content rendered inside the side menu heading. */
     children?: ReactNode;
 }
-export declare function GoabSideMenuHeading({ meta, testId, icon, children }: GoabSideMenuHeadingProps): import("react/jsx-runtime").JSX.Element;
+/** Section heading in side menu. */
+export declare function GoabSideMenuHeading({ meta, testId, icon, children, }: GoabSideMenuHeadingProps): import("react/jsx-runtime").JSX.Element;
 export default GoabSideMenuHeading;

package/lib/skeleton/skeleton.d.ts

@@ -14,12 +14,18 @@ declare module "react" {
     }
 }
 export interface GoabSkeletonProps extends Margins {
+    /** @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. @default "1" */
     size?: GoabSkeletonSize;
+    /** Used within components that contain multiple lines. Currently only used in card skeleton type. @default 3 */
     lineCount?: number;
-    type: GoabSkeletonType;
+    /** Sets a data-testid attribute for automated testing. */
     testId?: string;
 }
 export type SkeletonProps = GoabSkeletonProps;
+/** Provide visual feedback to users while loading a content heavy page or page element. */
 export declare const GoabSkeleton: ({ maxWidth, size, lineCount, type, testId, mt, mr, mb, ml, }: GoabSkeletonProps) => import("react/jsx-runtime").JSX.Element;
 export default GoabSkeleton;

package/lib/spacer/spacer.d.ts

@@ -12,9 +12,13 @@ declare module "react" {
     }
 }
 export interface GoabSpacerProps {
+    /** Horizontal spacing. @default "none" */
     hSpacing?: GoabSpacerHorizontalSpacing;
+    /** Vertical spacing. @default "none" */
     vSpacing?: GoabSpacerVerticalSpacing;
+    /** Sets a data-testid attribute for automated testing. */
     testId?: string;
 }
+/** Negative area between the components and the interface. */
 export declare function GoabSpacer(props: GoabSpacerProps): import("react/jsx-runtime").JSX.Element;
 export default GoabSpacer;

package/lib/spinner/spinner.d.ts

@@ -15,12 +15,18 @@ declare module "react" {
     }
 }
 export interface GoabSpinnerProps {
+    /** @required Sets the spinner animation type. */
     type: GoabSpinnerType;
+    /** @required Sets the size of the spinner. */
     size: GoabSpinnerSize;
+    /** When true, inverts colors for use on dark backgrounds. */
     invert?: boolean;
+    /** Progress value (0-100). When set to 0 or greater, shows a progress spinner instead of infinite. */
     progress?: number;
+    /** Sets a data-testid attribute for automated testing. */
     testId?: string;
 }
 export type SpinnerProps = GoabSpinnerProps;
+/** Loading indicator for async operations. */
 export declare function GoabSpinner({ type, size, progress, invert, testId, }: GoabSpinnerProps): JSX.Element;
 export default GoabSpinner;

package/lib/tab/tab.d.ts

@@ -12,10 +12,15 @@ declare module "react" {
     }
 }
 export interface GoabTabItemProps {
+    /** The text label for this tab. Can also pass React nodes for custom heading content. */
     heading?: React.ReactNode;
+    /** When true, disables the tab so it cannot be selected. */
     disabled?: boolean;
+    /** Content rendered inside the tab panel. */
     children?: React.ReactNode;
+    /** URL-friendly identifier for the tab, used for hash-based navigation. */
     slug?: string;
 }
-export declare function GoabTab({ heading, disabled, slug, children }: GoabTabItemProps): JSX.Element;
+/** Individual tab within a tabs component. */
+export declare function GoabTab({ heading, disabled, slug, children, }: GoabTabItemProps): JSX.Element;
 export {};

package/lib/table/table-sort-header.d.ts

@@ -13,10 +13,15 @@ declare module "react" {
     }
 }
 export interface GoabTableSortProps extends DataAttributes {
+    /** Column name identifier for sorting. */
     name?: string;
+    /** Sets the sort direction indicator. @default "none" */
     direction?: GoabTableSortDirection;
+    /** Sort order number for multi-column sort display. Used for displaying priority numbers when multiple columns are sorted. */
     sortOrder?: GoabTableSortOrder;
+    /** Content rendered inside the sort header button (typically the column heading text). */
     children?: React.ReactNode;
 }
+/** A set of structured data that is easy for a user to scan, examine, and compare. */
 export declare function GoabTableSortHeader({ name, direction, sortOrder, children, ...rest }: GoabTableSortProps): JSX.Element;
 export default GoabTableSortHeader;

package/lib/table/table.d.ts

@@ -18,15 +18,24 @@ declare module "react" {
     }
 }
 export interface GoabTableProps extends Margins {
+    /** Width of the table. By default it will fit the enclosed content. */
     width?: string;
+    /** Callback fired when a single-column sort header is clicked. */
     onSort?: (detail: GoabTableOnSortDetail) => void;
+    /** Callback fired when multi-column sorting changes. */
     onMultiSort?: (detail: GoabTableOnMultiSortDetail) => void;
+    /** Sort mode: "single" allows one column, "multi" allows up to 2 columns. @default "single" */
     sortMode?: GoabTableSortMode;
+    /** A relaxed variant of the table with more vertical padding for the cells. @default "normal" */
     variant?: GoabTableVariant;
+    /** When true, alternates row background colors for improved readability. */
     striped?: boolean;
+    /** Sets a data-testid attribute for automated testing. */
     testId?: string;
+    /** Content rendered inside the table (table rows, headers, etc.). */
     children?: ReactNode;
 }
 export type TableProps = GoabTableProps;
+/** A set of structured data that is easy for a user to scan, examine, and compare. */
 export declare function GoabTable({ onSort, onMultiSort, sortMode, ...props }: GoabTableProps): import("react/jsx-runtime").JSX.Element;
 export default GoabTable;

package/lib/tabs/tabs.d.ts

@@ -18,14 +18,21 @@ declare module "react" {
     }
 }
 export interface GoabTabsProps {
+    /** The initially active tab (1-based index). If not set, the first tab is active. */
     initialTab?: number;
+    /** Content rendered inside the tabs container, typically GoabTab components. */
     children?: React.ReactNode;
+    /** Sets a data-testid attribute for automated testing. */
     testId?: string;
+    /** Visual style variant. "segmented" shows pill-style tabs with animation. @default "default" */
     variant?: GoabTabsVariant;
-    /** Tab layout orientation. "auto" stacks vertically on mobile (default), "horizontal" keeps horizontal on all screen sizes. */
+    /** Tab layout orientation. "auto" stacks vertically on mobile, "horizontal" keeps horizontal on all screen sizes. @default "auto" */
     orientation?: GoabTabsOrientation;
+    /** Controls URL navigation mode on tab change. @default "hash" */
     navigation?: GoabTabsNavigation;
+    /** Callback fired when the active tab changes. */
     onChange?: (detail: GoabTabsOnChangeDetail) => void;
 }
+/** Let users navigate between related sections of content, displaying one section at a time. */
 export declare function GoabTabs({ initialTab, children, testId, onChange, variant, orientation, navigation, }: GoabTabsProps): JSX.Element;
 export default GoabTabs;

package/lib/temporary-notification-ctrl/temporary-notification-ctrl.d.ts

@@ -16,9 +16,13 @@ declare module "react" {
     }
 }
 export interface GoabTemporaryNotificationCtrlProps {
+    /** 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;
 }
+/** A notification that appears at the bottom of the screen. */
 export declare const GoabTemporaryNotificationCtrl: ({ verticalPosition, horizontalPosition, testId, ...rest }: GoabTemporaryNotificationCtrlProps) => import("react/jsx-runtime").JSX.Element;
 export default GoabTemporaryNotificationCtrl;

package/lib/text/text.d.ts

@@ -15,14 +15,21 @@ declare module "react" {
     }
 }
 interface GoATextProps extends Margins, DataAttributes {
+    /** Content rendered inside the text element. */
+    children: ReactNode;
     /** @deprecated Please use 'tag' property instead */
     as?: GoabTextTextElement | GoabTextHeadingElement;
+    /** 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. @default "65ch" */
     maxWidth?: GoabTextMaxWidth;
+    /** Sets the text colour. @default "primary" */
     color?: GoabTextColor;
+    /** Sets the id attribute on the element. */
     id?: string;
-    children: ReactNode;
 }
+/** Provides consistent sizing, spacing, and colour to written content. */
 export declare function GoabText({ as, tag, children, ...rest }: GoATextProps): JSX.Element;
 export default GoabText;

package/lib/textarea/textarea.d.ts

@@ -28,25 +28,45 @@ declare module "react" {
     }
 }
 export interface GoabTextAreaProps extends Margins, DataAttributes {
+    /** @required Name of the input value that is received in the change event. */
     name: string;
+    /** Bound to the current value of the textarea. */
     value?: string;
+    /** Sets the id attribute on the textarea element. */
     id?: string;
+    /** Text displayed within the textarea when no value is set. */
     placeholder?: string;
+    /** Sets the number of visible text rows. @default 3 */
     rows?: number;
+    /** Sets the input to an error state. */
     error?: boolean;
+    /** Sets the input to a read only state. */
     readOnly?: boolean;
+    /** Sets the input to a disabled state. */
     disabled?: boolean;
+    /** Sets the width of the text area. @default "100%" */
     width?: string;
+    /** Sets the maximum width of the text area. @default "60ch" */
     maxWidth?: string;
+    /** Sets a data-testid attribute for automated testing. */
     testId?: 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. */
     countBy?: GoabTextAreaCountBy;
+    /** Maximum number of characters or words allowed. */
     maxCount?: number;
+    /** Specifies the autocomplete attribute for the textarea input. */
     autoComplete?: string;
+    /** Sets the visual size variant of the text area. */
     size?: GoabTextAreaSize;
+    /** Callback fired when the value of the textarea changes. */
     onChange?: (event: GoabTextAreaOnChangeDetail) => void;
+    /** Callback fired when a key is pressed within the textarea. */
     onKeyPress?: (event: GoabTextAreaOnKeyPressDetail) => void;
+    /** Callback fired when the textarea loses focus. */
     onBlur?: (event: GoabTextAreaOnBlurDetail) => void;
 }
+/** A multi-line field where users can input and edit text. */
 export declare function GoabTextArea({ readOnly, disabled, error, onChange, onKeyPress, onBlur, ...rest }: GoabTextAreaProps): JSX.Element;
 export default GoabTextArea;