@abgov/react-components 6.11.0 → 7.0.0-dev.10

package/lib/date-picker/date-picker.d.ts

@@ -1,20 +1,51 @@
 import { JSX } from 'react';
 import { GoabDatePickerInputType, GoabDatePickerOnChangeDetail, Margins, DataAttributes } from '@abgov/ui-components-common';
+interface WCProps extends Margins {
+    name?: string;
+    value?: string;
+    error?: string;
+    min?: string;
+    max?: string;
+    type?: string;
+    relative?: string;
+    disabled?: string;
+    testid?: string;
+    width?: string;
+    version?: string;
+}
+declare module "react" {
+    namespace JSX {
+        interface IntrinsicElements {
+            "goa-date-picker": WCProps & React.HTMLAttributes<HTMLElement> & {
+                ref: React.RefObject<HTMLElement | null>;
+            };
+        }
+    }
+}
 export interface GoabDatePickerProps extends Margins, DataAttributes {
+    /** Sets the date picker type. 'calendar' shows a calendar popup, 'input' shows just a date input. @default "calendar" */
+    type?: GoabDatePickerInputType;
+    /** Name of the date field. */
     name?: string;
+    /** Value of the calendar date, as a Date object or an ISO date string (yyyy-mm-dd). */
     value?: Date | string | undefined;
+    /** Sets the input to an error state. */
     error?: boolean;
+    /** Minimum date value allowed. */
     min?: Date | string;
+    /** Maximum date value allowed. */
     max?: Date | string;
-    type?: GoabDatePickerInputType;
+    /** Sets a data-testid attribute for automated testing. */
     testId?: string;
-    /***
-     * @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;
+    /** Disables the date picker. */
     disabled?: boolean;
+    /** Sets the width of the date picker input. */
     width?: string;
+    /** Callback fired when the selected date changes. */
     onChange?: (detail: GoabDatePickerOnChangeDetail) => void;
 }
+/** Lets users select a date through a calendar without the need to manually type it in a field. */
 export declare function GoabDatePicker({ value, error, min, max, disabled, relative, onChange, ...rest }: GoabDatePickerProps): JSX.Element;
 export default GoabDatePicker;

package/lib/details/details.d.ts

@@ -14,11 +14,17 @@ declare module "react" {
     }
 }
 export interface GoabDetailsProps extends Margins, DataAttributes {
+    /** @required The title heading. */
     heading: string;
+    /** @required Content rendered inside the details body. */
+    children: ReactNode;
+    /** Controls if details is expanded or not. */
     open?: boolean;
+    /** Sets the maximum width of the details. @default "75ch" */
     maxWidth?: string;
+    /** Sets a data-testid attribute for automated testing. */
     testId?: string;
-    children: ReactNode;
 }
+/** Let users reveal more detailed information when they need it. */
 export declare function GoabDetails({ open, children, ...rest }: GoabDetailsProps): import("react/jsx-runtime").JSX.Element;
 export default GoabDetails;

package/lib/divider/divider.d.ts

@@ -10,7 +10,9 @@ declare module "react" {
     }
 }
 export interface GoabDividerProps extends Margins {
+    /** Sets a data-testid attribute for automated testing. */
     testId?: string;
 }
+/** Indicate a separation of layout, or to distinguish large chunks of information on a page. */
 export declare function GoabDivider(props: GoabDividerProps): import("react/jsx-runtime").JSX.Element;
 export default GoabDivider;

package/lib/drawer/drawer.d.ts

@@ -1,14 +1,39 @@
 import { ReactNode, JSX } from 'react';
 import { GoabDrawerPosition, GoabDrawerSize } from '@abgov/ui-components-common';
+interface WCProps {
+    position: GoabDrawerPosition;
+    open?: boolean;
+    heading?: string;
+    maxsize?: GoabDrawerSize;
+    testid?: string;
+    ref: React.RefObject<HTMLElement | null>;
+    version?: string;
+}
+declare module "react" {
+    namespace JSX {
+        interface IntrinsicElements {
+            "goa-drawer": WCProps & React.HTMLAttributes<HTMLElement>;
+        }
+    }
+}
 export interface GoabDrawerProps {
+    /** @required The position of the drawer. */
     position: GoabDrawerPosition;
+    /** @required Content rendered inside the drawer body. */
+    children: ReactNode;
+    /** @required Callback fired when the drawer requests to be closed. */
+    onClose: () => void;
+    /** Whether the drawer is open. */
     open?: boolean;
+    /** The heading text displayed at the top of the drawer. Accepts a string or a ReactNode for custom heading content. */
     heading?: string | ReactNode;
+    /** 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;
+    /** Action elements rendered in the drawer footer slot. */
     actions?: ReactNode;
-    children: ReactNode;
-    onClose: () => void;
 }
+/** A panel that slides in from the side of the screen to display additional content or actions without navigating away from the current view. */
 export declare function GoabDrawer({ position, open, heading, maxSize, testId, actions, children, onClose, }: GoabDrawerProps): JSX.Element;
 export default GoabDrawer;

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

@@ -1,11 +1,34 @@
 import { GoabDropdownItemMountType } from '@abgov/ui-components-common';
+interface WCProps {
+    value: string;
+    label?: string;
+    filter?: string;
+    mount?: GoabDropdownItemMountType;
+    name?: string;
+}
+declare module "react" {
+    namespace JSX {
+        interface IntrinsicElements {
+            "goa-dropdown-item": WCProps & React.HTMLAttributes<HTMLElement>;
+        }
+    }
+}
 export interface GoabDropdownItemProps {
+    /** @required The value submitted when this item is selected. */
     value: string;
+    /** Display label for the dropdown item. */
     label?: string;
+    /** Text used to filter and match this item in typeahead search. */
     filter?: string;
+    /** Sets a data-testid attribute for automated testing. */
     testId?: string;
+    /** Controls how the item is registered with the parent dropdown. */
     mountType?: GoabDropdownItemMountType;
+    /** @deprecated */
     name?: string;
 }
+/** Present a list of options to the user to select from. */
 export declare function GoabDropdownOption(props: GoabDropdownItemProps): import("react/jsx-runtime").JSX.Element;
+/** Present a list of options to the user to select from. */
 export declare function GoabDropdownItem({ value, label, filter, name, mountType, }: GoabDropdownItemProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/lib/dropdown/dropdown.d.ts

@@ -1,29 +1,80 @@
-import { GoabDropdownOnChangeDetail, GoabIconType, Margins, DataAttributes } from '@abgov/ui-components-common';
+import { GoabDropdownOnChangeDetail, GoabDropdownSize, GoabIconType, Margins, DataAttributes } from '@abgov/ui-components-common';
 import { JSX } from 'react';
+interface WCProps extends Margins {
+    arialabel?: string;
+    arialabelledby?: string;
+    disabled?: string;
+    error?: string;
+    filterable?: string;
+    leadingicon?: string;
+    maxheight?: string;
+    multiselect?: string;
+    name?: string;
+    native?: string;
+    placeholder?: string;
+    value?: string;
+    width?: string;
+    maxwidth?: string;
+    relative?: string;
+    id?: string;
+    autocomplete?: string;
+    testid?: string;
+    size?: GoabDropdownSize;
+    version?: string;
+}
+declare module "react" {
+    namespace JSX {
+        interface IntrinsicElements {
+            "goa-dropdown": WCProps & React.HTMLAttributes<HTMLElement> & {
+                ref: React.RefObject<HTMLElement | null>;
+            };
+        }
+    }
+}
 export interface GoabDropdownProps extends Margins, DataAttributes {
+    /** Identifier for the dropdown. Should be unique. */
     name?: string;
+    /** The currently selected value(s) of the dropdown. */
     value?: string[] | string;
+    /** Callback fired when the selected value changes. */
     onChange?: (detail: GoabDropdownOnChangeDetail) => void;
+    /** 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 that labels the dropdown. Normally it is the id of the label. */
     ariaLabelledBy?: string;
+    /** The id attribute for the dropdown element. */
     id?: string;
+    /** Dropdown items rendered inside the dropdown. */
     children?: React.ReactNode;
+    /** Disables the dropdown control. */
     disabled?: boolean;
+    /** Shows an error state on the dropdown. */
     error?: boolean;
+    /** When true, allows filtering 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. @default "276px" */
     maxHeight?: string;
+    /** When true, allows multiple items to be selected. */
     multiselect?: boolean;
+    /** When true, renders the native select HTML element. */
     native?: boolean;
+    /** The text displayed in the dropdown before a selection is made. Non-native only. */
     placeholder?: string;
+    /** Sets a data-testid attribute for automated testing. */
     testId?: 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;
-    /***
-     * @deprecated This property has no effect and will be removed in a future version
-     */
+    /** Sets the size of the dropdown. Compact reduces height for dense layouts. */
+    size?: GoabDropdownSize;
+    /** @deprecated This property has no effect and will be removed in a future version. */
     relative?: boolean;
 }
-export declare function GoabDropdown({ value, onChange, disabled, error, filterable, multiselect, native, relative, children, ...rest }: GoabDropdownProps): JSX.Element;
+/** Present a list of options to the user to select from. */
+export declare function GoabDropdown({ value, onChange, disabled, error, filterable, multiselect, native, relative, children, size, ...rest }: GoabDropdownProps): JSX.Element;
 export default GoabDropdown;

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

@@ -1,13 +1,40 @@
 import { DataAttributes, GoabFileUploadOnCancelDetail, GoabFileUploadOnDeleteDetail } from '@abgov/ui-components-common';
+interface WCProps {
+    filename: string;
+    size: number;
+    type?: string;
+    progress?: number;
+    error?: string;
+    testid?: string;
+    version?: string;
+}
+declare module "react" {
+    namespace JSX {
+        interface IntrinsicElements {
+            "goa-file-upload-card": WCProps & React.HTMLAttributes<HTMLElement> & {
+                ref: React.RefObject<HTMLElement | null>;
+            };
+        }
+    }
+}
 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

@@ -1,10 +1,32 @@
 import { DataAttributes, GoabFileUploadInputOnSelectFileDetail, GoabFileUploadInputVariant } from '@abgov/ui-components-common';
+interface WCProps {
+    variant?: GoabFileUploadInputVariant;
+    accept?: string;
+    maxfilesize?: string;
+    testid?: string;
+    version?: string;
+}
+declare module "react" {
+    namespace JSX {
+        interface IntrinsicElements {
+            "goa-file-upload-input": WCProps & React.HTMLAttributes<HTMLElement> & {
+                ref: React.RefObject<HTMLElement | null>;
+            };
+        }
+    }
+}
 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

@@ -1,10 +1,38 @@
-import { DataAttributes, GoabFilterChipTheme, Margins } from '@abgov/ui-components-common';
+import { DataAttributes, GoabFilterChipTheme, GoabIconType, Margins } from '@abgov/ui-components-common';
+interface WCProps extends Margins {
+    icontheme: GoabFilterChipTheme;
+    error?: string;
+    content: string;
+    secondarytext?: string;
+    leadingicon?: GoabIconType;
+    testid?: string;
+    version?: string;
+}
+declare module "react" {
+    namespace JSX {
+        interface IntrinsicElements {
+            "goa-filter-chip": WCProps & React.HTMLAttributes<HTMLElement> & {
+                ref: React.RefObject<HTMLElement | null>;
+            };
+        }
+    }
+}
 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

@@ -1,11 +1,28 @@
 import { ReactNode, JSX } from 'react';
 import { DataAttributes } from '@abgov/ui-components-common';
+interface WCProps {
+    maxcontentwidth?: string;
+    testid?: string;
+    url?: string;
+    version?: string;
+}
+declare module "react" {
+    namespace JSX {
+        interface IntrinsicElements {
+            "goa-app-footer": WCProps & React.HTMLAttributes<HTMLElement>;
+        }
+    }
+}
 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;
 }
-export type FooterProps = GoabAppFooterProps;
+/** 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

@@ -1,8 +1,21 @@
 import { ReactNode } from 'react';
 import { DataAttributes } from '@abgov/ui-components-common';
+interface WCProps {
+    testid?: string;
+}
+declare module "react" {
+    namespace JSX {
+        interface IntrinsicElements {
+            "goa-app-footer-meta-section": WCProps & React.HTMLAttributes<HTMLElement>;
+        }
+    }
+}
 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

@@ -1,10 +1,27 @@
 import { ReactNode } from 'react';
 import { DataAttributes } from '@abgov/ui-components-common';
+interface WCProps {
+    maxcolumncount?: number;
+    heading?: string;
+    testid?: string;
+}
+declare module "react" {
+    namespace JSX {
+        interface IntrinsicElements {
+            "goa-app-footer-nav-section": WCProps & React.HTMLAttributes<HTMLElement>;
+        }
+    }
+}
 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;