@iress-oss/ids-components 5.16.0 → 6.0.0-alpha.0

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

@@ -1,70 +0,0 @@
-import { ReactNode } from 'react';
-import { IressHTMLAttributes } from '../../interfaces';
-import { FormControlValue } from '../../types';
-import { IressCheckboxProps } from '../../main';
-export interface IressCheckboxGroupProps extends Omit<IressHTMLAttributes, 'defaultValue' | 'onChange'> {
-    /**
-     * Content to be displayed inside the group, usually multiple `IressCheckbox`.
-     */
-    children?: ReactNode;
-    /**
-     * Value of checkbox group when in uncontrolled mode.
-     */
-    defaultValue?: FormControlValue | FormControlValue[];
-    /**
-     * Hides the checkbox controls to allow the creation of custom checkboxes.
-     */
-    hiddenCheckbox?: boolean;
-    /**
-     * Sets which of the block / inline layout options apply.
-     * @default 'stack'
-     */
-    layout?: CheckboxGroupLayout | CheckboxGroupLayouts;
-    /**
-     * Name to be applied to all checkboxes in the group.
-     */
-    name?: string;
-    /**
-     * Called with collated new value when a user toggles one of its children checkboxes.
-     */
-    onChange?: (value?: FormControlValue[]) => void;
-    /**
-     * Renders the group in a read-only state.
-     */
-    readonly?: boolean;
-    /**
-     * Value of checkbox group when in controlled mode.
-     */
-    value?: FormControlValue | FormControlValue[];
-    /**
-     * Add the button-like border and padding to checkbox when `touch` is true.
-     */
-    touch?: boolean;
-}
-export interface IressCheckboxItemsProps extends Omit<IressCheckboxGroupProps, 'onChange'> {
-    checkedValues: FormControlValue[];
-    onChange?: (newValue: FormControlValue) => void;
-}
-/**
- * @deprecated The CheckboxGroupLayout enum will be removed in future versions of IDS. Please use the value directly.
- */
-export declare enum CheckboxGroupLayout {
-    Block = "block",
-    Full = "full",
-    Stack = "stack",
-    Inline = "inline"
-}
-export declare const CHECKBOX_GROUP_LAYOUTS: readonly ["stack", "block", "inline", "full"];
-export type CheckboxGroupLayouts = (typeof CHECKBOX_GROUP_LAYOUTS)[number];
-export interface CheckboxGroupRef {
-    input?: HTMLDivElement | null;
-    check: (checked: boolean) => void;
-    reset: () => void;
-    focus: () => void;
-    blur: () => void;
-}
-export type CheckboxGroupContextValue = Pick<IressCheckboxGroupProps, 'name' | 'hiddenCheckbox' | 'value' | 'readonly' | 'touch'> & Pick<IressCheckboxProps, 'onChange'>;
-export interface CheckboxGroupWithEnums extends React.ForwardRefExoticComponent<IressCheckboxGroupProps & React.RefAttributes<HTMLElement>> {
-    /** @deprecated The CheckboxGroupLayout enum will be removed in future versions of IDS. Please use the value directly. */
-    Layout: typeof CheckboxGroupLayout;
-}

package/dist/src/components/CheckboxGroup/CheckboxGroupContext.d.ts

@@ -1,2 +0,0 @@
-import { CheckboxGroupContextValue } from './CheckboxGroup.types';
-export declare const CheckboxGroupContext: import('react').Context<CheckboxGroupContextValue | undefined>;

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

@@ -1,11 +0,0 @@
-export declare const IressCheckboxStyles: CSSModuleClasses;
-export interface IressCheckboxMarkProps extends React.HTMLAttributes<HTMLOrSVGElement> {
-    /**
-     * Checked status of the checkbox mark
-     */
-    checked?: boolean;
-    /**
-     * Indeterminate status of the checkbox mark
-     */
-    indeterminate?: boolean;
-}

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

@@ -1,78 +0,0 @@
-import { IressHTMLAttributes, ResponsiveSizing } from '../../interfaces';
-export interface IressColProps extends IressHTMLAttributes<HTMLDivElement> {
-    /**
-     * Individual alignment of column
-     */
-    alignSelf?: ColAlignSelf | ColAlignSelfs;
-    /**
-     * Any content you would like to be contained in a column.
-     */
-    children?: React.ReactNode;
-    /**
-     * Number of columns to offset.
-     */
-    offset?: ColOffset | ColOffsets | ResponsiveSizing<ColOffset | ColOffsets>;
-    /**
-     * Number of columns to span.
-     * @default auto
-     */
-    span?: ColSpan | ColSpans | ResponsiveSizing<ColSpan | ColSpans>;
-}
-export interface ColWithEnums extends React.FC<IressColProps> {
-    /** @deprecated IressCol.AlignSelf is now deprecated and will be removed in a future version. Please use the ColAlignSelfs type instead. */
-    AlignSelf: typeof ColAlignSelf;
-    /** @deprecated IressCol.Offset is now deprecated and will be removed in a future version. Please use the ColOffsets type instead. */
-    Offset: typeof ColOffset;
-    /** @deprecated IressCol.AlignSpanSelf is now deprecated and will be removed in a future version. Please use the ColSpans type instead. */
-    Span: typeof ColSpan;
-}
-export declare enum ColCssClass {
-    AlignSelf = "iress--align-self",
-    Base = "iress-u-col",
-    Offset = "iress--offset",
-    Span = "iress--span"
-}
-/** @deprecated ColAlignSelf is now deprecated and will be removed in a future version. Please use the ColAlignSelfs type instead. */
-export declare enum ColAlignSelf {
-    Start = "start",
-    End = "end",
-    Center = "center",
-    Stretch = "stretch"
-}
-export declare const COL_ALIGN_SELFS: readonly ["start", "end", "center", "stretch"];
-export type ColAlignSelfs = (typeof COL_ALIGN_SELFS)[number];
-/** @deprecated ColSpan is now deprecated and will be removed in a future version. Please use the ColSpans type instead. */
-export declare enum ColSpan {
-    Auto = "auto",
-    One = "1",
-    Two = "2",
-    Three = "3",
-    Four = "4",
-    Five = "5",
-    Six = "6",
-    Seven = "7",
-    Eight = "8",
-    Nine = "9",
-    Ten = "10",
-    Eleven = "11",
-    Twelve = "12"
-}
-export declare const COL_SPANS: readonly ["auto", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12];
-export type ColSpans = (typeof COL_SPANS)[number];
-/** @deprecated ColOffset is now deprecated and will be removed in a future version. Please use the ColOffsets type instead. */
-export declare enum ColOffset {
-    None = "0",
-    One = "1",
-    Two = "2",
-    Three = "3",
-    Four = "4",
-    Five = "5",
-    Six = "6",
-    Seven = "7",
-    Eight = "8",
-    Nine = "9",
-    Ten = "10",
-    Eleven = "11"
-}
-export declare const COL_OFFSETS: readonly ["0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11];
-export type ColOffsets = (typeof COL_OFFSETS)[number];

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

@@ -1,6 +0,0 @@
-import { ComboboxWithEnums } from './Combobox.types';
-/**
- * @deprecated IressCombobox is now deprecated and may be removed in a future version. It is highly recommended to use the new IressRichSelect component instead.
- * Although still in beta, IressRichSelect is likely the user experience we will be using going forward for advanced selects. Please use it in new development, and give feedback to the IDS team.
- */
-export declare const IressCombobox: ComboboxWithEnums;

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

@@ -1,55 +0,0 @@
-import { DisplayMode, FormElementWidth } from '../../enums';
-import { IressHTMLAttributes, IressInputHTMLAttributes, LabelValueMeta } from '../../interfaces';
-import { AutocompleteSearchHookReturn, IressAutocompleteProps } from '../Autocomplete';
-import { IressPopoverProps, IressSelectMenuProps } from '../../main';
-import { MutableRefObject, ReactNode, SyntheticEvent } from 'react';
-import { InputBaseElement, InputRef } from '../Input/InputBase/InputBase.types';
-export interface IressComboboxProps extends Omit<IressAutocompleteProps, 'defaultValue' | 'onChange' | 'value'> {
-    /**
-     * Value of selected option for uncontrolled combobox.
-     */
-    defaultValue?: LabelValueMeta;
-    /**
-     * Add additional props to the hidden input.
-     */
-    hiddenInputProps?: Omit<IressInputHTMLAttributes, 'name' | 'required' | 'value'>;
-    /**
-     * Emitted when the value changes.
-     */
-    onChange?: (e?: SyntheticEvent<InputBaseElement>, value?: LabelValueMeta) => void;
-    /**
-     * Options data set, the available options that the user can select from.
-     */
-    options: LabelValueMeta[] | ((query: string) => Promise<LabelValueMeta[]>);
-    /**
-     * Value of selected option for controlled combobox.
-     */
-    value?: LabelValueMeta;
-}
-export interface ComboboxResultsProps extends IressSelectMenuProps, Pick<IressComboboxProps, 'noResultsText'> {
-    append: ReactNode;
-    prepend: ReactNode;
-    dataTestId?: string;
-    showNoResults: boolean;
-    showResults: boolean;
-}
-export interface ComboboxHiddenInputProps extends IressInputHTMLAttributes, Pick<IressComboboxProps, 'hiddenInputProps'> {
-    dataTestId?: string;
-}
-export interface ComboboxResultsDescriptorProps extends Pick<IressComboboxProps, 'noResultsText' | 'value'>, Partial<Pick<AutocompleteSearchHookReturn, 'loading' | 'results'>>, Pick<IressPopoverProps, 'show'>, Omit<IressHTMLAttributes, 'children' | 'className' | 'results'> {
-}
-export interface ComboboxInlineCompletionHookProps extends Pick<AutocompleteSearchHookReturn, 'debouncedQuery' | 'results'>, Pick<IressComboboxProps, 'autoSelect' | 'debounceThreshold' | 'onChange'> {
-    queryRef: MutableRefObject<InputRef | null>;
-    setTypedQuery: (query: string) => void;
-    setValue: (value: LabelValueMeta) => void;
-}
-export interface ComboboxInlineCompletionHookReturn {
-    highlightQueryByActiveIndex: (activeIndex: number | null) => void;
-    setKeyPressed: (e?: KeyboardEvent) => void;
-}
-export interface ComboboxWithEnums extends React.ForwardRefExoticComponent<IressComboboxProps & React.RefAttributes<HTMLInputElement>> {
-    /** @deprecated IressCombobox.DisplayMode enum is now deprecated and will be removed in a future version. Please use the value directly instead. */
-    DisplayMode: typeof DisplayMode;
-    /** @deprecated IressCombobox.Width enum is now deprecated and will be removed in a future version. Please use the value directly instead. */
-    Width: typeof FormElementWidth;
-}

package/dist/src/components/Combobox/MultiCombobox/MultiCombobox.d.ts

@@ -1,6 +0,0 @@
-import { IressMultiComboboxProps } from './MultiCombobox.types';
-/**
- * @deprecated IressMultiCombobox is now deprecated and may be removed in a future version. Please use the new IressRichSelect component instead, with multiSelect set to true.
- * Although still in beta, IressRichSelect is likely the user experience we will be using going forward for rich selects. Please use it in new development, and give feedback to the IDS team.
- */
-export declare const IressMultiCombobox: import('react').ForwardRefExoticComponent<IressMultiComboboxProps & import('react').RefAttributes<HTMLInputElement>>;

package/dist/src/components/Combobox/MultiCombobox/MultiCombobox.types.d.ts

@@ -1,27 +0,0 @@
-import { InputBaseElement, LabelValueMeta } from '../../../main';
-import { IressComboboxProps } from '../Combobox.types';
-import { SyntheticEvent } from 'react';
-export interface IressMultiComboboxProps extends Omit<IressComboboxProps, 'defaultValue' | 'onChange' | 'value'> {
-    /**
-     * Value of selected option for uncontrolled combobox.
-     */
-    defaultValue?: LabelValueMeta[];
-    /**
-     * The number of select options before the view switches to a single aggregate tag.
-     * @default 4
-     */
-    multiOptionTagLimit?: number;
-    /**
-     * Emitted when the value changes.
-     */
-    onChange?: (e?: SyntheticEvent<InputBaseElement>, value?: LabelValueMeta[]) => void;
-    /**
-     * Text displayed next to tag count in tag when tag limit is exceeded.
-     * @default options selected
-     */
-    selectedOptionsTagText?: string;
-    /**
-     * Value of selected option for controlled combobox.
-     */
-    value?: LabelValueMeta[];
-}

package/dist/src/components/Combobox/components/ComboboxHiddenInput.d.ts

@@ -1,2 +0,0 @@
-import { ComboboxHiddenInputProps } from '../Combobox.types';
-export declare const ComboboxHiddenInput: import('react').ForwardRefExoticComponent<ComboboxHiddenInputProps & import('react').RefAttributes<HTMLInputElement>>;

package/dist/src/components/Combobox/components/ComboboxResults.d.ts

@@ -1,2 +0,0 @@
-import { ComboboxResultsProps } from '../Combobox.types';
-export declare const ComboboxResults: ({ append, dataTestId, noResultsText, prepend, showNoResults, showResults, ...restProps }: ComboboxResultsProps) => import("react/jsx-runtime").JSX.Element;

package/dist/src/components/Combobox/components/ComboboxResultsDescriptor.d.ts

@@ -1,2 +0,0 @@
-import { ComboboxResultsDescriptorProps } from '../Combobox.types';
-export declare const ComboboxResultsDescriptor: ({ loading, noResultsText, results, show, value, ...restProps }: ComboboxResultsDescriptorProps) => import("react/jsx-runtime").JSX.Element;

package/dist/src/components/Combobox/hooks/useComboboxFlags.d.ts

@@ -1,5 +0,0 @@
-import { AutocompleteSearchHookReturn } from '../../../main';
-export declare const useComboboxFlags: ({ debouncedQuery, loading, results, }: Omit<AutocompleteSearchHookReturn, "clearError" | "error" | "stopSearch">) => {
-    showResults: boolean;
-    showNoResults: boolean;
-};

package/dist/src/components/Combobox/hooks/useComboboxInlineCompletion.d.ts

@@ -1,2 +0,0 @@
-import { ComboboxInlineCompletionHookProps, ComboboxInlineCompletionHookReturn } from '../../../main';
-export declare const useComboboxInlineCompletion: ({ autoSelect, debouncedQuery, debounceThreshold, onChange, queryRef, results, setTypedQuery, setValue, }: ComboboxInlineCompletionHookProps) => ComboboxInlineCompletionHookReturn;

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

@@ -1,4 +0,0 @@
-export * from './Combobox.types';
-export * from './Combobox';
-export * from './MultiCombobox/MultiCombobox.types';
-export * from './MultiCombobox/MultiCombobox';

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

@@ -1,15 +0,0 @@
-import { IressHTMLAttributes } from '../../interfaces';
-export interface IressContainerProps extends IressHTMLAttributes<HTMLDivElement> {
-    /**
-     * Any content you would like to be contained. Best used with `IressRow` and `IressCol`.
-     */
-    children?: React.ReactNode;
-    /**
-     * Container stretches to fill the width of the browser window if true.
-     */
-    fluid?: boolean;
-}
-export declare enum ContainerCssClass {
-    Base = "iress-u-container",
-    Fluid = "iress--fluid"
-}

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

@@ -1,17 +0,0 @@
-import { GutterSizes } from '../../types';
-import { IressHTMLAttributes } from '../../interfaces';
-export interface IressDividerProps extends IressHTMLAttributes<HTMLHRElement> {
-    /**
-     * Sets gutter of the divider.
-     */
-    gutter?: GutterSizes;
-    /**
-     * Change to a vertical divider.
-     */
-    vertical?: boolean;
-}
-export declare enum DividerCssClass {
-    Base = "iress-u-divider",
-    Gutter = "iress--gutter",
-    Vertical = "iress--vertical"
-}

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

@@ -1,39 +0,0 @@
-import { ReactNode } from 'react';
-import { IressHTMLAttributes } from '../../interfaces';
-export interface IressExpanderProps extends Omit<IressHTMLAttributes, 'onChange'> {
-    /**
-     * The element used to activate the expandable container.
-     */
-    activator: ReactNode;
-    /**
-     * Contents that will be expanded/collapsed when the expander is activated.
-     */
-    children?: ReactNode;
-    /**
-     * Emitted when the open state changes.
-     */
-    onChange?: (newValue: ExpanderActivatorClickEventDetail) => void;
-    /**
-     * Controls the display mode of the activator element. Can be Section, Heading or Link.
-     */
-    mode?: ExpanderMode | ExpanderModes;
-    /**
-     * When true the expandable container will be visible and the activator will display as open.
-     */
-    open?: boolean;
-}
-export interface ExpanderActivatorClickEventDetail {
-    open?: boolean;
-}
-export declare const EXPANDER_MODES: readonly ["section", "heading", "link"];
-export type ExpanderModes = (typeof EXPANDER_MODES)[number];
-/** @deprecated ExpanderMode is now deprecated and will be removed in a future version. Please use the ExpanderModes type instead. **/
-export declare enum ExpanderMode {
-    Section = "section",
-    Heading = "heading",
-    Link = "link"
-}
-export interface ExpanderWithEnums extends React.FC<IressExpanderProps> {
-    /** @deprecated IressExpander.Mode is now deprecated and will be removed in a future version. Please use the value directly instead. **/
-    Mode: typeof ExpanderMode;
-}

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

@@ -1,34 +0,0 @@
-import { IressHTMLAttributes, ValidationMessageObj } from '../../interfaces';
-import { IressLabelProps } from '../Label';
-import { ReactNode } from 'react';
-import { LabelBaseProps } from '../Label/LabelBase/LabelBase.types';
-export interface IressFieldProps<T = HTMLDivElement, U extends LabelBaseProps = IressLabelProps> extends Omit<IressHTMLAttributes<T>, 'defaultValue'>, Pick<U, 'hiddenLabel' | 'htmlFor' | 'optional' | 'required'>, Omit<FieldAppendToLabelProps<U>, 'data-parent-testid'> {
-    /**
-     * The form control this field is related to.
-     */
-    children?: React.ReactNode;
-    /**
-     * Text to be displayed in the label.
-     **/
-    label: ReactNode;
-    /**
-     * Renders the group in a read-only state (no asterisk symbol).
-     */
-    readOnly?: boolean;
-}
-export type FieldLegendProps = Omit<LabelBaseProps<'legend', IressHTMLAttributes<'legend'>>, 'as'>;
-export interface FieldAppendToLabelProps<T extends LabelBaseProps = IressLabelProps> extends Pick<T, 'hiddenLabel'> {
-    /**
-     * 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[];
-    /**
-     * Text to be displayed as supporting field description.
-     */
-    hint?: React.ReactNode;
-    'data-parent-testid'?: string;
-}

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

@@ -1,15 +0,0 @@
-import { FieldLegendProps, IressFieldProps } from '../../../main';
-export interface IressFieldGroupProps extends Omit<IressFieldProps<HTMLFieldSetElement, FieldLegendProps>, 'htmlFor'> {
-    /**
-     * Should contain multiple `IressField`, or other elements supported in field group such as `IressButton`.
-     */
-    children?: React.ReactNode;
-    /**
-     * Displays multiple children inline rather than stacked, with a small gap.
-     */
-    inline?: boolean;
-    /**
-     * Displays multiple children inline and removes column gap.
-     */
-    join?: boolean;
-}

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

@@ -1,2 +0,0 @@
-import { FieldAppendToLabelProps } from '../Field.types';
-export declare const FieldAppendToLabel: ({ error, errorMessages, hiddenLabel, hint, "data-parent-testid": parentTestId, }: FieldAppendToLabelProps) => import("react/jsx-runtime").JSX.Element;

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

@@ -1,2 +0,0 @@
-import { FieldLegendProps } from '../Field.types';
-export declare const FieldLegend: (props: FieldLegendProps) => import("react/jsx-runtime").JSX.Element;

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

@@ -1,71 +0,0 @@
-import { IressHTMLAttributes, LabelValueMeta } from '../../interfaces';
-import { IressInputProps } from '../Input';
-import { IressPopoverProps } from '../Popover';
-import { IressSelectMenuProps } from '../RichSelect';
-import { AutocompleteSearchHookProps, AutocompleteSearchHookReturn } from '../../main';
-import { ReactNode } from 'react';
-export interface IressFilterProps extends Omit<IressHTMLAttributes, 'defaultValue' | 'onChange'>, Omit<AutocompleteSearchHookProps, 'query'>, Pick<IressSelectMenuProps, 'limitMobile' | 'limitDesktop'> {
-    /**
-     * Value of selected option for uncontrolled filter.
-     */
-    defaultValue?: LabelValueMeta | LabelValueMeta[];
-    /**
-     * Customise the searchable `IressInput` props for your needs.
-     * @default { clearable: true, prepend: <IressIcon name="search" />, watermark: true }
-     */
-    inputProps?: Pick<IressInputProps, 'append' | 'clearable' | 'placeholder' | 'prepend' | 'watermark'>;
-    /**
-     * Label to display in the activator button.
-     */
-    label: ReactNode;
-    /**
-     * Multi-select mode. When `true`, multiple options can be selected.
-     */
-    multiSelect?: boolean;
-    /**
-     * Emitted when the value changes.
-     */
-    onChange?: (selected?: LabelValueMeta | LabelValueMeta[]) => 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?: LabelValueMeta | LabelValueMeta[];
-    /**
-     * 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'> {
-    append?: ReactNode;
-    prepend?: ReactNode;
-}

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

@@ -1,11 +0,0 @@
-import { FieldValues, useForm, useFormContext, useWatch } from 'react-hook-form';
-import { FormRef, IressFormProps } from './Form.types';
-declare const ForwardedForm: <T extends FieldValues>(props: IressFormProps<T> & {
-    ref?: React.Ref<FormRef<T>>;
-}) => React.ReactElement;
-export declare const IressForm: typeof ForwardedForm & {
-    useForm: typeof useForm;
-    useWatch: typeof useWatch;
-    useFormContext: typeof useFormContext;
-};
-export {};