@iress-oss/ids-components 5.20.2 → 5.20.5

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

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

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

@@ -0,0 +1,2 @@
+import { IressFieldProps } from './Field.types';
+export declare const IressField: ({ children, className, "data-testid": dataTestId, error, errorMessages, hiddenLabel, hint, htmlFor: htmlForProp, label, optional, required, readOnly, ...restProps }: IressFieldProps) => import("react/jsx-runtime").JSX.Element;

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

@@ -0,0 +1,34 @@
+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.d.ts

@@ -0,0 +1,2 @@
+import { IressFieldGroupProps } from './FieldGroup.types';
+export declare const IressFieldGroup: ({ children, className, "data-testid": dataTestId, error, errorMessages, hiddenLabel, hint, inline, join, label, optional, required, ...restProps }: IressFieldGroupProps) => import("react/jsx-runtime").JSX.Element;

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

@@ -0,0 +1,15 @@
+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

@@ -0,0 +1,2 @@
+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

@@ -0,0 +1,2 @@
+import { FieldLegendProps } from '../Field.types';
+export declare const FieldLegend: (props: FieldLegendProps) => 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.types';
+export * from './Field';
+export * from './FieldGroup/FieldGroup';
+export * from './FieldGroup/FieldGroup.types';

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

@@ -0,0 +1,2 @@
+import { IressFilterProps, FilterRef } from './Filter.types';
+export declare const IressFilter: import('react').ForwardRefExoticComponent<IressFilterProps & import('react').RefAttributes<FilterRef>>;

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

@@ -0,0 +1,71 @@
+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/Filter/components/FilterLabel.d.ts

@@ -0,0 +1,2 @@
+import { IressFilterProps } from '../Filter.types';
+export declare const FilterLabel: ({ label, selectedOptionsText, value, }: Pick<IressFilterProps, "label" | "selectedOptionsText" | "value">) => import('react').ReactNode;

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

@@ -0,0 +1,2 @@
+import { ButtonRef, IressButtonProps } from '../../../main';
+export declare const FilterResetButton: import('react').ForwardRefExoticComponent<IressButtonProps & import('react').RefAttributes<ButtonRef>>;

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

@@ -0,0 +1,3 @@
+import { IressInputProps } from '../../../main';
+import { InputRef } from '../../Input/InputBase/InputBase.types';
+export declare const FilterSearch: import('react').ForwardRefExoticComponent<IressInputProps<string | number> & import('react').RefAttributes<InputRef>>;

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

@@ -0,0 +1,7 @@
+import { AutocompleteSearchHookReturn } from '../../../main';
+import { IressFilterProps } from '../Filter.types';
+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,2 @@
+export * from './Filter.types';
+export * from './Filter';

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

@@ -0,0 +1,11 @@
+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 {};

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

@@ -0,0 +1,188 @@
+import { GutterSize, HeadingLevel } from '../../enums';
+import { IressFormHTMLAttributes } from '../../interfaces';
+import { DefaultValues, FieldValues, SubmitErrorHandler, UseControllerProps, UseFormProps, UseFormReturn } from 'react-hook-form';
+import { ReactNode } from 'react';
+import { GutterSizes } from '../../types';
+type GenericFieldProps<T extends FieldValues> = UseControllerProps<T>;
+export type CombinedProps<T extends FieldValues> = GenericFieldProps<T> & UseControllerProps<T> & FieldControllerProps;
+/** @deprecated FormDefaultText is deprecated and will be removed in a future version. Please use the value directly instead. */
+export declare enum FormDefaultText {
+    InvalidValue = "{{fieldName}} value is not valid",
+    InvalidFormat = "{{fieldName}} is not in a valid format",
+    RangeOverflow = "{{fieldName}} must be {{attrValue}} or lower",
+    RangeUnderflow = "{{fieldName}} must be {{attrValue}} or more",
+    TooLong = "{{fieldName}} is too long. Must not exceed {{attrValue}} characters",
+    TooShort = "{{fieldName}} is too short. Must be at least {{attrValue}} characters long",
+    ValueMissing = "{{fieldName}} is a required field",
+    ErrorSummaryHeading = "There was a problem submitting this form"
+}
+export interface IressHookFormProps<T extends FieldValues, TContext = object> extends Omit<IressFormHTMLAttributes, 'defaultValue' | 'onSubmit' | 'onError'> {
+    /**
+     * Section to place error summary when the app is in control of validation.
+     */
+    alert?: React.ReactNode;
+    /**
+     * The content of the form, usually multiple `IressFormField` or `IressFormFieldset` components.
+     */
+    children?: React.ReactNode;
+    /**
+     * Content to be displayed in the title of the error summary.
+     * @default <h3>There was a problem submitting this form</h3>
+     */
+    errorSummaryHeading?: ReactNode;
+    /**
+     * Text to be displayed in the title of the error summary.
+     * @deprecated Use errorSummaryHeading instead.
+     */
+    errorSummaryHeadingText?: string;
+    /**
+     * Level of error summary heading for semantics.
+     * @deprecated Use errorSummaryHeading instead.
+     */
+    errorSummaryHeadingLevel?: HeadingLevel;
+    /**
+     * Sets the amount of spacing between the heading, alert, children and footer.
+     * @default 'lg'
+     */
+    gutter?: GutterSize | GutterSizes;
+    /**
+     * Sets which of the block / inline layout options apply.
+     * @default false
+     */
+    hiddenErrorSummary?: boolean;
+    /**
+     * React hook form instance.
+     */
+    form: UseFormReturn<T, TContext>;
+    /**
+     * Emitted when any field has an error.
+     * Called after the first submit if any errors are recorded, and from then on when any value changes.
+     *
+     * [Learn more](https://react-hook-form.com/docs/useform/handlesubmit)
+     */
+    onError?: SubmitErrorHandler<T>;
+    /**
+     * Handler for when the submit method on the form is called after validation is passed.
+     *
+     * [Learn more](https://react-hook-form.com/docs/useform/handlesubmit)
+     */
+    onSubmit?: (data: T) => void;
+    /**
+     * Emitted when the form state is valid.
+     *
+     * [Learn more](https://react-hook-form.com/docs/useform/formstate)
+     */
+    onValidChange?: (isValid: boolean) => void;
+    /**
+     * If set to `true`, the summary will only update when the form is submitted, not on every field change.
+     * This is useful for performance reasons, especially in large forms.
+     * @default false
+     */
+    updateErrorSummaryOnSubmit?: boolean;
+}
+export interface IressFormProps<T extends FieldValues, TContext = object> extends Partial<Omit<UseFormProps<T, TContext>, 'disabled' | 'errors'>>, Omit<IressHookFormProps<T, TContext>, 'form'> {
+    /**
+     * This context object is mutable and will be injected into the `resolver`'s second argument (eg. [Yup](https://github.com/jquense/yup) validation's context object).
+     *
+     * [Learn more](https://react-hook-form.com/docs/useform#context)
+     */
+    context?: UseFormProps<T, TContext>['context'];
+    /**
+     * Display all validation errors or one at a time.
+     *
+     * [Learn more](https://react-hook-form.com/docs/useform#criteriaMode)
+     */
+    criteriaMode?: UseFormProps<T, TContext>['criteriaMode'];
+    /**
+     * Default values to be passed through when an input is unset.
+     *
+     * [Learn more](https://react-hook-form.com/docs/useform#defaultValues)
+     */
+    defaultValues?: DefaultValues<T>;
+    /**
+     * Delay error from appearing instantly.
+     *
+     * [Learn more](https://react-hook-form.com/docs/useform#delayError)
+     */
+    delayError?: UseFormProps<T, TContext>['delayError'];
+    /**
+     * React hook form instance from `useForm`, use if you need more control over the internal state.
+     *
+     * ```tsx
+     * const form = useForm();
+     * return <IressForm form={form} />;
+     * ```
+     */
+    form?: UseFormReturn<T, TContext>;
+    /**
+     * Configure the validation strategy **before** a user submits the form.
+     *
+     * [Learn more](https://react-hook-form.com/docs/useform#mode)
+     * @default onSubmit
+     */
+    mode?: UseFormProps<T, TContext>['mode'];
+    /**
+     * Progressive Enhancement only applicable for SSR framework.
+     * [Learn more](https://react-hook-form.com/docs/useform)
+     */
+    progressive?: UseFormProps<T, TContext>['progressive'];
+    /**
+     * This property is related to value update behaviors.
+     *
+     * [Learn more](https://react-hook-form.com/docs/useform#resetOptions)
+     */
+    resetOptions?: UseFormProps<T, TContext>['resetOptions'];
+    /**
+     * This function allows you to use any external validation library such as Yup, Zod, Joi, Vest, Ajv and many others.
+     *
+     * [Learn more](https://react-hook-form.com/docs/useform#resolver)
+     */
+    resolver?: UseFormProps<T, TContext>['resolver'];
+    /**
+     * Configure validation strategy when inputs with errors get re-validated **after** a user submits the form.
+     *
+     * [Learn more](https://react-hook-form.com/docs/useform#reValidateMode)
+     */
+    reValidateMode?: UseFormProps<T, TContext>['reValidateMode'];
+    /**
+     * When set to true, and the user submits a form that fails validation, focus is set on the first field with an error.
+     * By default, it is set based on the `hiddenErrorSummary` prop.
+     * - If hiddenErrorSummary is true, it will focus on the first field with an error.
+     * - If hiddenErrorSummary is false, it will focus on the error summary.
+     *
+     * [Learn more](https://react-hook-form.com/docs/useform#shouldFocusError)
+     */
+    shouldFocusError?: UseFormProps<T, TContext>['shouldFocusError'];
+    /**
+     * This config will enable browser native validation. It will also enable CSS selectors :valid and:invalid making styling inputs easier.
+     *
+     * [Learn more](https://react-hook-form.com/docs/useform#shouldUseNativeValidation)
+     */
+    shouldUseNativeValidation?: UseFormProps<T, TContext>['shouldUseNativeValidation'];
+    /**
+     * By default, an input value will be retained when input is removed. However, you can set `shouldUnregister` to `true` to `unregister` input during unmount.
+     *
+     * [Learn more](https://react-hook-form.com/docs/useform#shouldUnregister)
+     */
+    shouldUnregister?: UseFormProps<T, TContext>['shouldUnregister'];
+    /**
+     * The values prop will react to changes and update the form values, which is useful when your form needs to be updated by external state or server data.
+     *
+     * [Learn more](https://react-hook-form.com/docs/useform#values)
+     */
+    values?: UseFormProps<T, TContext>['values'];
+}
+export interface FormRef<T extends FieldValues> {
+    element?: HTMLFormElement;
+    api: UseFormReturn<T>;
+    reset: (values?: DefaultValues<T>) => void;
+    submit: () => void;
+}
+export interface FieldControllerProps {
+    error?: boolean;
+    formId?: string;
+    label?: string;
+    required?: boolean;
+    children?: React.ReactNode;
+}
+export {};

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

@@ -0,0 +1,8 @@
+import { IressFormProps } from './Form.types';
+import { FieldValues } from 'react-hook-form';
+export interface FormContextValue {
+    id: IressFormProps<FieldValues>['id'];
+    errorMessages: Record<keyof FieldValues, string | undefined>;
+    setErrorMessage: (name: keyof FieldValues, message?: string) => void;
+}
+export declare const FormContext: import('react').Context<FormContextValue | undefined>;

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

@@ -0,0 +1,7 @@
+import { FieldValues } from 'react-hook-form';
+import { IressFormFieldProps } from './FormField.types';
+/**
+ * A `IressField` wrapper that can show error message and label automatically inside an `IressForm`.
+ * It uses the `useController` hook from `react-hook-form` for form management.
+ */
+export declare const IressFormField: <TFieldValues extends FieldValues>({ control: controlProp, defaultValue, name, render, rules: withCustomRules, shouldUnregister, readOnly, ...fieldProps }: IressFormFieldProps<TFieldValues>) => import("react/jsx-runtime").JSX.Element;

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

@@ -0,0 +1,111 @@
+import { FieldValues, UseControllerProps, FieldPath, ControllerRenderProps, FieldPathValue, Control } from 'react-hook-form';
+import { IressFieldGroupProps, IressFieldProps } from '../../Field';
+import { ReactNode } from 'react';
+type OmittedFieldProps = 'children' | 'htmlFor' | 'inline' | 'inputMode' | 'join' | 'required';
+export interface CustomRuleWithMessage<T> {
+    value: T;
+    message: string;
+}
+export type CustomRules<T extends FieldValues = FieldValues> = UseControllerProps<T, FieldPath<T>>['rules'] & {
+    email?: boolean | string;
+    minDate?: Date | CustomRuleWithMessage<Date>;
+    maxDate?: Date | CustomRuleWithMessage<Date>;
+};
+export interface IressFormFieldProps<T extends FieldValues = FieldValues, TName extends FieldPath<T> = FieldPath<T>> extends Omit<IressFieldProps, OmittedFieldProps>, Omit<UseControllerProps<T, FieldPath<T>>, 'disabled' | 'shouldUnregister'> {
+    /**
+     * React Hook Form control object. It is used to register the field with the form.
+     * It is automatically provided when used inside an `IressForm`, but it can be overridden if you are using a custom form control.
+     *
+     * [Learn more](https://react-hook-form.com/ts#Control)
+     */
+    control?: Control<T>;
+    /**
+     * A default value for the field. Although this is provided here as it is part of the React Hook Form API, it is recommended to set the default value in the form's `defaultValues` prop, to ensure the form is correctly initialised.
+     */
+    defaultValue?: FieldPathValue<T, TName>;
+    /**
+     * Name of the field. It is used to identify the field in the form. It must be unique within the form.
+     */
+    name: FieldPath<T>;
+    /**
+     * Render function to provide the control for the field.
+     * To ensure the field is correctly registered with the form, the control must be passed as props to the rendered component.
+     * (eg. `render={field => <IressInput {...field} />}`)
+     */
+    render: (field: FormFieldRenderProps<T>) => ReactNode;
+    /**
+     * Validation rules, including: required, min, max, minLength, maxLength, pattern, validate
+     *
+     * [Learn more](https://react-hook-form.com/api/useform/register)
+     */
+    rules?: CustomRules<T>;
+    /**
+     * Input will be unregistered after unmount and defaultValues will be removed as well (it will not be stored in the form state).
+     * You can pass an object to keep some form state available after unregistering, such as dirty fields.
+     *
+     * [Learn more](https://react-hook-form.com/docs/usecontroller)
+     */
+    shouldUnregister?: boolean | {
+        keepDirty?: boolean;
+        keepTouched?: boolean;
+        keepIsValid?: boolean;
+        keepError?: boolean;
+    };
+    /**
+     * Text to be displayed instead of input field.
+     */
+    readOnly?: boolean;
+}
+export interface IressFormFieldsetProps<T extends FieldValues = FieldValues, TName extends FieldPath<T> = FieldPath<T>> extends Omit<IressFieldGroupProps, OmittedFieldProps>, Omit<UseControllerProps<T, FieldPath<T>>, 'disabled'> {
+    /**
+     * React Hook Form control object. It is used to register the field with the form.
+     * It is automatically provided when used inside an `IressForm`, but it can be overridden if you are using a custom form control.
+     *
+     * [Learn more](https://react-hook-form.com/ts#Control)
+     */
+    control?: Control<T>;
+    /**
+     * A default value for the field. Although this is provided here as it is part of the React Hook Form API, it is recommended to set the default value in the form's `defaultValues` prop, to ensure the form is correctly initialised.
+     */
+    defaultValue?: FieldPathValue<T, TName>;
+    /**
+     * Name of the field. It is used to identify the field in the form. It must be unique within the form.
+     */
+    name: FieldPath<T>;
+    /**
+     * Render function to provide the control for the field.
+     */
+    render: (field: FormFieldRenderProps<T>) => ReactNode;
+    /**
+     * Validation rules, including: required, min, max, minLength, maxLength, pattern, validate
+     *
+     * [Learn more](https://react-hook-form.com/api/useform/register)
+     */
+    rules?: CustomRules<T>;
+    /**
+     * Input will be unregistered after unmount and defaultValues will be removed as well (it will not be stored in the form state).
+     *
+     * [Learn more](https://react-hook-form.com/docs/usecontroller)
+     */
+    shouldUnregister?: boolean;
+}
+export interface FormFieldRenderProps<T extends FieldValues> extends ControllerRenderProps<T, FieldPath<T>> {
+    /**
+     * ID of the field. It is automatically generated based on the name of the field and its parent form.
+     */
+    id: string;
+}
+export declare enum FormFieldErrorMessages {
+    required = "Please fill out this field",
+    maxLength = "Please shorten this text to {{attrValue}} characters or less",
+    minLength = "Please lengthen this text to {{attrValue}} characters or more",
+    max = "Please enter a value less than or equal to {{attrValue}}",
+    min = "Please enter a value greater than or equal to {{attrValue}}",
+    minDate = "Please enter a date that is on or after {{attrValue}}",
+    maxDate = "Please enter a date that is on or before {{attrValue}}",
+    pattern = "Please match the requested format",
+    email = "Please enter a valid email address",
+    validate = "Please enter a valid value"
+}
+export type FormFieldErrorType = keyof typeof FormFieldErrorMessages;
+export {};

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

@@ -0,0 +1,7 @@
+import { FieldValues } from 'react-hook-form';
+import { IressFormFieldsetProps } from './FormField.types';
+/**
+ * A `IressFieldGroup` wrapper that can show error message and legend automatically inside an `IressForm`.
+ * It uses the `useController` hook from `react-hook-form` for form management.
+ */
+export declare const IressFormFieldset: <TFieldValues extends FieldValues>({ control, defaultValue, name, render, rules: withCustomRules, shouldUnregister, ...fieldGroupProps }: IressFormFieldsetProps<TFieldValues>) => import("react/jsx-runtime").JSX.Element;

package/dist/src/components/Form/FormField/helpers/getErrorTypeMessage.d.ts

@@ -0,0 +1,2 @@
+import { FormFieldErrorType } from '../FormField.types';
+export declare const getErrorTypeMessage: (message?: string, type?: FormFieldErrorType, rules?: Partial<Record<FormFieldErrorType, unknown>>, prefix?: string) => string;

package/dist/src/components/Form/FormField/helpers/transformCustomRulesToValidateRule.d.ts

@@ -0,0 +1,3 @@
+import { FieldPath, FieldValues, UseControllerProps } from 'react-hook-form';
+import { CustomRules } from '../FormField.types';
+export declare const transformCustomRulesToValidateRule: <T extends FieldValues = FieldValues>({ email, minDate: minDateRule, maxDate: maxDateRule, validate, ...defaultRules }: CustomRules<T>) => UseControllerProps<T, FieldPath<T>>["rules"];

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

@@ -0,0 +1,5 @@
+import { FieldValues } from 'react-hook-form';
+import { FormRef, IressHookFormProps } from '../Form.types';
+export declare const IressHookForm: <T extends FieldValues>(props: IressHookFormProps<T> & {
+    ref?: React.Ref<FormRef<T>>;
+}) => React.ReactElement;

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

@@ -0,0 +1,5 @@
+import { IressValidationSummaryProps } from '../../ValidationMessage';
+/**
+ * Validation summary messages based on the form context from react-hook-form
+ */
+export declare const FormValidationSummary: (props: Omit<IressValidationSummaryProps, "messages">) => import("react/jsx-runtime").JSX.Element;

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

@@ -0,0 +1,8 @@
+import { FormControlValue } from '../../../main';
+interface NoDefaultValueInFormsHookProps<T = FormControlValue> {
+    component: string;
+    defaultValue?: T;
+    message?: string;
+}
+export declare const useNoDefaultValueInForms: <T = FormControlValue>({ component, defaultValue, message, }: NoDefaultValueInFormsHookProps<T>) => void;
+export {};

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

@@ -0,0 +1,6 @@
+export * from './Form.types';
+export * from './Form';
+export * from './FormField/FormField';
+export * from './FormField/FormFieldset';
+export * from './FormField/FormField.types';
+export * from './HookForm/HookForm';

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

@@ -0,0 +1,10 @@
+import { ReactNode } from 'react';
+import { WithDataAttributes } from '../../interfaces';
+interface HeadingWithDeprecatedFallbackProps extends WithDataAttributes {
+    component: string;
+    heading?: ReactNode;
+    headingText?: string;
+    HeadingTag?: keyof HTMLElementTagNameMap;
+}
+export declare const HeadingWithDeprecatedFallback: ({ component, "data-testid": dataTestId, heading, headingText, HeadingTag, }: HeadingWithDeprecatedFallbackProps) => string | number | bigint | boolean | Iterable<ReactNode> | Promise<string | number | bigint | boolean | import('react').ReactPortal | import('react').ReactElement<unknown, string | import('react').JSXElementConstructor<any>> | Iterable<ReactNode> | null | undefined> | import("react/jsx-runtime").JSX.Element | null | undefined;
+export {};

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

@@ -0,0 +1,2 @@
+import { IressHideProps } from './Hide.types';
+export declare const IressHide: ({ children, hiddenOn, visuallyHidden, className, ...restProps }: IressHideProps) => import("react/jsx-runtime").JSX.Element;

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

@@ -0,0 +1,24 @@
+import { ResponsiveSizing } from '../../interfaces';
+import { ReactNode } from 'react';
+export interface IressHideProps extends React.HTMLAttributes<HTMLDivElement> {
+    /**
+     * 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;
+}
+export declare enum HideTypes {
+    VisuallyHidden = "VisuallyHidden",
+    TotallyHidden = "TotallyHidden"
+}
+export declare enum HideCssClass {
+    VisuallyHidden = "iress-sr-only",
+    TotallyHidden = "iress-hidden"
+}

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

@@ -0,0 +1,4 @@
+import { ResponsiveSizing } from '../../../main';
+import { HideCssClass } from '../Hide.types';
+export declare const composeHideClasses: (modifier: HideCssClass, values?: ResponsiveSizing<boolean>) => string[];
+export declare const normaliseHideValues: (values?: ResponsiveSizing<boolean>) => ResponsiveSizing<boolean>;

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

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

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

@@ -0,0 +1,2 @@
+import { IconWithEnums } from './Icon.types';
+export declare const IressIcon: IconWithEnums;