@iress-oss/ids-components 0.0.1-dev.9 → 5.13.1

package/dist/src/enums.d.ts

@@ -0,0 +1,215 @@
+export declare enum GlobalCSSClass {
+    FormElement = "iress-form-element",
+    FormElementInner = "iress-form-element__inner",
+    FormElementInvalid = "iress-form-element--invalid",
+    FormLabel = "iress-form-label",
+    SROnly = "iress-sr-only",
+    NoScroll = "iress-no-scroll",
+    Hidden = "iress-hidden",
+    IgnoreStack = "iress-u-stack--ignore",
+    TextAlignBase = "iress--text-align",
+    HiddenMobile = "iress-hidden--mobile",
+    Width = "iress-width",
+    Display = "iress-display",
+    Padding = "iress-p"
+}
+/** @deprecated Breakpoint enum is now deprecated and will be removed in a future version. Please use the Breakpoints type instead. **/
+export declare enum Breakpoint {
+    Xs = "xs",
+    Sm = "sm",
+    Md = "md",
+    Lg = "lg",
+    Xl = "xl",
+    Xxl = "xxl"
+}
+/** @deprecated DisplayMode enum is now deprecated and will be removed in a future version. Please use the DisplayModes type instead. **/
+export declare enum DisplayMode {
+    Inline = "inline",
+    Overlay = "overlay"
+}
+/** @deprecated HeadingLevel enum is now deprecated and will be removed in a future version. Please use the HeadingLevels type instead. */
+export declare enum HeadingLevel {
+    H2 = "h2",
+    H3 = "h3",
+    H4 = "h4",
+    H5 = "h5",
+    H6 = "h6"
+}
+/** @deprecated LoggerLevels enum is now deprecated and will be removed in a future version. Please use the LoggerLevels type instead. **/
+export declare enum LoggerLevels {
+    Log = "log",
+    Warn = "warn",
+    Error = "error"
+}
+/** @deprecated TextFieldType enum is now deprecated and will be removed in a future version. Please use the value directly instead. **/
+export declare enum TextFieldType {
+    Date = "date",
+    Email = "email",
+    Number = "number",
+    Password = "password",
+    Search = "search",
+    Tel = "tel",
+    Text = "text",
+    Url = "url",
+    Time = "time",
+    Color = "color",
+    File = "file",
+    DateTimeLocal = "datetime-local"
+}
+/** @deprecated FormElementType enum is now deprecated and will be removed in a future version. Please use the FormElementTypes type instead. **/
+export declare enum FormElementType {
+    Date = "date",
+    Email = "email",
+    Number = "number",
+    Password = "password",
+    Search = "search",
+    Tel = "tel",
+    Text = "text",
+    Url = "url",
+    Time = "time",
+    File = "file",
+    Color = "color",
+    Checkbox = "checkbox",
+    Radio = "radio",
+    Select = "select",
+    CheckboxGroup = "checkbox-group",
+    RadioGroup = "radio-group",
+    Combobox = "combobox",
+    DateTimeLocal = "datetime-local"
+}
+/** @deprecated FormElementWidth enum is now deprecated and will be removed in a future version. Please use the FormElementWidths type instead. **/
+export declare enum FormElementWidth {
+    Two = "2",
+    Four = "4",
+    Six = "6",
+    Eight = "8",
+    Ten = "10",
+    Twelve = "12",
+    Sixteen = "16",
+    TwentyFivePercent = "25perc",
+    FiftyPercent = "50perc",
+    SeventyFivePercent = "75perc"
+}
+/** @deprecated FloatingUIAlign enum is now deprecated and will be removed in a future version. Please use the FloatingUIAligns type instead. **/
+export declare enum FloatingUIAlign {
+    Auto = "auto",
+    BottomStart = "bottom-start",
+    BottomCenter = "bottom",
+    BottomEnd = "bottom-end",
+    TopStart = "top-start",
+    TopCenter = "top",
+    TopEnd = "top-end",
+    LeftStart = "left-start",
+    LeftCenter = "left",
+    LeftEnd = "left-end",
+    RightStart = "right-start",
+    RightCenter = "right",
+    RightEnd = "right-end"
+}
+/** @deprecated SystemValidationStatus enum is now deprecated and will be removed in a future version. Please use the SystemValidationStatuses type instead. **/
+export declare enum SystemValidationStatus {
+    Danger = "danger",
+    Info = "info",
+    Success = "success",
+    Warning = "warning"
+}
+/** @deprecated TextAlign enum is now deprecated and will be removed in a future version. Please use the TextAligns type instead. **/
+export declare enum TextAlign {
+    Inherit = "inherit",
+    Left = "left",
+    Center = "center",
+    Right = "right",
+    Justify = "justify"
+}
+/** @deprecated TextElement enum is now deprecated and will be removed in a future version. Please use the TextElements type instead. **/
+export declare enum TextElement {
+    P = "p",
+    Div = "div",
+    Span = "span",
+    H1 = "h1",
+    H2 = "h2",
+    H3 = "h3",
+    H4 = "h4",
+    H5 = "h5",
+    H6 = "h6",
+    Code = "code",
+    Blockquote = "blockquote",
+    Caption = "caption",
+    Cite = "cite",
+    Small = "small"
+}
+/** @deprecated TextMode enum is now deprecated and will be removed in a future version. Please use the TextModes type instead. **/
+export declare enum TextMode {
+    /** @deprecated TextMode.Body enum is deprecated and will be removed in a future version. Please use the variant prop instead. **/
+    Body = "body",
+    Danger = "danger",
+    Info = "info",
+    Muted = "muted",
+    Primary = "primary",
+    Success = "success",
+    Warning = "warning",
+    Positive = "positive",
+    Negative = "negative"
+}
+/** @deprecated TextVariant enum is now deprecated and will be removed in a future version. Please use the TextVariants type instead. **/
+export declare enum TextVariant {
+    Blockquote = "blockquote",
+    Bold = "bold",
+    Body = "body",
+    Code = "code",
+    Display = "display",
+    Display1 = "display1",
+    Display2 = "display2",
+    Display3 = "display3",
+    Display4 = "display4",
+    Heading1 = "h1",
+    Heading2 = "h2",
+    Heading3 = "h3",
+    Heading4 = "h4",
+    Heading5 = "h5",
+    Heading6 = "h6",
+    Italic = "italic",
+    Lead = "lead",
+    Small = "small",
+    Cite = "cite",
+    Caption = "caption"
+}
+/** @deprecated PaddingSize enum is now deprecated and will be removed in a future version. Please use the PaddingSizes type instead. **/
+export declare enum PaddingSize {
+    None = "none",
+    Sm = "sm",
+    Md = "md",
+    Lg = "lg"
+}
+/** @deprecated ModalSize enum is now deprecated and will be removed in a future version. Please use the ModalSizes type instead. **/
+export declare enum ModalSize {
+    Sm = "sm",
+    Md = "md",
+    Lg = "lg",
+    FullPage = "fullpage"
+}
+/** @deprecated GutterSize enum is now deprecated and will be removed in a future version. Please use the GutterSizes type instead. **/
+export declare enum GutterSize {
+    None = "none",
+    Xs = "xs",
+    Sm = "sm",
+    Md = "md",
+    Lg = "lg",
+    Xl = "xl"
+}
+/** @deprecated HorizontalAlign is now deprecated and will be removed in a future version. Please use the HorizontalAligns type instead. */
+export declare enum HorizontalAlign {
+    Around = "around",
+    Between = "between",
+    Center = "center",
+    Evenly = "evenly",
+    Left = "left",
+    Right = "right"
+}
+/** @deprecated VerticalAlign is now deprecated and will be removed in a future version. Please use the VerticalAligns type instead. */
+export declare enum VerticalAlign {
+    Bottom = "bottom",
+    Middle = "middle",
+    Stretch = "stretch",
+    Top = "top"
+}

package/dist/src/helpers/dom/focusableElements.d.ts

@@ -0,0 +1 @@
+export declare const focusableElements: (el: HTMLElement) => HTMLElement[];

package/dist/src/helpers/dom/getActiveElement.d.ts

@@ -0,0 +1 @@
+export declare const getActiveElement: () => HTMLElement;

package/dist/src/helpers/dom/hasShadowDom.d.ts

@@ -0,0 +1 @@
+export declare const hasShadowDom: (el: HTMLElement) => boolean;

package/dist/src/helpers/form/getFormControlValueAsString.d.ts

@@ -0,0 +1,2 @@
+import { FormControlValue } from '../../types';
+export declare const getFormControlValueAsString: (value?: FormControlValue) => string;

package/dist/src/helpers/form/getFormControlValueAsStringIfDefined.d.ts

@@ -0,0 +1,2 @@
+import { FormControlValue } from '../../types';
+export declare const getFormControlValueAsStringIfDefined: (value?: FormControlValue) => string | undefined;

package/dist/src/helpers/form/getValueAsEvent.d.ts

@@ -0,0 +1,15 @@
+import { FormControlValue } from '../../types';
+/**
+ * This method wraps up a value in an event object, allowing it to work in React Hook Forms change handlers.
+ * See: https://github.com/react-hook-form/react-hook-form/blob/6deae49068dc8ac056977d4def168a78968d9e61/src/types/form.ts#L96
+ * @param value
+ * @returns { target: { value } }
+ */
+export declare const getValueAsEvent: <T = FormControlValue, EventType = {
+    currentTarget: {
+        value: T;
+    };
+    target: {
+        value: T;
+    };
+}>(value: T) => EventType;

package/dist/src/helpers/form/isValidFormInputElement.d.ts

@@ -0,0 +1 @@
+export declare const isValidFormInputElement: (ele: HTMLElement) => boolean;

package/dist/src/helpers/formatting/capitalizeFirstLetter.d.ts

@@ -0,0 +1 @@
+export declare const capitalizeFirstLetter: (str: string) => string;

package/dist/src/helpers/formatting/formatCurrency.d.ts

@@ -0,0 +1,25 @@
+export interface CurrencyFormatterProps {
+    /**
+     * The currency code to use when formatting the value.
+     */
+    currencyCode?: string;
+    /**
+     * Additional options to pass to the `Intl.NumberFormat` constructor.
+     * [Learn more](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat)
+     */
+    formatOptions?: Omit<Intl.NumberFormatOptions, 'currency'>;
+    /**
+     * The locale to use when formatting the value.
+     * @default 'en-AU'
+     */
+    locale?: Intl.LocalesArgument;
+    /**
+     * The value to format.
+     */
+    value?: string | number | null;
+    /**
+     * Whether to include the currency symbol in the output.
+     */
+    withSymbol?: boolean;
+}
+export declare const formatCurrency: ({ value, locale, currencyCode, withSymbol, formatOptions, }: CurrencyFormatterProps) => string | number;

package/dist/src/helpers/formatting/formatDate.d.ts

@@ -0,0 +1,5 @@
+export declare const pad: (num: number) => string;
+export type DateValue = string | number | Date;
+export declare const getDateObj: (value: DateValue) => Date;
+export declare const formatDate: (dateVal: DateValue) => string;
+export declare const formatShortDate: (dateVal: DateValue) => string;

package/dist/src/helpers/formatting/formatDateTime.d.ts

@@ -0,0 +1,3 @@
+import { DateValue } from './formatDate';
+export declare const formatISODateTime: (dateVal: DateValue) => string;
+export declare const formatRelativeTime: (dateVal: DateValue, useShortDateAfter?: Intl.RelativeTimeFormatUnit | null) => string;

package/dist/src/helpers/formatting/formatObjectKey.d.ts

@@ -0,0 +1 @@
+export declare const formatObjectKey: (key: string) => string;

package/dist/src/helpers/formatting/formatPercentage.d.ts

@@ -0,0 +1 @@
+export declare const formatPercentage: (value: number | string) => string;

package/dist/src/helpers/formatting/stringReplacer.d.ts

@@ -0,0 +1,2 @@
+import { NameValue } from '../../interfaces';
+export declare const stringReplacer: (str: string, replaceArr?: NameValue[]) => string;

package/dist/src/helpers/formatting/toArray.d.ts

@@ -0,0 +1 @@
+export declare const toArray: <T>(item?: T | T[]) => T[];

package/dist/src/helpers/formatting/toCSSLengthValue.d.ts

@@ -0,0 +1 @@
+export declare const toCSSLengthValue: (val: string | number) => string;

package/dist/src/helpers/label-value/composeLabelValueDescriptor.d.ts

@@ -0,0 +1,9 @@
+import { LabelValueMeta } from '../../interfaces';
+/**
+ * Converts the selected options into a human-readable string.
+ *
+ * @param selected the selected state, usually a single or array of LabelValueMeta
+ * @param selectedOptionsText when multiple options are selected, this text will be used to describe the selection. {{numOptions}} is replaced with the number of options selected.
+ * @returns
+ */
+export declare const composeLabelValueDescriptor: (selected?: LabelValueMeta | LabelValueMeta[], selectedOptionsText?: string) => string;

package/dist/src/helpers/label-value/getQueryRangeExclusive.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Get the range of label where the query is not found.
+ * This is useful for highlighting the area of the label that does not match the query.
+ * @param query
+ * @param label
+ * @returns [start: number, end: number] | undefined
+ */
+export declare const getQueryRangeExclusive: (query: string, label: string) => [start: number, end: number] | undefined;

package/dist/src/helpers/label-value/getValueFromLabelValues.d.ts

@@ -0,0 +1,2 @@
+import { LabelValue } from '../../interfaces';
+export declare const getValueFromLabelValues: (items?: LabelValue | LabelValue[], array?: boolean) => string | number | boolean | (string | number | boolean)[];

package/dist/src/helpers/label-value/highlightQueryInLabel.d.ts

@@ -0,0 +1,2 @@
+import { ElementType, ReactNode } from 'react';
+export declare const highlightQueryInLabel: (label: string, query: string, Tag?: ElementType) => ReactNode;

package/dist/src/helpers/label-value/highlightQueryInLabelValue.d.ts

@@ -0,0 +1,3 @@
+import { ElementType } from 'react';
+import { FormattedLabelValueMeta, LabelValueMeta } from '../../interfaces';
+export declare const highlightQueryInLabelValue: (labelValueMeta: LabelValueMeta, query: string, Tag?: ElementType) => FormattedLabelValueMeta;

package/dist/src/helpers/label-value/searchLabelValues.d.ts

@@ -0,0 +1,2 @@
+import { FormattedLabelValueMeta, LabelValue } from '../../interfaces';
+export declare const searchLabelValues: (query: string, optionsData: LabelValue[], resultLimit?: number) => FormattedLabelValueMeta[];

package/dist/src/helpers/responsive/getResponsiveLayoutModifiers.d.ts

@@ -0,0 +1,2 @@
+import { ResponsiveSizing } from '../../interfaces';
+export declare const getResponsiveLayoutModifiers: <T = string>(modifier: string, values?: ResponsiveSizing<T> | T, fallback?: T) => string[];

package/dist/src/helpers/responsive/getResponsivePaddingClasses.d.ts

@@ -0,0 +1,2 @@
+import { ResponsiveSizing } from '../../interfaces';
+export declare const getResponsivePaddingClasses: <T = string>(padding: ResponsiveSizing<T> | T) => string[];

package/dist/src/helpers/transition/getTransitionDuration.d.ts

@@ -0,0 +1 @@
+export declare const getTransitionDuration: (element?: HTMLElement | null, multiplier?: number, fallback?: number) => number;

package/dist/src/helpers/transition/timeStringToNumber.d.ts

@@ -0,0 +1 @@
+export declare const timeStringToNumber: (timeStr: string) => number;

package/dist/src/helpers/utility/generateScopedName.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This function generates a scoped class name for CSS modules.
+ * We override it so we can have a predictable class name for consumers to use.
+ * @param name The class name
+ * @param filename The file name where the class name exists
+ * @returns a scoped class name, in the format of `ids-${component}--${class}-${version}`
+ */
+export declare const generateScopedName: (name: string, filename: string) => string;

package/dist/src/helpers/utility/idsLogger.d.ts

@@ -0,0 +1,3 @@
+import { LoggerLevels } from '../../enums';
+import { LoggerLevelsUnion } from '../../types';
+export declare const idsLogger: (msg: string, level?: LoggerLevels | LoggerLevelsUnion) => void;

package/dist/src/helpers/utility/propagateTestid.d.ts

@@ -0,0 +1 @@
+export declare const propagateTestid: (dataTestid: string | undefined, id: string, separator?: string) => string | undefined;

package/dist/src/hooks/index.d.ts

@@ -0,0 +1,4 @@
+export * from './useBreakpoint';
+export * from './useControlledState';
+export * from './useIdIfNeeded';
+export * from './useResponsiveProps';

package/dist/src/hooks/useAriaRelationship.d.ts

@@ -0,0 +1,11 @@
+export interface AriaRelationshipProps<TController extends HTMLElement = HTMLElement> {
+    setController: (ref: TController | null) => void;
+    setControlViaRef: <TControl extends HTMLElement = HTMLElement>(controlId: string) => (element: TControl | null) => void;
+}
+/**
+ * Adjusts the aria attribute of an element,
+ * to help screen readers understand the relationship between elements and their controller.
+ *
+ * @param attribute - The aria attribute to adjust.
+ */
+export declare const useAriaRelationship: <TController extends HTMLElement = HTMLElement>(attribute: "aria-controls" | "aria-owns") => AriaRelationshipProps<TController>;

package/dist/src/hooks/useBreakpoint.d.ts

@@ -0,0 +1,11 @@
+import { BreakpointDetail } from '../interfaces';
+import { Breakpoints } from '../types';
+interface BreakpointResult {
+    breakpoint: Breakpoints;
+    detail: BreakpointDetail;
+}
+/**
+ * Retrieve the current breakpoint and its detail based on the window size
+ */
+export declare const useBreakpoint: () => BreakpointResult;
+export {};

package/dist/src/hooks/useControlledState.d.ts

@@ -0,0 +1,22 @@
+import { FormControlValue } from '../types';
+export interface ControlledStateProps<T = FormControlValue> {
+    component: string;
+    defaultValue?: T;
+    multiple?: boolean;
+    onChange?: (selected?: T) => void;
+    propName?: string;
+    value?: T;
+}
+export interface ControlledStateHook<TValue = FormControlValue, TArrayValue = TValue> {
+    value: TValue | undefined;
+    setValue: (value?: TValue) => void;
+    toggleValue: (value?: TArrayValue, flag?: boolean) => void;
+    isControlled: boolean;
+}
+/**
+ * Allows you to return a controlled state or uncontrolled state, depending on the props passed.
+ * It can also deal with the cases when an array of values is required.
+ *
+ * @param {ControlledValueProps<T>} props Allows you to set the initial selected value, the onChange callback, and whether multiple values are allowed (array).
+ */
+export declare const useControlledState: <TValue = FormControlValue, TArrayValue = TValue>({ component, defaultValue, multiple, onChange, propName, value, }: ControlledStateProps<TValue>) => ControlledStateHook<TValue, TArrayValue>;

package/dist/src/hooks/useIdIfNeeded.d.ts

@@ -0,0 +1,2 @@
+import { IressHTMLAttributes } from '../interfaces';
+export declare const useIdIfNeeded: <T extends React.HTMLAttributes<HTMLElement> = IressHTMLAttributes>({ id: propId }?: T, prefix?: string) => string;

package/dist/src/hooks/useResponsiveProps.d.ts

@@ -0,0 +1,19 @@
+import { ResponsiveProps } from '../types';
+/**
+ * Allows you to pluck a value from a an object with breakpoint keys.
+ * Note: Where possible, we recommend using media queries in CSS instead of JS, as that will reduce the load for the user. However, sometimes it's necessary to change a prop based on the user's breakpoint, hence why this hook is provided.
+ * @param {ResponsiveProps<T>} values A set of values, separated by breakpoint and ready for plucking.
+ * @param {boolean} inheritPrevious Whether to inherit the previous breakpoint value, if none was found for the current one.
+ * @returns { breakpoint: Breakpoints; value?: T | null } The current user's breakpoint, along with a matching value if one was found.
+ */
+export declare const useResponsiveProps: <T>(props?: ResponsiveProps<T>, inheritPrevious?: boolean) => {
+    breakpoint: "xs" | "sm" | "md" | "lg" | "xl" | "xxl";
+    value: T | undefined;
+};
+/**
+ * @deprecated Use useResponsiveProps instead
+ */
+export declare const useResponsiveValue: <T>(props?: ResponsiveProps<T>, inheritPrevious?: boolean) => {
+    breakpoint: "xs" | "sm" | "md" | "lg" | "xl" | "xxl";
+    value: T | undefined;
+};

package/dist/src/interfaces.d.ts

@@ -0,0 +1,67 @@
+import { ReactNode } from 'react';
+import { SystemValidationStatus, PaddingSize } from './enums';
+import { FormControlValue, PaddingSizes, SystemValidationStatuses } from './types';
+export interface ValidationMessageObj {
+    status?: SystemValidationStatus | SystemValidationStatuses;
+    message: string;
+    linkToTarget?: string;
+    dataTestId?: string;
+    prefix?: ReactNode;
+    visiblePrefix?: boolean;
+}
+export type WithDataAttributes<T = NonNullable<unknown>> = T & {
+    'data-testid'?: string;
+    'data-value'?: string;
+};
+export interface NameValue {
+    name: string;
+    value: string;
+}
+export type IressHTMLAttributes<T = HTMLDivElement> = WithDataAttributes<React.HTMLAttributes<T>>;
+export type IressInputHTMLAttributes<T = HTMLInputElement> = WithDataAttributes<React.InputHTMLAttributes<T>>;
+export type IressAnchorHTMLAttributes<T = HTMLAnchorElement> = WithDataAttributes<React.AnchorHTMLAttributes<T>>;
+export type IressButtonHTMLAttributes<T = HTMLButtonElement> = WithDataAttributes<React.ButtonHTMLAttributes<T>>;
+export type IressFormHTMLAttributes<T = HTMLFormElement> = WithDataAttributes<React.FormHTMLAttributes<T>>;
+/**
+ * @deprecated, use ResponsiveProps<T> instead
+ */
+export interface ResponsiveSizing<T> {
+    xs?: T | null;
+    sm?: T | null;
+    md?: T | null;
+    lg?: T | null;
+    xl?: T | null;
+    xxl?: T | null;
+}
+type VariablePaddingSizeDimension = PaddingSize | PaddingSizes | null;
+export interface VariablePaddingSize {
+    b?: VariablePaddingSizeDimension;
+    l?: VariablePaddingSizeDimension;
+    r?: VariablePaddingSizeDimension;
+    t?: VariablePaddingSizeDimension;
+    x?: VariablePaddingSizeDimension;
+    y?: VariablePaddingSizeDimension;
+}
+export interface LabelValue {
+    label: string;
+    testId?: string;
+    value?: FormControlValue;
+}
+export interface LabelValueMeta extends LabelValue {
+    append?: React.ReactNode;
+    divider?: boolean;
+    meta?: React.ReactNode;
+    prepend?: React.ReactNode;
+}
+export interface FormattedLabelValueMeta extends LabelValueMeta {
+    formattedLabel?: React.ReactNode;
+}
+export interface BreakpointDetail {
+    mediaQuery: string;
+    screenWidthRange: string;
+    minScreenWidth: string;
+    maxScreenWidth?: string;
+    containerMaxWidth: string;
+    viewportWidth: number;
+}
+export {};

package/dist/src/main.d.ts

@@ -0,0 +1,57 @@
+export * from './components/Alert';
+export * from './components/Autocomplete';
+export * from './components/Badge';
+export * from './components/Button';
+export * from './components/ButtonGroup';
+export * from './components/Card';
+export * from './components/Checkbox';
+export * from './components/CheckboxGroup';
+export * from './components/Col';
+export * from './components/Combobox';
+export * from './components/Container';
+export * from './components/Divider';
+export * from './components/Expander';
+export * from './components/Field';
+export * from './components/Filter';
+export * from './components/Form';
+export * from './components/Hide';
+export * from './components/Icon';
+export * from './components/Inline';
+export * from './components/Input';
+export * from './components/InputCurrency';
+export * from './components/Label';
+export * from './components/Menu';
+export * from './components/Modal';
+export * from './components/Navbar';
+export * from './components/Panel';
+export * from './components/Placeholder';
+export * from './components/Popover';
+export * from './components/Progress';
+export * from './components/Radio';
+export * from './components/RadioGroup';
+export * from './components/Readonly';
+export * from './components/RichSelect';
+export * from './components/Row';
+export * from './components/Select';
+export * from './components/Skeleton';
+export * from './components/SkipLink';
+export * from './components/Slideout';
+export * from './components/Slider';
+export * from './components/Spinner';
+export * from './components/Stack';
+export * from './components/Table';
+export * from './components/TabSet';
+export * from './components/Tag';
+export * from './components/Text';
+export * from './components/Toaster';
+export * from './components/Toggle';
+export * from './components/Tooltip';
+export * from './components/ValidationMessage';
+export * from './patterns/Loading';
+export * from './enums';
+export * from './interfaces';
+export * from './types';
+export * from './helpers/utility/generateScopedName';
+export * from './helpers/formatting/toArray';
+export * from './hooks';
+export * from './constants';

package/dist/src/patterns/Loading/Loading.d.ts

@@ -0,0 +1,42 @@
+import { StartUpLoadingProps } from './components/StartUpLoading';
+import { DefaultLoadingProps } from './components/DefaultLoading';
+import { ValidateLoadingProps } from './components/ValidateLoading';
+import { ComponentLoadingProps } from './components/ComponentLoading';
+import { PageLoadingProps } from './components/PageLoading';
+export type IressLoadingProps = StartUpLoadingProps | ValidateLoadingProps | PageLoadingProps | ComponentLoadingProps | DefaultLoadingProps;
+/**
+ * A pattern component that has in-built loading states for different contexts, designed to provide a consistent user experience across Iress applications.
+ *
+ * The `pattern` prop is used to determine the type of loading state to display. The following patterns are available:
+ *
+ * - `component`: Loading pattern for a component that is expected to take some time to load, but has content around it that can be loaded before it (hence not part of page pattern). It also supports updating the state of the component via a slightly different UI. Examples:
+ *   - Charts that can be updated in real-time
+ *   - Tables that load many records and may update in real-time
+ * - `page`: Loading pattern for a page, with out-of-the-box skeleton templates. Examples:
+ *   - Dashboard page with multiple filters/panels
+ *   - Search page with multiple filters and search results
+ *   - Detail page for a record
+ *   - Form page
+ *   - Article page
+ * - `start-up`: Loading pattern when the application is first loaded. Examples:
+ *   - Loading an application for the first time
+ *   - Switching from a different application to a new application
+ *   - Switching from a client's website to an Iress application
+ *   - Switching themes
+ * - `validate`: Loading pattern when validating user input. Examples:
+ *   - Submitting a form
+ *   - Saving a record
+ *
+ * If no `pattern` is provided, it will use the default experience, which only displays a message after a certain amount of time to help stop drop-offs due to uncommon loading times.
+ */
+export declare const IressLoading: {
+    ({ pattern, ...restProps }: IressLoadingProps): import("react/jsx-runtime").JSX.Element;
+    /**
+     * This hook is used to smooth the loading experience by delaying the loading indicator being removed after the loading of an element finishes.
+     *
+     * @param isLoaded - A boolean value that determines if the component waiting to be loaded has finished loading.
+     * @param delay - Once a component has loaded, how long should the loading indicator be displayed for.
+     * @returns A boolean value that determines whether the `IressLoading` component is safe to be removed.
+     */
+    shouldRender: (isLoaded: boolean, delay?: number, startFrom?: number) => boolean;
+};