@iress-oss/ids-components 5.20.2 → 5.20.3

package/dist/src/components/Table/Table.types.d.ts

@@ -0,0 +1,208 @@
+import { PropsWithChildren, ReactNode, default as React } from 'react';
+import { IressHTMLAttributes, WithDataAttributes } from '../../interfaces';
+import { Cell, Column, ColumnSort, Row, SortDirection, SortingFnOption, Table } from '@tanstack/react-table';
+import { AriaRelationshipProps } from '../../hooks/useAriaRelationship';
+export interface IressTableCommonProps<TRow extends object = never, TVal = never> {
+    /**
+     * Caption that describes the data in the table, required for accessibility.
+     */
+    caption: ReactNode;
+    /**
+     * Multiple table elements can be passed as children.
+     * Used to create a static table, or add a `<tfoot />` element to a `rows` based table.
+     */
+    children?: ReactNode;
+    /**
+     * A mapping of columns to be displayed in the table.
+     * If not provided, it will be automatically regenerated from the row data.
+     */
+    columns?: Record<string, TableColumnNoKey<TRow, TVal> | undefined> | TableColumn<TRow, TVal>[];
+    /**
+     * Content to be show when there is no rowData (columns must also be provided).
+     */
+    empty?: ReactNode;
+    /**
+     * When set to true, the table caption will be visually hidden.
+     */
+    hiddenCaption?: boolean;
+    /**
+     * When set to true, the table header (`<thead></thead>`) will be not be rendered.
+     * Only use with very simple tables.
+     */
+    hiddenHeader?: boolean;
+    /**
+     * Add additional props to the row element.
+     * Can be a props map or a function that returns an props map. The function is called with the row data.
+     */
+    rowProps?: IressHTMLAttributes<HTMLTableRowElement> | ((row: Row<TRow>) => IressHTMLAttributes<HTMLTableRowElement>);
+    /**
+     * Each object in the array contains the data for a row.
+     * @default []
+     */
+    rows?: TRow[];
+    /**
+     * Defaults to 'row' - the first cell in the row is a `<th>`, otherwise it's a `<td>`.
+     * @default 'row'
+     */
+    scope?: TableScope | TableScopes;
+}
+export interface IressTableProps<TRow extends object = never, TVal = never> extends IressHTMLAttributes<HTMLTableElement>, IressTableCommonProps<TRow, TVal> {
+    /**
+     * Compact view of the table, used for tables with a lot of data.
+     */
+    compact?: boolean;
+    /**
+     * When set to true, hovering over a row will trigger a UI change.
+     */
+    hover?: boolean;
+}
+export interface TableColumn<TRow extends object, TVal = never> {
+    /**
+     * Aligns the content of the cell.
+     * @default left
+     */
+    align?: TableColumnAligns;
+    /**
+     * The currency code to prefix to the value if `format` is set to currency.
+     * @default $
+     */
+    currencyCode?: string;
+    /**
+     * When set to true, a divider will be rendered after the column.
+     */
+    divider?: boolean;
+    /**
+     * Formats the cell content.
+     * To use the in-built formatters, set this to: string, number, date, currency, percent.
+     * Use a custom formatter by passing a function that returns a ReactNode.
+     */
+    format?: TableCellFormats | ((value: TVal, row?: TRow) => ReactNode);
+    /**
+     * The unique key for the column.
+     */
+    key: string;
+    /**
+     * The label for the column header.
+     */
+    label?: ReactNode;
+    /**
+     * Whether the column should wrap text or not. May need to be false if the column heading is long.
+     * @default true
+     */
+    noWrap?: boolean;
+    /**
+     * When set to true, the column will be sortable.
+     * Setting it to either `asc` or `desc` will set the initial sort order.
+     */
+    sort?: boolean | SortDirection;
+    /**
+     * The sorting function to use when sorting the column.
+     * If not provided, the default sorting function will be used based on the original row data.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#sortingfn)
+     + @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting)
+     */
+    sortFn?: SortingFnOption<TRow>;
+    /**
+     * Text to be read by a screen reader when a column is sortable (but not currently sorted).
+     * @default sortable
+     */
+    sortableText?: string;
+    /**
+     * The width of the column.
+     */
+    width?: string;
+}
+export type TableColumnNoKey<TRow extends object, TVal = unknown> = Omit<TableColumn<TRow, TVal>, 'key'>;
+export interface IressTableProviderProps<TRow extends object, TVal = unknown> extends PropsWithChildren {
+    columns?: IressTableProps<TRow, TVal>['columns'];
+    rows: TRow[];
+}
+export interface TableContextValue<TRow extends object, TVal = unknown> {
+    api: Table<TRow>;
+    getColumnByKey: (key: string) => TableColumnNoKey<TRow, TVal> | undefined;
+}
+export interface TableHeaderProps extends Partial<Pick<AriaRelationshipProps, 'setControlViaRef'>> {
+    additionalHeaders?: string;
+    className?: string;
+    tableId: string;
+    testId?: string;
+}
+export interface TableHeaderCellProps extends PropsWithChildren, WithDataAttributes {
+    additionalHeaders?: string;
+    columnApi: Pick<Column<object, unknown>, 'getCanSort' | 'toggleSorting' | 'id'>;
+    tableId: string;
+}
+export interface TableRowsProps<TRow extends object = never> extends Partial<Pick<AriaRelationshipProps, 'setControlViaRef'>> {
+    additionalHeaders?: string;
+    hiddenHeader?: boolean;
+    scope?: TableScopes;
+    rowProps?: IressTableProps<TRow>['rowProps'];
+    tableId: string;
+    testId?: string;
+}
+export interface TableBodyCellProps<TRow extends object = never> extends PropsWithChildren, WithDataAttributes {
+    additionalHeaders?: string;
+    cellApi: Pick<Cell<TRow, unknown>, 'column' | 'row' | 'id'>;
+    hiddenHeader?: boolean;
+    index: number;
+    scope?: TableScopes;
+    tableId: string;
+}
+export interface TableSortButtonProps extends PropsWithChildren {
+    label?: string;
+    noWrap?: boolean;
+    sort?: ColumnSort;
+    toggleSorting: () => void;
+}
+export interface TableColumnHookProps {
+    columnApi?: Pick<Column<object, unknown>, 'getCanSort' | 'toggleSorting'>;
+    columnKey: string;
+}
+export interface TableColumnSortHook {
+    buttonProps: TableSortButtonProps;
+    columnProps: {
+        'aria-sort'?: 'none' | 'ascending' | 'descending';
+    };
+}
+export interface TableColumnStylesHook {
+    className: string;
+    style: React.CSSProperties;
+}
+export interface TableRef<TRow extends object> {
+    api: Table<TRow>;
+}
+export interface TableExports {
+    /**
+     * Allows you to access the table context within a child of the `IressTable`.
+     */
+    useTable: <TRow extends object, TVal = never>() => TableContextValue<TRow, TVal>;
+}
+export interface TableEnums {
+    /** @deprecated IressTable.Scope enum is now deprecated and will be removed in a future version. Please use the value directly instead. **/
+    Scope: typeof TableScope;
+}
+/** @deprecated IressTable.Scope enum is now deprecated and will be removed in a future version. Please use the value directly instead. **/
+export declare enum TableScope {
+    Row = "row",
+    Col = "col"
+}
+export declare const TABLE_SCOPES: readonly ["row", "col"];
+export type TableScopes = (typeof TABLE_SCOPES)[number];
+/** @deprecated TableColumnAlign enum is now deprecated and will be removed in a future version. Please use the value directly instead. **/
+export declare enum TableColumnAlign {
+    Left = "left",
+    Right = "right",
+    Center = "center"
+}
+export declare const TABLE_COLUMN_ALIGN: readonly ["left", "right", "center"];
+export type TableColumnAligns = (typeof TABLE_COLUMN_ALIGN)[number];
+/** @deprecated TableCellFormat enum is now deprecated and will be removed in a future version. Please use the value directly instead. **/
+export declare enum TableCellFormat {
+    String = "string",
+    Number = "number",
+    Date = "date",
+    Currency = "currency",
+    Percent = "percent"
+}
+export declare const TABLE_CELL_FORMATS: readonly ["string", "number", "date", "shortDate", "isoDateTime", "relativeTime", "currency", "percent"];
+export type TableCellFormats = (typeof TABLE_CELL_FORMATS)[number];

package/dist/src/components/Table/TableBody/TableBody.d.ts

@@ -0,0 +1,2 @@
+import { IressTableBodyProps } from './TableBody.types';
+export declare const IressTableBody: <TRow extends object = never, TVal = never>({ caption, children, columns, className, "data-testid": dataTestId, empty, hiddenCaption, hiddenHeader, onOpened, onClosed, open, rowProps, rows, scope, ...restProps }: IressTableBodyProps<TRow, TVal>) => import("react/jsx-runtime").JSX.Element | null;

package/dist/src/components/Table/TableBody/TableBody.types.d.ts

@@ -0,0 +1,29 @@
+import { ReactNode } from 'react';
+import { IressTableCommonProps } from '../Table.types';
+import { IressHTMLAttributes } from '../../../interfaces';
+export interface IressTableBodyProps<TRow extends object = never, TVal = never> extends IressHTMLAttributes<HTMLTableSectionElement>, IressTableCommonProps<TRow, TVal> {
+    /**
+     * Caption that describes the data in the inner table, required for accessibility.
+     * Used to open/close the inner table.
+     *
+     * **Note:** Do not include interactive elements inside the caption.
+     */
+    caption: ReactNode;
+    /**
+     * When set to true, the table caption will be visually hidden.
+     * If set, the inner table will always be open.
+     */
+    hiddenCaption?: boolean;
+    /**
+     * Is called when table is opened.
+     */
+    onOpened?: () => void;
+    /**
+     * Is called when table is closed.
+     */
+    onClosed?: () => void;
+    /**
+     * When true, all rows will be visible, otherwise they are hidden.
+     */
+    open?: boolean;
+}

package/dist/src/components/Table/TableContext.d.ts

@@ -0,0 +1,2 @@
+import { TableContextValue } from './Table.types';
+export declare function getTableContext<TRow extends object, TVal = unknown>(): React.Context<TableContextValue<TRow, TVal>>;

package/dist/src/components/Table/TableFormattedValue/TableFormattedValue.d.ts

@@ -0,0 +1,2 @@
+import { IressTableFormattedValueProps } from './TableFormattedValue.types';
+export declare const IressTableFormattedValue: <TRow extends object, TVal = unknown>({ currencyCode, currencyFormatOptions, format, row, value, }: IressTableFormattedValueProps<TRow, TVal>) => string | number | boolean | import('react').ReactElement<any, string | import('react').JSXElementConstructor<any>> | Iterable<import('react').ReactNode> | TVal | null | undefined;

package/dist/src/components/Table/TableFormattedValue/TableFormattedValue.types.d.ts

@@ -0,0 +1,30 @@
+import { ReactNode } from 'react';
+import { TableCellFormats } from '../Table.types';
+import { CurrencyFormatterProps } from '../../../helpers/formatting/formatCurrency';
+export interface IressTableFormattedValueProps<TRow extends object, TVal = unknown> {
+    /**
+     * The currency code to prefix to the value if `format` is set to currency.
+     * @default $
+     * @deprecated Use the `currencyFormatOptions` prop instead.
+     */
+    currencyCode?: string;
+    /**
+     * The currency code to prefix to the value if `format` is set to currency.
+     * @default { locale: 'en-AU', currencyCode: 'AUD' }
+     */
+    currencyFormatOptions?: Omit<CurrencyFormatterProps, 'value'>;
+    /**
+     * Formats the cell content.
+     * To use the in-built formatters, set this to: string, number, date, currency, percent.
+     * Use a custom formatter by passing a function that returns a ReactNode.
+     */
+    format?: TableCellFormats | ((value: TVal, row?: TRow) => ReactNode);
+    /**
+     * The row data.
+     */
+    row?: TRow;
+    /**
+     * The value to format.
+     */
+    value: TVal;
+}

package/dist/src/components/Table/TableProvider.d.ts

@@ -0,0 +1,5 @@
+import { ReactElement, Ref } from 'react';
+import { IressTableProviderProps, TableRef } from './Table.types';
+export declare const IressTableProvider: <TRow extends object = never, TVal = never>(props: IressTableProviderProps<TRow, TVal> & {
+    ref?: Ref<TableRef<TRow>>;
+}) => ReactElement;

package/dist/src/components/Table/components/TableBodyCell.d.ts

@@ -0,0 +1,2 @@
+import { TableBodyCellProps } from '../Table.types';
+export declare const TableBodyCell: <TRow extends object = never>({ additionalHeaders, cellApi, children, hiddenHeader, index, scope, tableId, ...restProps }: TableBodyCellProps<TRow>) => import("react/jsx-runtime").JSX.Element;

package/dist/src/components/Table/components/TableEmpty.d.ts

@@ -0,0 +1,2 @@
+import { PropsWithChildren } from 'react';
+export declare const TableEmpty: ({ children }: PropsWithChildren) => import("react/jsx-runtime").JSX.Element | null;

package/dist/src/components/Table/components/TableHeader.d.ts

@@ -0,0 +1,2 @@
+import { TableHeaderProps } from '../Table.types';
+export declare const TableHeader: ({ additionalHeaders, className, setControlViaRef, tableId, testId, }: TableHeaderProps) => import("react/jsx-runtime").JSX.Element[] | null;

package/dist/src/components/Table/components/TableHeaderCell.d.ts

@@ -0,0 +1,2 @@
+import { TableHeaderCellProps } from '../Table.types';
+export declare const TableHeaderCell: ({ additionalHeaders, children, columnApi, tableId, ...restProps }: TableHeaderCellProps) => import("react/jsx-runtime").JSX.Element;

package/dist/src/components/Table/components/TableRows.d.ts

@@ -0,0 +1,2 @@
+import { TableRowsProps } from '../Table.types';
+export declare const TableRows: <TRow extends object = never>({ additionalHeaders, hiddenHeader, rowProps, setControlViaRef, scope, tableId, testId, }: TableRowsProps<TRow>) => import("react/jsx-runtime").JSX.Element[] | null;

package/dist/src/components/Table/components/TableSortButton.d.ts

@@ -0,0 +1,2 @@
+import { TableSortButtonProps } from '../Table.types';
+export declare const TableSortButton: ({ children, label, noWrap, sort, toggleSorting, }: TableSortButtonProps) => import("react/jsx-runtime").JSX.Element;

package/dist/src/components/Table/helpers/composeIDSTableColumnDefs.d.ts

@@ -0,0 +1,2 @@
+import { IressTableProps } from '../Table.types';
+export declare const composeIDSTableColumnDefs: <TRow extends object, TVal = never>(rows: TRow[], columns?: IressTableProps<TRow, TVal>["columns"]) => import('@tanstack/table-core').AccessorFnColumnDef<TRow, TRow[keyof TRow]>[];

package/dist/src/components/Table/helpers/composeIDSTableInitialSorting.d.ts

@@ -0,0 +1,3 @@
+import { ColumnSort } from '@tanstack/react-table';
+import { IressTableProps } from '../Table.types';
+export declare const composeIDSTableInitialSorting: <TRow extends object, TVal = unknown>(columns?: IressTableProps<TRow, TVal>["columns"]) => ColumnSort[];

package/dist/src/components/Table/helpers/findColumnByKey.d.ts

@@ -0,0 +1,2 @@
+import { IressTableProps } from '../Table.types';
+export declare const findColumnByKey: <TRow extends object, TVal = unknown>(key: string, columns?: IressTableProps<TRow, TVal>["columns"]) => import('..').TableColumnNoKey<TRow, TVal> | undefined;

package/dist/src/components/Table/helpers/getFormatFromValue.d.ts

@@ -0,0 +1,2 @@
+import { TableCellFormats } from '../Table.types';
+export declare const getFormatFromValue: (value: unknown) => TableCellFormats | undefined;

package/dist/src/components/Table/helpers/hasColumns.d.ts

@@ -0,0 +1,2 @@
+import { IressTableProps } from '../Table.types';
+export declare const hasColumns: <TRow extends object, TVal = unknown>(columns: IressTableProps<TRow, TVal>["columns"]) => boolean;

package/dist/src/components/Table/hooks/useIDSTableColumnSort.d.ts

@@ -0,0 +1,2 @@
+import { TableColumnHookProps, TableColumnSortHook } from '../Table.types';
+export declare const useIDSTableColumnSort: ({ columnApi, columnKey, }: TableColumnHookProps) => TableColumnSortHook | undefined;

package/dist/src/components/Table/hooks/useIDSTableColumnStyles.d.ts

@@ -0,0 +1,2 @@
+import { TableColumnHookProps, TableColumnStylesHook } from '../Table.types';
+export declare const useIDSTableColumnStyles: ({ columnKey, }: TableColumnHookProps) => TableColumnStylesHook | undefined;

package/dist/src/components/Table/hooks/useTable.d.ts

@@ -0,0 +1 @@
+export declare const useTable: <TRow extends object, TVal = unknown>() => import('..').TableContextValue<TRow, TVal>;

package/dist/src/components/Table/index.d.ts

@@ -0,0 +1,6 @@
+export * from './Table.types';
+export * from './Table';
+export * from './TableFormattedValue/TableFormattedValue.types';
+export * from './TableFormattedValue/TableFormattedValue';
+export * from './TableBody/TableBody.types';
+export * from './TableBody/TableBody';

package/dist/src/components/Tag/Tag.d.ts

@@ -0,0 +1,2 @@
+import { IressTagProps } from './Tag.types';
+export declare const IressTag: ({ children, className, "data-testid": dataTestId, deleteButton, deleteButtonText, onDelete, onDeleteButtonBlur, ...restProps }: IressTagProps) => import("react/jsx-runtime").JSX.Element;

package/dist/src/components/Tag/Tag.types.d.ts

@@ -0,0 +1,25 @@
+import { IressHTMLAttributes } from '../../interfaces';
+import { ButtonRef } from '../Button';
+export interface IressTagProps extends IressHTMLAttributes {
+    /**
+     * Contents of the tag.
+     */
+    children?: React.ReactNode;
+    /**
+     * You can completely replace the delete button to provide your own functionality.
+     * When this is provided, `deleteButtonText` will not be used and `onDelete` and `onDeleteButtonBlur` will not be called.
+     */
+    deleteButton?: React.ReactNode;
+    /**
+     * Screen reader text for delete button
+     */
+    deleteButtonText?: string;
+    /**
+     * Callback triggered when the tag is deleted
+     */
+    onDelete?: (children: string, e: React.SyntheticEvent<ButtonRef>) => void;
+    /**
+     * Callback triggered when the close button is blurred
+     */
+    onDeleteButtonBlur?: (e: React.FocusEvent<HTMLButtonElement>) => void;
+}

package/dist/src/components/Tag/TagInput/TagInput.d.ts

@@ -0,0 +1,3 @@
+import { IressTagInputProps } from './TagInput.types';
+import { InputRef } from '../../Input';
+export declare const IressTagInput: import('react').ForwardRefExoticComponent<IressTagInputProps & import('react').RefAttributes<InputRef>>;

package/dist/src/components/Tag/TagInput/TagInput.types.d.ts

@@ -0,0 +1,21 @@
+import { SyntheticEvent } from 'react';
+import { TagListInputProps } from '../components/TagListInput/TagListInput.types';
+import { InputBaseElement } from '../../Input';
+export interface IressTagInputProps extends Omit<TagListInputProps, 'defaultValue' | 'deleteButton' | 'onChange' | 'styles' | 'tags' | 'value'> {
+    /**
+     * Tags to display (uncontrolled)
+     */
+    defaultValue?: string[];
+    /**
+     * Emitted when the value changes.
+     */
+    onChange?: (e?: SyntheticEvent<InputBaseElement>, value?: string[]) => void;
+    /**
+     * Emitted when the user attempts to add a tag that already exists.
+     */
+    onExistingTag?: (tag: string) => void;
+    /**
+     * Tags to display (controlled)
+     */
+    value?: string[];
+}

package/dist/src/components/Tag/components/TagListInput/TagListInput.d.ts

@@ -0,0 +1,3 @@
+import { TagListInputProps } from './TagListInput.types';
+import { InputRef } from '../../../Input/InputBase/InputBase.types';
+export declare const TagListInput: import('react').ForwardRefExoticComponent<TagListInputProps & import('react').RefAttributes<InputRef>>;

package/dist/src/components/Tag/components/TagListInput/TagListInput.types.d.ts

@@ -0,0 +1,45 @@
+import { IressInputProps } from '../../../Input';
+export interface TagListInputProps extends IressInputProps<string> {
+    /**
+     * You can completely replace the delete button to provide your own functionality
+     * When this is provided, `onTagDelete`, `onTagDeleteAll` and `onTagDeleteButtonBlur` will not be called.
+     */
+    deleteButton?: React.ReactNode;
+    /**
+     * Emitted when a tag is deleted
+     */
+    onTagDelete?: (label: string) => void;
+    /**
+     * Emitted when the combined tag delete button is clicked
+     */
+    onTagDeleteAll?: (label: string) => void;
+    /**
+     * Emitted when a tag's delete button is blurred
+     */
+    onTagDeleteButtonBlur?: (e: React.FocusEvent<HTMLButtonElement>) => void;
+    /**
+     * Text displayed next to tag count in tag when tag limit is exceeded
+     * @default options selected
+     */
+    selectedOptionsTagText?: string;
+    /**
+     * If you would like to override the styles for the tag list input,
+     * you can pass in a CSS module here with the following keys.
+     */
+    styles?: {
+        tagListInput?: string;
+        tagListInput__element?: string;
+        tagListInput__items?: string;
+        tagListInput__itemsInner?: string;
+    };
+    /**
+     * Tags to display in the tag list input
+     * This is usually the label key in an array of `LabelValue[]` pairs
+     */
+    tags?: string[];
+    /**
+     * Limit of tags to display before shortening to `selectedOptionsTagText`
+     * @default 5
+     */
+    tagLimit?: number;
+}

package/dist/src/components/Tag/index.d.ts

@@ -0,0 +1,4 @@
+export * from './Tag.types';
+export * from './Tag';
+export * from './TagInput/TagInput.types';
+export * from './TagInput/TagInput';

package/dist/src/components/Text/Text.d.ts

@@ -0,0 +1,2 @@
+import { TextWithEnums } from './Text.types';
+export declare const IressText: TextWithEnums;

package/dist/src/components/Text/Text.types.d.ts

@@ -0,0 +1,45 @@
+import { ReactNode } from 'react';
+import { TextElement, TextMode, TextVariant, TextAlign, HeadingLevel } from '../../enums';
+import { IressHTMLAttributes } from '../../interfaces';
+import { HeadingLevels, TextAligns, TextModes, TextVariants } from '../../main';
+export interface IressTextProps extends IressHTMLAttributes<HTMLElement> {
+    /**
+     * The content to be rendered; can be a string or a ReactNode (e.g. IressIcon).
+     */
+    children?: ReactNode | string;
+    /**
+     * Text alignment.
+     */
+    align?: TextAlign | TextAligns;
+    /**
+     * The HTML element that should be rendered.
+     * @default TextElement.Div
+     */
+    element?: TextElement | HeadingLevel | TextElements | HeadingLevels;
+    /**
+     * Allows control of the text color.
+     *
+     * **Note**: The body mode has been deprecated and will be removed in a future version. Please use the body variant instead.
+     */
+    mode?: TextMode | TextModes;
+    /**
+     * Removes bottom margin from last child of the text element if true.
+     */
+    noGutter?: boolean;
+    /**
+     * The typographic style to be rendered.
+     */
+    variant?: TextVariant | TextVariants;
+}
+export declare const TEXT_ELEMENTS: readonly ["p", "div", "span", "h1", "h2", "h3", "h4", "h5", "h6", "code", "blockquote", "caption", "cite", "small"];
+export type TextElements = (typeof TEXT_ELEMENTS)[number];
+export interface TextWithEnums extends React.FC<IressTextProps> {
+    /** @deprecated IressText.Mode is now deprecated and will be removed in a future version. Please use the value directly instead. */
+    Mode: typeof TextMode;
+    /** @deprecated IressText.Element is now deprecated and will be removed in a future version. Please use the value directly instead. */
+    Element: typeof TextElement;
+    /** @deprecated IressText.Align is now deprecated and will be removed in a future version. Please use the value directly instead. */
+    Align: typeof TextAlign;
+    /** @deprecated IressText.Variant is now deprecated and will be removed in a future version. Please use the value directly instead. */
+    Variant: typeof TextVariant;
+}

package/dist/src/components/Text/index.d.ts

@@ -0,0 +1,2 @@
+export * from './Text.types';
+export * from './Text';

package/dist/src/components/Toaster/Toast/Toast.d.ts

@@ -0,0 +1,3 @@
+import { IressToastProps, ToastWithEnums } from './Toast.types';
+export declare const Toast: ({ heading, headingLevel, headingText, status, actions, content, dismissible, onClose, children, "data-testid": dataTestId, className, ...restProps }: IressToastProps, ref: React.Ref<HTMLDivElement>) => import("react/jsx-runtime").JSX.Element;
+export declare const IressToast: ToastWithEnums;

package/dist/src/components/Toaster/Toast/Toast.types.d.ts

@@ -0,0 +1,95 @@
+import { default as React } from 'react';
+import { IressHTMLAttributes } from '../../../interfaces';
+import { HeadingLevel } from '../../../enums';
+import { ButtonRef } from '../../Button';
+interface ToastHeadingProps<T = HTMLDivElement> extends IressHTMLAttributes<T> {
+    /**
+     * The heading area of the toast. You can pass react component such as `<IressText>Error</IressText>`.
+     * If a string is provided, it will default to a `<h2 />` element.
+     */
+    heading?: React.ReactNode;
+}
+interface ToastCloseButtonProps<T = HTMLDivElement> extends IressHTMLAttributes<T> {
+    /**
+     * A boolean to show hide the dismiss close button on the top right of the corner.
+     * @default true
+     */
+    dismissible?: boolean;
+    /**
+     * Click event on the close button of the toast.
+     */
+    onClose?: (e?: React.MouseEvent<ButtonRef>) => void;
+}
+interface ToastActionProps<T = HTMLDivElement> extends IressHTMLAttributes<T> {
+    /**
+     * Buttons and controls for the toast.
+     */
+    actions?: React.ReactNode;
+}
+interface ToastContentProps extends ToastHeadingProps, ToastCloseButtonProps, ToastActionProps {
+    /**
+     * The toast message.
+     */
+    children?: React.ReactNode;
+    /**
+     * The content of the toast message.
+     * @deprecated use children instead.
+     */
+    content?: string;
+    /**
+     * System status of Toast
+     */
+    status: ToastStatus;
+}
+export interface IressToastProps extends IressHTMLAttributes<HTMLDivElement>, ToastContentProps {
+    /**
+     * The toast message.
+     */
+    children?: React.ReactNode;
+    /**
+     * The content of the toast message.
+     * @deprecated use children instead.
+     */
+    content?: string;
+    /**
+     * Heading level for the Toast heading. Will be ignored if headingText is not supplied.
+     * @default h2
+     * @deprecated Use `heading` instead.
+     */
+    headingLevel?: HeadingLevel;
+    /**
+     * Text for Toast heading. If not supplied, heading will not be displayed.
+     * @deprecated Use `heading` instead.
+     */
+    headingText?: string;
+    /**
+     * The amount of time, in milliseconds, the toast is displayed on screen without
+     * the users interaction. Will fall back to timeout prop on parent toaster and then
+     * the default time of 6000ms. If set to 0, the toast will not auto dismiss.
+     * @default 6000
+     */
+    timeout?: number;
+}
+export interface IressToastAnimatedProps extends IressToastProps {
+    /**
+     * The animation of the toast. If not provided, it will simply fade in and out.
+     */
+    animation?: ToastAnimation;
+    /**
+     * Called when the element timed out.
+     */
+    onTimeout?: () => void;
+}
+export type ToastActionComponent = React.FC<ToastActionProps>;
+export type ToastCloseButtonComponent = React.FC<ToastCloseButtonProps>;
+export type ToastContentComponent = React.FC<ToastContentProps>;
+export type ToastWithEnums = React.ForwardRefExoticComponent<IressToastProps & React.RefAttributes<HTMLDivElement>> & {
+    /** @deprecated IressToast.HeadingLevel is now deprecated and will be removed in a future version. Please use the value directly. **/
+    HeadingLevel: typeof HeadingLevel;
+};
+export type NewToast = Omit<IressToastProps, 'status'>;
+export declare const TOAST_STATUS: readonly ["success", "error", "info"];
+export type ToastStatus = (typeof TOAST_STATUS)[number];
+export declare const TOAST_ANIMATION: readonly ["start-x", "end-x", "start-y", "end-y"];
+export type ToastAnimation = (typeof TOAST_ANIMATION)[number];
+export {};

package/dist/src/components/Toaster/Toast/ToastAnimated.d.ts

@@ -0,0 +1,2 @@
+import { IressToastAnimatedProps } from './Toast.types';
+export declare const IressToastAnimated: ({ animation, className, onClose, onTimeout, timeout, ...restProps }: IressToastAnimatedProps) => false | import("react/jsx-runtime").JSX.Element;

package/dist/src/components/Toaster/Toast/ToastIcon.d.ts

@@ -0,0 +1,6 @@
+import { ToastStatus } from './Toast.types';
+interface ToastIconProps {
+    status: ToastStatus;
+}
+export declare const ToastIcon: React.FC<ToastIconProps>;
+export {};

package/dist/src/components/Toaster/Toaster.d.ts

@@ -0,0 +1,2 @@
+import { IressToasterProps } from './Toaster.types';
+export declare const IressToaster: ({ container, position, toasts, }: IressToasterProps) => import("react/jsx-runtime").JSX.Element | null;