@engie-group/fluid-design-system/lib/shared/component-properties/components/input/properties.d.ts

The Fluid Design System is ENGIE’s open-source library to create, build and deliver ENGIE digital services in a more efficient way.

import { Scale, Variant } from '../../variations';
export declare const INPUT_SCALES: readonly ["sm", "md", "lg", "xl"];
export type InputScale = Extract<Scale, (typeof INPUT_SCALES)[number]>;
export declare const INPUT_LABEL_KIND: readonly ["static", "floating"];
export type InputLabelKind = (typeof INPUT_LABEL_KIND)[number];
export declare const INPUT_SUBSCRIPT_VARIANT: readonly ["error", "success"];
export type InputSubscriptVariant = Extract<Variant | 'error', (typeof INPUT_SUBSCRIPT_VARIANT)[number]>;
export type InputProperties = {
    /**
     * The text label for the input field.
     */
    label?: string;
    /**
     * The kind of label to be displayed.
     */
    labelKind?: InputLabelKind;
    /**
     * The size scale of the input.
     */
    scale?: InputScale;
    /**
     * Icon name to display alongside the input.
     */
    icon?: string;
    /**
     * Whether the input is in an invalid state.
     */
    invalid?: boolean;
    /**
     * Additional text displayed below the input field.
     */
    subscript?: string;
    /**
     * Style variant for the subscript text.
     */
    subscriptVariant?: InputSubscriptVariant;
    /**
     * Whether to show a clear button when input has value
     */
    clearable?: boolean;
    /**
     * Aria label for the clear input action button.
     */
    clearActionAriaLabel?: string;
    /**
     * Text to announce when password is visible.
     */
    passwordVisibleText?: string;
    /**
     * Text to announce when password is hidden.
     */
    passwordHiddenText?: string;
    /**
     * Aria label for the show password action button.
     */
    passwordShowActionAriaLabel?: string;
    /**
     * Aria label for the hide password action button.
     */
    passwordHideActionAriaLabel?: string;
};