@iress-oss/ids-components 5.20.2 → 6.0.0-alpha.1

package/dist/src/components/Divider/meta/index.d.ts

@@ -0,0 +1,7 @@
+declare const _default: {
+    heading: string;
+    href: string;
+    tags: string[];
+    Thumbnail: import('react').LazyExoticComponent<() => import("react/jsx-runtime").JSX.Element>;
+};
+export default _default;

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

@@ -0,0 +1,31 @@
+import { ReactNode } from 'react';
+import { IressTextProps } from '../Text';
+import { IressCustomiseSlot } from '../../interfaces';
+export interface IressExpanderProps extends Omit<IressTextProps<'div'>, 'element' | 'onChange'> {
+    /**
+     * The element used to activate the expandable container.
+     */
+    activator: ReactNode;
+    /**
+     * This allows you to customise the content styling specifically, which is the floating element.
+     * It accepts an object with any of the styling properties available on `IressCSSProps`, as well as `className` and `style`.
+     */
+    activatorStyle?: IressCustomiseSlot;
+    /**
+     * Contents that will be expanded/collapsed when the expander is activated.
+     */
+    children?: ReactNode;
+    /**
+     * Emitted when the open state changes.
+     */
+    onChange?: (newValue: boolean) => void;
+    /**
+     * Controls the display mode of the activator element. Can be Section, Heading or Link.
+     */
+    mode?: 'section' | 'link';
+    /**
+     * When true the expandable container will be visible and the activator will display as open.
+     */
+    open?: boolean;
+}
+export declare const IressExpander: ({ activator, activatorStyle, children, className, "data-testid": testid, onChange, id: idProp, mode, noGutter, open, ...restProps }: IressExpanderProps) => import("react/jsx-runtime").JSX.Element;

package/dist/src/components/Expander/Expander.styles.d.ts

@@ -0,0 +1,45 @@
+export declare const expander: import('../../styled-system/types').SlotRecipeRuntimeFn<"container" | "content" | "root" | "activator" | "containerInner", {
+    mode: {
+        section: {
+            activator: {
+                display: "flex";
+                justifyContent: "space-between";
+                alignItems: "flex-end";
+                width: "[100%]";
+                textStyle: "typography.heading.4";
+                py: "spacing.300";
+                borderBottom: "divider";
+                transition: "[all 0.2s ease-in-out]";
+                _after: {
+                    mr: "spacing.200";
+                };
+                _hover: {
+                    color: "colour.primary.text";
+                    borderBottom: "hover";
+                };
+            };
+        };
+        link: {
+            activator: {
+                color: "colour.primary.text";
+                textDecoration: "underline";
+                _before: {
+                    borderRadius: "radius.system.badge";
+                };
+                _hover: {
+                    textDecoration: "none";
+                };
+            };
+        };
+    };
+    open: {
+        true: {
+            activator: {
+                tableChevron: false;
+            };
+            container: {
+                gridTemplateRows: "1fr";
+            };
+        };
+    };
+}>;

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

@@ -0,0 +1,2 @@
+export * from './Expander';
+export * from './Expander.styles';

package/dist/src/components/Expander/meta/Thumbnail.d.ts

@@ -0,0 +1,2 @@
+declare const Thumbnail: () => import("react/jsx-runtime").JSX.Element;
+export default Thumbnail;

package/dist/src/components/Expander/meta/index.d.ts

@@ -0,0 +1,7 @@
+declare const _default: {
+    heading: string;
+    href: string;
+    tags: string[];
+    Thumbnail: import('react').LazyExoticComponent<() => import("react/jsx-runtime").JSX.Element>;
+};
+export default _default;

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

@@ -0,0 +1,57 @@
+import { ReactNode } from 'react';
+import { LabelBaseProps } from '../Label/LabelBase/LabelBase';
+import { IressStyledProps } from '../../types';
+import { ValidationMessageObj } from '../../interfaces';
+export type IressFieldProps<E extends 'div' | 'fieldset' = 'div', ELabel extends 'label' | 'legend' = 'label'> = IressStyledProps<E> & Pick<LabelBaseProps<ELabel>, 'hiddenLabel' | 'required'> & {
+    /**
+     * The form control this field is related to.
+     */
+    children?: ReactNode;
+    /**
+     * Text to be displayed as supporting field description.
+     */
+    hint?: ReactNode;
+    /**
+     * Displays the label and input field inline instead of stacked vertically.
+     */
+    horizontal?: boolean;
+    /**
+     * Controls the width of the label container when in horizontal mode.
+     * Can be any valid CSS width value (e.g., '200px', '20%', 'auto').
+     * Only applies when `horizontal` is true.
+     */
+    labelWidth?: string;
+    /**
+     * Used to connect it to the input element, it should be the input's id.
+     * If provided, the label will be rendered as a `<label>` element, otherwise it will be rendered as a `<strong>` element.
+     *
+     * [Learn more](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/for)
+     */
+    htmlFor?: ELabel extends 'label' ? string : undefined;
+    /**
+     * Text to be displayed in the label.
+     **/
+    label: ReactNode;
+    /**
+     * Validation error to be displayed above the field.
+     */
+    error?: ReactNode;
+    /**
+     * Validation errors to be displayed above the field, an array of validation messages to be displayed in `IressValidationSummary`.
+     */
+    errorMessages?: ValidationMessageObj[];
+    /**
+     * Renders the group in a read-only state (no asterisk symbol).
+     */
+    readOnly?: boolean;
+    /**
+     * Removes the reserved space for error messages, allowing fields to stack with narrower gaps.
+     * When true, no margin is reserved for potential error messages.
+     */
+    removeErrorMargin?: boolean;
+    /**
+     * Supplementary content to be displayed below the field. Is only shown when the field is not in an error state.
+     */
+    supplementary?: ReactNode;
+};
+export declare const IressField: ({ children, className, "data-testid": dataTestId, error, errorMessages, hiddenLabel, hint, horizontal, label, labelWidth, required, readOnly, removeErrorMargin, supplementary, ...restProps }: IressFieldProps) => import("react/jsx-runtime").JSX.Element;

package/dist/src/components/Field/Field.styles.d.ts

@@ -0,0 +1,88 @@
+export declare const field: import('../../styled-system/types').SlotRecipeRuntimeFn<"footer" | "label" | "hint" | "element" | "root" | "supplementary" | "labelContainer" | "fieldContainer", {
+    horizontal: {
+        true: {
+            root: {
+                display: "grid";
+                gridTemplateColumns: "auto 1fr";
+                gridTemplateRows: "auto auto";
+                gridTemplateAreas: "\"label field\" \". footer\"";
+                columnGap: "spacing.200";
+                alignItems: "center";
+            };
+            labelContainer: {
+                gridArea: "label";
+                alignSelf: "center";
+            };
+            fieldContainer: {
+                gridArea: "field";
+            };
+            footer: {
+                gridArea: "footer";
+                mt: "spacing.100";
+            };
+            label: {
+                mb: "none";
+            };
+        };
+    };
+    hasError: {
+        true: {
+            root: {
+                _nestedFormElements: {
+                    borderColor: "colour.system.danger.fill";
+                };
+            };
+        };
+    };
+    hasHint: {
+        true: {
+            label: {
+                mb: "spacing.000";
+            };
+        };
+    };
+    hiddenLabel: {
+        true: {
+            label: {
+                mb: "none";
+            };
+        };
+    };
+    multipleFields: {
+        true: {
+            supplementary: {
+                position: "relative";
+                _after: {
+                    content: "\"\"";
+                    position: "absolute";
+                    left: "[0]";
+                    right: "[0]";
+                    bottom: "[100%]";
+                    borderBottom: "divider";
+                };
+            };
+        };
+    };
+    removeErrorMargin: {
+        true: {
+            root: {
+                mb: "none";
+            };
+            footer: {
+                position: "static";
+            };
+        };
+        false: {
+            root: {
+                mb: "field.footer";
+            };
+            footer: {
+                position: "absolute";
+                left: "spacing.000";
+                right: "spacing.000";
+                top: "[100%]";
+                mt: "spacing.100";
+            };
+        };
+    };
+}>;

package/dist/src/components/Field/FieldGroup/FieldGroup.d.ts

@@ -0,0 +1,17 @@
+import { IressFieldProps } from '../Field';
+import { ReactNode } from 'react';
+export interface IressFieldGroupProps extends IressFieldProps<'fieldset', 'legend'> {
+    /**
+     * Should contain multiple `IressField`, or other elements supported in field group such as `IressButton`.
+     */
+    children?: ReactNode;
+    /**
+     * Displays multiple children inline rather than stacked, with a small gap.
+     */
+    inline?: boolean;
+    /**
+     * Displays multiple children inline and removes column gap.
+     */
+    join?: boolean;
+}
+export declare const IressFieldGroup: ({ children, className, "data-testid": dataTestId, error, errorMessages, hiddenLabel, hint, inline, join, label, required, supplementary, ...restProps }: IressFieldGroupProps) => import("react/jsx-runtime").JSX.Element;

package/dist/src/components/Field/FieldGroup/FieldGroup.styles.d.ts

@@ -0,0 +1,81 @@
+export declare const fieldGroup: import('../../../styled-system/types').SlotRecipeRuntimeFn<"legend" | "hint" | "root" | "fields", {
+    hasError: {
+        true: {
+            root: {
+                _nestedFormElements: {
+                    borderColor: "colour.system.danger.fill";
+                };
+            };
+        };
+    };
+    hiddenLabel: {
+        true: {
+            legend: {
+                mb: "none";
+            };
+        };
+    };
+    inline: {
+        true: {
+            fields: {
+                alignItems: "flex-end";
+                flexDirection: "row";
+                columnGap: "sm";
+                '& > *': {
+                    flexGrow: "1";
+                };
+                _directNestedFormElements: {
+                    mb: "field.footer";
+                };
+                _directNestedSizedElements: {
+                    flexGrow: "0";
+                    alignSelf: "flex-end";
+                };
+            };
+        };
+    };
+    join: {
+        true: {
+            fields: {
+                alignItems: "flex-end";
+                flexDirection: "row";
+                columnGap: "none";
+                '& > *': {
+                    flexGrow: "1";
+                };
+                _directNestedFormElements: {
+                    mb: "field.footer";
+                };
+                _directNestedSizedElements: {
+                    flexGrow: "0";
+                    alignSelf: "flex-end";
+                };
+                _nestedFieldsExceptFirst: {
+                    borderTopLeftRadius: "radius.000";
+                    borderBottomLeftRadius: "radius.000";
+                    _before: {
+                        borderTopLeftRadius: "radius.000";
+                        borderBottomLeftRadius: "radius.000";
+                    };
+                    _after: {
+                        borderTopLeftRadius: "radius.000";
+                        borderBottomLeftRadius: "radius.000";
+                    };
+                };
+                _nestedFieldsExceptLast: {
+                    borderTopRightRadius: "radius.000";
+                    borderBottomRightRadius: "radius.000";
+                    borderRightWidth: "[0px]";
+                    _before: {
+                        borderTopRightRadius: "radius.000";
+                        borderBottomRightRadius: "radius.000";
+                    };
+                    _after: {
+                        borderTopRightRadius: "radius.000";
+                        borderBottomRightRadius: "radius.000";
+                    };
+                };
+            };
+        };
+    };
+}>;

package/dist/src/components/Field/components/FieldFooter.d.ts

@@ -0,0 +1,22 @@
+import { ReactNode } from 'react';
+import { ValidationMessageObj } from '../../../interfaces';
+import { IressStyledProps } from '../../../types';
+export interface FieldFooterProps extends IressStyledProps {
+    /**
+     * Validation error to be displayed above the field.
+     */
+    error?: ReactNode;
+    /**
+     * Validation errors to be displayed above the field, an array of validation messages to be displayed in `IressValidationSummary`.
+     */
+    errorMessages?: ValidationMessageObj[];
+    /**
+     * If true, the supplementary area will be displayed with a border to distinguish it from other fields.
+     */
+    multipleFields?: boolean;
+    /**
+     * Supplementary content to be displayed below the field. Is only shown when the field is not in an error state.
+     */
+    supplementary?: ReactNode;
+}
+export declare const FieldFooter: ({ className, "data-testid": dataTestId, error, errorMessages, multipleFields, supplementary, ...restProps }: FieldFooterProps) => import("react/jsx-runtime").JSX.Element | null;

package/dist/src/components/Field/components/FieldHint.d.ts

@@ -0,0 +1,27 @@
+import { ReactNode } from 'react';
+export interface FieldHintProps {
+    /**
+     * The hint content to display
+     */
+    hint: ReactNode;
+    /**
+     * Whether the field is in horizontal mode
+     */
+    horizontal?: boolean;
+    /**
+     * Whether the label is hidden
+     */
+    hiddenLabel?: boolean;
+    /**
+     * Data test ID for the hint element
+     */
+    dataTestId?: string;
+    /**
+     * The label content to wrap (only used in horizontal mode)
+     */
+    children: ReactNode;
+}
+export declare const FieldHint: ({ hint, horizontal, hiddenLabel, dataTestId, children, }: FieldHintProps) => import("react/jsx-runtime").JSX.Element;
+export declare const FieldHintIcon: ({ hint }: {
+    hint: ReactNode;
+}) => import("react/jsx-runtime").JSX.Element;

package/dist/src/components/Field/helpers/getUniqueItemsByKey.d.ts

@@ -0,0 +1 @@
+export declare const getUniqueItemsByKey: <T = Record<string, unknown>>(array: T[], key: keyof T) => T[];

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

@@ -0,0 +1,4 @@
+export * from './Field';
+export * from './Field.styles';
+export * from './FieldGroup/FieldGroup';
+export * from './FieldGroup/FieldGroup.styles';

package/dist/src/components/Field/meta/Thumbnail.d.ts

@@ -0,0 +1,2 @@
+declare const Thumbnail: () => import("react/jsx-runtime").JSX.Element;
+export default Thumbnail;

package/dist/src/components/Field/meta/index.d.ts

@@ -0,0 +1,7 @@
+declare const _default: {
+    heading: string;
+    href: string;
+    tags: string[];
+    Thumbnail: import('react').LazyExoticComponent<() => import("react/jsx-runtime").JSX.Element>;
+};
+export default _default;

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

@@ -0,0 +1,75 @@
+import { ReactElement, ReactNode, ForwardedRef } from 'react';
+import { IressPopoverProps } from '../Popover';
+import { IressSelectMenuProps } from '../RichSelect';
+import { AutocompleteSearchHookProps, AutocompleteSearchHookReturn } from '../Autocomplete';
+import { IressInputProps } from '../Input';
+import { ControlledValue } from '../../hooks/useControlledState';
+import { IressHTMLAttributes, LabelValueMeta } from '../../interfaces';
+export interface IressFilterProps<TMultiple extends boolean = false> extends Omit<IressHTMLAttributes, 'defaultValue' | 'onChange'>, Omit<AutocompleteSearchHookProps, 'query'>, Pick<IressSelectMenuProps, 'limitMobile' | 'limitDesktop'> {
+    /**
+     * Value of selected option for uncontrolled filter.
+     */
+    defaultValue?: ControlledValue<LabelValueMeta, TMultiple>;
+    /**
+     * Customise the searchable `IressInput` props for your needs.
+     * @default { clearable: true, prepend: <IressIcon name="search" /> }
+     */
+    inputProps?: Pick<IressInputProps, 'append' | 'clearable' | 'placeholder' | 'prepend'>;
+    /**
+     * Label to display in the activator button.
+     */
+    label: ReactNode;
+    /**
+     * Multi-select mode. When `true`, multiple options can be selected.
+     */
+    multiSelect?: TMultiple;
+    /**
+     * Emitted when the value changes.
+     */
+    onChange?: (selected?: ControlledValue<LabelValueMeta, TMultiple>) => void;
+    /**
+     * Emitted when the value is reset.
+     */
+    onReset?: () => void;
+    /**
+     * Customise the IressPopover props for your needs.
+     * @default { align: 'bottom-start' }
+     */
+    popoverProps?: FilterPopoverProps;
+    /**
+     * When `true` a search field is shown to search for specific filter option(s).
+     */
+    searchable?: boolean;
+    /**
+     * Text to be displayed when no results are found from search. Ignored when `searchable` is `false`
+     */
+    searchNoResultsText?: ReactNode;
+    /**
+     * Text displayed next to label when two or more options are selected.
+     * @default {{numOptions}} selected
+     */
+    selectedOptionsText?: string;
+    /**
+     * Value of selected option for controlled filter.
+     */
+    value?: ControlledValue<LabelValueMeta, TMultiple>;
+    /**
+     * When `true`, a reset button will be shown above the options.
+     * If provided a string, it will be used as the reset button label.
+     */
+    visibleResetButton?: boolean | string;
+}
+export interface FilterResultsDescriptorProps extends Pick<IressFilterProps, 'searchNoResultsText'>, Pick<AutocompleteSearchHookReturn, 'loading' | 'results'>, Omit<IressHTMLAttributes, 'children' | 'className' | 'results'> {
+}
+export interface FilterRef {
+    element?: HTMLDivElement;
+    clearSearch: () => void;
+    reset: () => void;
+}
+export interface FilterPopoverProps extends Pick<IressPopoverProps, 'align' | 'className' | 'container' | 'displayMode'> {
+    footer?: ReactNode;
+    header?: ReactNode;
+}
+export declare const IressFilter: <TMultiple extends boolean = false>(props: IressFilterProps<TMultiple> & {
+    ref?: ForwardedRef<FilterRef>;
+}) => ReactElement;

package/dist/src/components/Filter/Filter.styles.d.ts

@@ -0,0 +1,2 @@
+export declare const filter: import('../../styled-system/types').SlotRecipeRuntimeFn<"reset" | "root" | "popoverContent" | "optionList" | "noResults" | "chevron" | "searchInput" | "optionContent" | "optionMeta" | "optionMetaText", {}>;
+export type FilterVariants = Parameters<typeof filter>[0];

package/dist/src/components/Filter/components/FilterLabel.d.ts

@@ -0,0 +1,3 @@
+import { IressFilterProps } from '../Filter';
+export type FilterLabelProps<TMultiple extends boolean = false> = Pick<IressFilterProps<TMultiple>, 'label' | 'selectedOptionsText' | 'value'>;
+export declare const FilterLabel: <TMultiple extends boolean = false>({ label, selectedOptionsText, value, }: FilterLabelProps<TMultiple>) => import('react').ReactNode;

package/dist/src/components/Filter/components/FilterResetButton.d.ts

@@ -0,0 +1 @@
+export declare const FilterResetButton: import('react').ForwardRefExoticComponent<Omit<Omit<import('react').DetailedHTMLProps<import('react').ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement>, "ref">, keyof import('../../Button').InternalButtonProps<C, THref>> & import('../../Button').InternalButtonProps<undefined, undefined> & import('react').RefAttributes<HTMLButtonElement>>;

package/dist/src/components/Filter/components/FilterResultsDescriptor.d.ts

@@ -0,0 +1,15 @@
+import { ReactNode } from 'react';
+import { IressHTMLAttributes, LabelValueMeta } from '../../../interfaces';
+import { AutocompleteSearchHookReturn } from '../../Autocomplete';
+import { IressPopoverProps } from '../../Popover';
+export interface FilterResultsDescriptorProps extends Partial<Pick<AutocompleteSearchHookReturn, 'loading' | 'results'>>, Pick<IressPopoverProps, 'show'>, Omit<IressHTMLAttributes, 'children' | 'className' | 'results'> {
+    /**
+     * Text to be displayed when no results are found.
+     */
+    noResultsText?: ReactNode;
+    /**
+     * Value of selected option for controlled combobox.
+     */
+    value?: LabelValueMeta;
+}
+export declare const FilterResultsDescriptor: ({ loading, noResultsText, results, show, value, ...restProps }: FilterResultsDescriptorProps) => import("react/jsx-runtime").JSX.Element;

package/dist/src/components/Filter/components/FilterSearch.d.ts

@@ -0,0 +1,15 @@
+import { InputRef } from '../../Input/InputBase/InputBase';
+export declare const FilterSearch: import('react').ForwardRefExoticComponent<Omit<import('../../Input').InputBaseProps<undefined>, "defaultValue" | "onChange" | "value"> & {
+    alignRight?: boolean;
+    append?: import('react').ReactNode;
+    clearable?: boolean;
+    defaultValue?: string | number | undefined;
+    formatter?: ((value?: string | number | undefined) => string | number) | undefined;
+    inline?: boolean;
+    loading?: boolean | string;
+    onChange?: ((e: import('react').ChangeEvent<HTMLInputElement>, value?: string | number | undefined) => void) | undefined;
+    onClear?: ((e: import('react').ChangeEvent<HTMLInputElement>) => void) | undefined;
+    prepend?: import('react').ReactNode;
+    value?: string | number | undefined;
+    width?: import('../../../types').FormElementWidths;
+} & import('react').RefAttributes<InputRef>>;

package/dist/src/components/Filter/hooks/useFilterFlags.d.ts

@@ -0,0 +1,7 @@
+import { IressFilterProps } from '../Filter';
+import { AutocompleteSearchHookReturn } from '../../Autocomplete';
+export declare const useFilterFlags: ({ debouncedQuery, loading, results, searchable, visibleResetButton, }: Omit<AutocompleteSearchHookReturn, "clearError" | "error" | "stopSearch"> & Pick<IressFilterProps, "searchable" | "visibleResetButton">) => {
+    showHeader: string | boolean | undefined;
+    showNoResults: string | false;
+    showResults: boolean;
+};

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

@@ -0,0 +1 @@
+export * from './Filter';

package/dist/src/components/Filter/meta/Thumbnail.d.ts

@@ -0,0 +1,2 @@
+declare const Thumbnail: () => import("react/jsx-runtime").JSX.Element;
+export default Thumbnail;

package/dist/src/components/Filter/meta/index.d.ts

@@ -0,0 +1,7 @@
+declare const _default: {
+    heading: string;
+    href: string;
+    tags: string[];
+    Thumbnail: import('react').LazyExoticComponent<() => import("react/jsx-runtime").JSX.Element>;
+};
+export default _default;

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

@@ -0,0 +1,28 @@
+import { ResponsiveSizing } from '../../interfaces';
+import { ReactNode } from 'react';
+import { IressStyledProps } from '../../types';
+/**
+ * @deprecated IressHide has been deprecated.
+ * - Please use the `srOnly` prop on any component to show or hide content from screen readers.
+ * - Please use the `hide` prop on any component to show or hide content at different breakpoints.
+ */
+export interface IressHideProps extends IressStyledProps {
+    /**
+     * Content to hide.
+     */
+    children: ReactNode;
+    /**
+     * Content will be hidden on any screen sizes that are set to true.
+     */
+    hiddenOn: ResponsiveSizing<boolean>;
+    /**
+     * If true, the content will not be visible, but will be available to screen readers
+     */
+    visuallyHidden?: boolean;
+}
+/**
+ * @deprecated IressHide has been deprecated.
+ * - Please use the `srOnly` prop on any component to show or hide content from screen readers.
+ * - Please use the `hide` prop on any component to show or hide content at different breakpoints.
+ */
+export declare const IressHide: ({ children, hiddenOn, visuallyHidden, ...restProps }: IressHideProps) => import("react/jsx-runtime").JSX.Element;

package/dist/src/components/Hide/helpers/normaliseHideValues.d.ts

@@ -0,0 +1,2 @@
+import { ResponsiveSizing } from '../../../interfaces';
+export declare const normaliseHideValues: (values?: ResponsiveSizing<boolean>) => Record<string, boolean>;

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

@@ -0,0 +1 @@
+export * from './Hide';

package/dist/src/components/Hide/meta/Thumbnail.d.ts

@@ -0,0 +1,2 @@
+declare const Thumbnail: () => import("react/jsx-runtime").JSX.Element;
+export default Thumbnail;

package/dist/src/components/Hide/meta/index.d.ts

@@ -0,0 +1,7 @@
+declare const _default: {
+    heading: string;
+    href: string;
+    tags: string[];
+    Thumbnail: import('react').LazyExoticComponent<() => import("react/jsx-runtime").JSX.Element>;
+};
+export default _default;

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

@@ -0,0 +1,36 @@
+import { IressStyledProps } from '../../types';
+import { IconName } from '@fortawesome/fontawesome-common-types';
+export interface IressIconProps extends IressStyledProps<'span'> {
+    /**
+     * The name of the icon
+     */
+    name: IconName;
+    /**
+     * Adds screen reader text if the icon needs to be visible to screen reader users
+     */
+    screenreaderText?: string;
+    /**
+     * The icon set to be used:
+     * - `fal`: Font Awesome Light
+     * - `fab`: Font Awesome Brand
+     * @default 'fal'
+     */
+    set?: 'fal' | 'fab';
+    /**
+     * Amount of degrees to rotate the icon.
+     */
+    rotate?: 90 | 180 | 270;
+    /**
+     * Adds fixed width class for Font Awesome icons - fa-fw
+     */
+    fixedWidth?: boolean;
+    /**
+     * Flip the icon horizontally, vertically or both axes.
+     */
+    flip?: 'horizontal' | 'vertical' | 'both';
+    /**
+     * Accepts a numeric value for speed for one rotation.
+     */
+    spin?: 'half' | 1 | 2 | 3;
+}
+export declare const IressIcon: ({ className, fixedWidth, flip, name, rotate, screenreaderText, set, spin, ...restProps }: IressIconProps) => import("react/jsx-runtime").JSX.Element;