Hex Core JS
    Preparing search index...

    Type Alias TextInputProps

    TextInputProps: {
        allowLeadingWhitespace?: boolean;
        allowTrailingWhitespace?: boolean;
        autoComplete?: string;
        autoFocus?: boolean;
        cleanRawInput?: (value: string) => string;
        disabled?: boolean;
        format?: (value: TextFieldValue) => string;
        id?: string;
        inputMode?: InputMode;
        invalid?: boolean;
        name?: string;
        onBlur?: () => void;
        onFocus?: () => void;
        placeholder?: string;
        setValue: (value: TextFieldValue) => void;
        sideEffect?: (v: TextFieldValue) => void;
        type?: TextInputType;
        value: TextFieldValue;
    } & Pick<InputProps, "before" | "after" | "gap"> & Partial<
        ClassNameProps & StyleProps,
    >

    Type Declaration

    • OptionalallowLeadingWhitespace?: boolean

      Indicates whether the value can have leading whitespace. If not enabled, leading whitespace is trimmed on blur.

    • OptionalallowTrailingWhitespace?: boolean

      Indicates whether the value can have trailing whitespace. If not enabled, trailing whitespace is trimmed on blur.

    • OptionalautoComplete?: string

      Auto-complete option for the input (supports the usual HTML values).

    • OptionalautoFocus?: boolean

      Indicates if the input should be auto-focused.

    • OptionalcleanRawInput?: (value: string) => string

      A function to transform values input by the user before they are set as the value or shown in the input. Useful, for example, for restricting the allowed characters or controlling capitalization.

    • Optionaldisabled?: boolean

      Indicates if the input is disabled.

    • Optionalformat?: (value: TextFieldValue) => string

      A function to format the value into a standardized format. Only updates the value in the input on mount and blur.

    • Optionalid?: string

      The ID of the input.

    • OptionalinputMode?: InputMode

      Hints at the type of data that might be entered by the user while editing the element or its contents.

    • Optionalinvalid?: boolean

      Indicates if the input is invalid.

    • Optionalname?: string

      The name of the input.

    • OptionalonBlur?: () => void

      A callback function to call when focus is removed from the input.

    • OptionalonFocus?: () => void

      A callback function to call when the input becomes focused.

    • Optionalplaceholder?: string

      Placeholder text to display when the value is blank.

    • setValue: (value: TextFieldValue) => void

      A callback function to update the input value when a change happens.

    • OptionalsideEffect?: (v: TextFieldValue) => void

      A side effect function to call when the value changes as a result of user interaction with this input, and not external updates to the field value.

    • Optionaltype?: TextInputType

      The type of the text input.

    • value: TextFieldValue

      The value of the input.

    Settings

    Member Visibility