@abgov/react-components 6.10.0 → 6.11.0-dev.1

package/experimental/input/input.d.ts

@@ -0,0 +1,124 @@
+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;
+    value?: string;
+    id?: string;
+    autocapitalize?: GoabAutoCapitalize;
+    autocomplete?: string;
+    debounce?: number;
+    placeholder?: string;
+    leadingicon?: string;
+    trailingicon?: string;
+    variant: string;
+    disabled?: string;
+    error?: string;
+    readonly?: string;
+    focused?: string;
+    handletrailingiconclick: string;
+    width?: string;
+    prefix?: string;
+    suffix?: string;
+    arialabel?: string;
+    testid?: string;
+    textalign?: string;
+    size?: GoabInputSize;
+    min?: string | number;
+    max?: string | number;
+    step?: number;
+    maxlength?: number;
+    trailingiconarialabel?: string;
+    version?: string;
+}
+declare module "react" {
+    namespace JSX {
+        interface IntrinsicElements {
+            "goa-input": WCProps & React.HTMLAttributes<HTMLInputElement> & {
+                ref?: React.RefObject<HTMLInputElement | null>;
+            };
+        }
+    }
+}
+interface BaseProps extends Margins, DataAttributes {
+    name: string;
+    id?: string;
+    debounce?: number;
+    disabled?: boolean;
+    autoCapitalize?: GoabAutoCapitalize;
+    autoComplete?: string;
+    placeholder?: string;
+    leadingIcon?: GoabIconType;
+    trailingIcon?: GoabIconType;
+    onTrailingIconClick?: () => void;
+    variant?: "goa" | "bare";
+    focused?: boolean;
+    readonly?: boolean;
+    error?: boolean;
+    width?: string;
+    prefix?: string;
+    suffix?: string;
+    testId?: string;
+    ariaLabel?: string;
+    leadingContent?: React.ReactNode;
+    trailingContent?: React.ReactNode;
+    maxLength?: number;
+    trailingIconAriaLabel?: string;
+    textAlign?: "left" | "right";
+    size?: GoabInputSize;
+    version?: string;
+}
+type OnChange<T = string> = (detail: GoabInputOnChangeDetail<T>) => void;
+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 GoabxInputProps extends BaseProps {
+    onChange?: OnChange<string>;
+    value?: string;
+    min?: number | string;
+    max?: number | string;
+    step?: number;
+    onFocus?: OnFocus<string>;
+    onBlur?: OnBlur<string>;
+    onKeyPress?: OnKeyPress<string>;
+}
+interface GoabxNumberInputProps extends BaseProps {
+    onChange?: OnChange<number>;
+    value?: number;
+    min?: number;
+    max?: number;
+    step?: number;
+    onFocus?: OnFocus<number>;
+    onBlur?: OnBlur<number>;
+    onKeyPress?: OnKeyPress<number>;
+}
+interface GoabxDateInputProps extends BaseProps {
+    onChange?: OnChange<GoabDate>;
+    value?: GoabDate;
+    min?: GoabDate;
+    max?: GoabDate;
+    step?: number;
+    onFocus?: OnFocus<GoabDate>;
+    onBlur?: OnBlur<GoabDate>;
+    onKeyPress?: OnKeyPress<GoabDate>;
+}
+export declare function GoabxInput({ variant, textAlign, size, focused, disabled, readonly, error, leadingContent, trailingContent, onTrailingIconClick, onChange, onFocus, onBlur, onKeyPress, version, ...rest }: GoabxInputProps & {
+    type?: GoabInputType;
+}): JSX.Element;
+export declare function GoabxInputText(props: GoabxInputProps): JSX.Element;
+export declare function GoabxInputPassword(props: GoabxInputProps): JSX.Element;
+export declare function GoabxInputDate({ value, min, max, ...props }: GoabxDateInputProps): JSX.Element;
+export declare function GoabxInputTime({ value, min, max, ...props }: GoabxInputProps): JSX.Element;
+export declare function GoabxInputDateTime({ value, min, max, ...props }: GoabxDateInputProps): JSX.Element;
+export declare function GoabxInputEmail(props: GoabxInputProps): JSX.Element;
+export declare function GoabxInputSearch(props: GoabxInputProps): JSX.Element;
+export declare function GoabxInputUrl(props: GoabxInputProps): JSX.Element;
+export declare function GoabxInputTel(props: GoabxInputProps): JSX.Element;
+export declare function GoabxInputFile(props: GoabxInputProps): JSX.Element;
+export declare function GoabxInputMonth(props: GoabxInputProps): JSX.Element;
+export declare function GoabxInputNumber({ min, max, value, textAlign, ...props }: GoabxNumberInputProps): JSX.Element;
+export declare function GoabxInputRange(props: GoabxInputProps): JSX.Element;
+export default GoabxInput;

package/experimental/link/link.d.ts

@@ -0,0 +1,32 @@
+import { ReactNode } from 'react';
+import { GoabIconType, GoabLinkColor, GoabLinkSize, Margins, DataAttributes } from '@abgov/ui-components-common';
+interface WCProps extends Margins {
+    leadingicon?: GoabIconType;
+    trailingicon?: GoabIconType;
+    action?: string;
+    actionArgs?: string;
+    actionArg?: string;
+    testid?: string;
+    color?: GoabLinkColor;
+    size?: GoabLinkSize;
+}
+declare module "react" {
+    namespace JSX {
+        interface IntrinsicElements {
+            "goa-link": WCProps & React.HTMLAttributes<HTMLElement>;
+        }
+    }
+}
+interface GoabxLinkProps extends Margins, DataAttributes {
+    leadingIcon?: GoabIconType;
+    trailingIcon?: GoabIconType;
+    action?: string;
+    actionArgs?: Record<string, unknown>;
+    actionArg?: string;
+    color?: GoabLinkColor;
+    size?: GoabLinkSize;
+    testId?: string;
+    children: ReactNode;
+}
+export declare function GoabxLink({ actionArgs, actionArg, color, size, children, ...rest }: GoabxLinkProps): import("react/jsx-runtime").JSX.Element;
+export default GoabxLink;

package/experimental/modal/modal.d.ts

@@ -0,0 +1,44 @@
+import { GoabModalCalloutVariant, GoabModalRole, GoabModalTransition } from '@abgov/ui-components-common';
+import { ReactElement, ReactNode, RefObject, JSX } from 'react';
+interface WCProps {
+    ref: RefObject<HTMLElement | null>;
+    heading?: ReactNode;
+    open?: string;
+    maxwidth?: string;
+    closable: string;
+    /**
+     * @deprecated The role property is deprecated and will be removed in a future version.
+     * The modal will always use role="dialog".
+     */
+    role?: GoabModalRole;
+    transition?: GoabModalTransition;
+    calloutvariant?: GoabModalCalloutVariant;
+    testid?: string;
+    version?: string;
+}
+declare module "react" {
+    namespace JSX {
+        interface IntrinsicElements {
+            "goa-modal": WCProps & React.HTMLAttributes<HTMLElement>;
+        }
+    }
+}
+export interface GoabxModalProps {
+    heading?: ReactNode;
+    maxWidth?: string;
+    actions?: ReactElement<any>;
+    onClose?: () => void;
+    transition?: GoabModalTransition;
+    children?: ReactNode;
+    open?: boolean;
+    calloutVariant?: GoabModalCalloutVariant;
+    testId?: string;
+    version?: string;
+    /**
+     * @deprecated The role property is deprecated and will be removed in a future version.
+     * The modal will always use role="dialog".
+     */
+    role?: GoabModalRole;
+}
+export declare function GoabxModal({ heading, children, maxWidth, open, actions, transition, calloutVariant, onClose, testId, version, }: GoabxModalProps): JSX.Element;
+export default GoabxModal;

package/experimental/notification/notification.d.ts

@@ -0,0 +1,31 @@
+import { GoabAriaLiveType, GoabNotificationEmphasis, GoabNotificationType } from '@abgov/ui-components-common';
+interface WCProps {
+    ref: React.RefObject<HTMLElement | null>;
+    type: GoabNotificationType;
+    maxcontentwidth?: string;
+    arialive?: GoabAriaLiveType;
+    testid?: string;
+    emphasis?: GoabNotificationEmphasis;
+    compact?: string;
+    version?: string;
+}
+declare module "react" {
+    namespace JSX {
+        interface IntrinsicElements {
+            "goa-notification": WCProps & React.HTMLAttributes<HTMLButtonElement>;
+        }
+    }
+}
+export interface GoabxNotificationProps {
+    type?: GoabNotificationType;
+    ariaLive?: GoabAriaLiveType;
+    maxContentWidth?: string;
+    emphasis?: GoabNotificationEmphasis;
+    compact?: boolean;
+    children?: React.ReactNode;
+    onDismiss?: () => void;
+    testId?: string;
+    version?: string;
+}
+export declare const GoabxNotification: ({ type, emphasis, compact, ariaLive, maxContentWidth, children, testId, onDismiss, version, }: GoabxNotificationProps) => import("react/jsx-runtime").JSX.Element;
+export default GoabxNotification;

package/experimental/pagination/pagination.d.ts

@@ -0,0 +1,29 @@
+import { GoabPaginationOnChangeDetail, Margins } from '@abgov/ui-components-common';
+interface WCProps extends Margins {
+    ref?: React.RefObject<HTMLElement | null>;
+    itemcount: number;
+    perpagecount?: number;
+    pagenumber: number;
+    variant?: "all" | "links-only";
+    testid?: string;
+    version?: string;
+}
+declare module "react" {
+    namespace JSX {
+        interface IntrinsicElements {
+            "goa-pagination": WCProps & React.HTMLAttributes<HTMLElement>;
+        }
+    }
+}
+export interface GoabxPaginationProps extends Margins {
+    itemCount: number;
+    perPageCount?: number;
+    pageNumber: number;
+    variant?: "all" | "links-only";
+    onChange: (detail: GoabPaginationOnChangeDetail) => void;
+    testId?: string;
+    version?: string;
+}
+export type PaginationProps = GoabxPaginationProps;
+export declare function GoabxPagination({ onChange, version, ...props }: GoabxPaginationProps): import("react/jsx-runtime").JSX.Element;
+export default GoabxPagination;

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

@@ -0,0 +1,40 @@
+import { JSX } from 'react';
+import { GoabRadioGroupOnChangeDetail, GoabRadioGroupOrientation, GoabRadioGroupSize, Margins, DataAttributes } from '@abgov/ui-components-common';
+export * from './radio';
+interface WCProps extends Margins {
+    name: string;
+    value?: string;
+    id?: string;
+    orientation?: GoabRadioGroupOrientation;
+    disabled?: string;
+    error?: string;
+    arialabel?: string;
+    testid?: string;
+    size?: GoabRadioGroupSize;
+    version?: string;
+}
+declare module "react" {
+    namespace JSX {
+        interface IntrinsicElements {
+            "goa-radio-group": WCProps & React.HTMLAttributes<HTMLElement> & {
+                ref: React.RefObject<HTMLElement | null>;
+            };
+        }
+    }
+}
+export interface GoabxRadioGroupProps extends Margins, DataAttributes {
+    name: string;
+    value?: string;
+    id?: string;
+    disabled?: boolean;
+    orientation?: GoabRadioGroupOrientation;
+    size?: GoabRadioGroupSize;
+    testId?: string;
+    error?: boolean;
+    ariaLabel?: string;
+    children?: React.ReactNode;
+    version?: string;
+    onChange?: (detail: GoabRadioGroupOnChangeDetail) => void;
+}
+export declare function GoabxRadioGroup({ disabled, error, onChange, name, children, size, version, ...rest }: GoabxRadioGroupProps): JSX.Element;
+export default GoabxRadioGroup;

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

@@ -0,0 +1,42 @@
+import { Margins } from '@abgov/ui-components-common';
+import { JSX } from 'react';
+interface WCProps extends Margins {
+    name?: string;
+    value?: string;
+    description?: string | React.ReactNode;
+    reveal?: React.ReactNode;
+    revealarialabel?: string;
+    label?: string;
+    maxwidth?: string;
+    disabled?: string;
+    checked?: string;
+    error?: string;
+    arialabel?: string;
+    compact?: string;
+    version?: string;
+}
+declare module "react" {
+    namespace JSX {
+        interface IntrinsicElements {
+            "goa-radio-item": WCProps & React.HTMLAttributes<HTMLElement>;
+        }
+    }
+}
+export interface GoabxRadioItemProps extends Margins {
+    value?: string;
+    label?: string;
+    name?: string;
+    description?: string | React.ReactNode;
+    reveal?: React.ReactNode;
+    revealAriaLabel?: string;
+    maxWidth?: string;
+    disabled?: boolean;
+    checked?: boolean;
+    error?: boolean;
+    compact?: boolean;
+    children?: React.ReactNode;
+    ariaLabel?: string;
+    version?: string;
+}
+export declare function GoabxRadioItem({ name, label, value, description, reveal, revealAriaLabel, maxWidth, disabled, checked, error, compact, ariaLabel, children, version, mt, mr, mb, ml, }: GoabxRadioItemProps): JSX.Element;
+export default GoabxRadioItem;

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

@@ -0,0 +1,19 @@
+import { ReactNode, JSX } from 'react';
+interface WCProps {
+    testid?: string;
+    version?: string;
+}
+declare module "react" {
+    namespace JSX {
+        interface IntrinsicElements {
+            "goa-side-menu": WCProps & React.HTMLAttributes<HTMLElement>;
+        }
+    }
+}
+export interface GoabxSideMenuProps {
+    testId?: string;
+    children: ReactNode;
+    version?: string;
+}
+export declare function GoabxSideMenu({ testId, children, version, }: GoabxSideMenuProps): JSX.Element;
+export default GoabxSideMenu;

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

@@ -0,0 +1,24 @@
+import { ReactNode, JSX } from 'react';
+import { GoabIconType, Margins } from '@abgov/ui-components-common';
+interface WCProps extends Margins {
+    heading: string;
+    icon?: GoabIconType;
+    testid?: string;
+    version?: string;
+}
+declare module "react" {
+    namespace JSX {
+        interface IntrinsicElements {
+            "goa-side-menu-group": WCProps & React.HTMLAttributes<HTMLElement>;
+        }
+    }
+}
+export interface GoabxSideMenuGroupProps extends Margins {
+    heading: string;
+    icon?: GoabIconType;
+    testId?: string;
+    children?: ReactNode;
+    version?: string;
+}
+export declare function GoabxSideMenuGroup({ heading, icon, testId, children, mt, mr, mb, ml, version, }: GoabxSideMenuGroupProps): JSX.Element;
+export default GoabxSideMenuGroup;

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

@@ -0,0 +1,23 @@
+import { GoabIconType } from '@abgov/ui-components-common';
+import { ReactNode } from 'react';
+interface WCProps {
+    testid?: string;
+    icon?: GoabIconType;
+    version?: string;
+}
+declare module "react" {
+    namespace JSX {
+        interface IntrinsicElements {
+            "goa-side-menu-heading": WCProps & React.HTMLAttributes<HTMLElement>;
+        }
+    }
+}
+export interface GoabxSideMenuHeadingProps {
+    meta?: ReactNode;
+    testId?: string;
+    icon?: GoabIconType;
+    children?: ReactNode;
+    version?: string;
+}
+export declare function GoabxSideMenuHeading({ meta, testId, icon, children, version, }: GoabxSideMenuHeadingProps): import("react/jsx-runtime").JSX.Element;
+export default GoabxSideMenuHeading;

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

@@ -0,0 +1,20 @@
+import { DataAttributes, GoabTableSortDirection } from '@abgov/ui-components-common';
+import { JSX } from 'react';
+interface WCProps {
+    name?: string;
+    direction?: GoabTableSortDirection;
+}
+declare module "react" {
+    namespace JSX {
+        interface IntrinsicElements {
+            "goa-table-sort-header": WCProps & React.HTMLAttributes<HTMLElement>;
+        }
+    }
+}
+export interface GoabxTableSortProps extends DataAttributes {
+    name?: string;
+    direction?: GoabTableSortDirection;
+    children?: React.ReactNode;
+}
+export declare function GoabxTableSortHeader({ children, ...rest }: GoabxTableSortProps): JSX.Element;
+export default GoabxTableSortHeader;

package/experimental/table/table.d.ts

@@ -0,0 +1,30 @@
+import { GoabTableOnSortDetail, GoabTableVariant, Margins } from '@abgov/ui-components-common';
+import { ReactNode } from 'react';
+interface WCProps extends Margins {
+    ref?: React.RefObject<HTMLElement | null>;
+    width?: string;
+    stickyheader?: string;
+    variant?: GoabTableVariant;
+    testid?: string;
+    striped?: string;
+    version?: string;
+}
+declare module "react" {
+    namespace JSX {
+        interface IntrinsicElements {
+            "goa-table": WCProps & React.HTMLAttributes<HTMLElement>;
+        }
+    }
+}
+export interface GoabxTableProps extends Margins {
+    width?: string;
+    onSort?: (detail: GoabTableOnSortDetail) => void;
+    variant?: GoabTableVariant;
+    striped?: boolean;
+    testId?: string;
+    version?: string;
+    children?: ReactNode;
+}
+export type TableProps = GoabxTableProps;
+export declare function GoabxTable({ onSort, version, ...props }: GoabxTableProps): import("react/jsx-runtime").JSX.Element;
+export default GoabxTable;

package/experimental/tabs/tabs.d.ts

@@ -0,0 +1,27 @@
+import { default as React, JSX } from 'react';
+import { GoabTabsOnChangeDetail, GoabTabsVariant } from '@abgov/ui-components-common';
+interface WCProps {
+    initialtab?: number;
+    ref: React.RefObject<HTMLElement | null>;
+    onChange?: (tab: number) => void;
+    testid?: string;
+    variant?: GoabTabsVariant;
+    version?: string;
+}
+declare module "react" {
+    namespace JSX {
+        interface IntrinsicElements {
+            "goa-tabs": WCProps & React.HTMLAttributes<HTMLElement>;
+        }
+    }
+}
+export interface GoabxTabsProps {
+    initialTab?: number;
+    children?: React.ReactNode;
+    testId?: string;
+    variant?: GoabTabsVariant;
+    onChange?: (detail: GoabTabsOnChangeDetail) => void;
+    version?: string;
+}
+export declare function GoabxTabs({ initialTab, children, testId, onChange, variant, version, }: GoabxTabsProps): JSX.Element;
+export default GoabxTabs;

package/experimental/textarea/textarea.d.ts

@@ -0,0 +1,53 @@
+import { GoabTextAreaCountBy, GoabTextAreaOnChangeDetail, GoabTextAreaOnKeyPressDetail, GoabTextAreaOnBlurDetail, GoabTextAreaSize, Margins, DataAttributes } from '@abgov/ui-components-common';
+import { JSX } from 'react';
+interface WCProps extends Margins {
+    name: string;
+    value?: string;
+    placeholder?: string;
+    rows?: number;
+    error?: string;
+    readOnly?: string;
+    disabled?: string;
+    width?: string;
+    maxwidth?: string;
+    arialabel?: string;
+    countby?: GoabTextAreaCountBy;
+    maxcount?: number;
+    autocomplete?: string;
+    testid?: string;
+    size?: GoabTextAreaSize;
+    version?: string;
+}
+declare module "react" {
+    namespace JSX {
+        interface IntrinsicElements {
+            "goa-textarea": WCProps & React.HTMLAttributes<HTMLElement> & {
+                ref: React.Ref<HTMLTextAreaElement>;
+            };
+        }
+    }
+}
+export interface GoabxTextAreaProps extends Margins, DataAttributes {
+    name: string;
+    value?: string;
+    id?: string;
+    placeholder?: string;
+    rows?: number;
+    error?: boolean;
+    readOnly?: boolean;
+    disabled?: boolean;
+    width?: string;
+    maxWidth?: string;
+    testId?: string;
+    ariaLabel?: string;
+    countBy?: GoabTextAreaCountBy;
+    maxCount?: number;
+    autoComplete?: string;
+    size?: GoabTextAreaSize;
+    version?: string;
+    onChange?: (event: GoabTextAreaOnChangeDetail) => void;
+    onKeyPress?: (event: GoabTextAreaOnKeyPressDetail) => void;
+    onBlur?: (event: GoabTextAreaOnBlurDetail) => void;
+}
+export declare function GoabxTextArea({ readOnly, disabled, error, onChange, onKeyPress, onBlur, version, ...rest }: GoabxTextAreaProps): JSX.Element;
+export default GoabxTextArea;

package/experimental/work-side-menu-group/work-side-menu-group.d.ts

@@ -0,0 +1,22 @@
+import { JSX } from 'react';
+import { GoabIconType } from '@abgov/ui-components-common';
+interface WCProps {
+    heading: string;
+    icon: GoabIconType;
+    testid?: string;
+}
+declare module "react" {
+    namespace JSX {
+        interface IntrinsicElements {
+            "goa-work-side-menu-group": WCProps & React.HTMLAttributes<HTMLElement>;
+        }
+    }
+}
+export interface GoabWorkSideMenuGroupProps {
+    heading: string;
+    icon: GoabIconType;
+    testId?: string;
+    children?: React.ReactNode;
+}
+export declare function GoabxWorkSideMenuGroup(props: GoabWorkSideMenuGroupProps): JSX.Element;
+export default GoabxWorkSideMenuGroup;