Hex Core JS
    Preparing search index...

    Type Alias PasswordInputProps

    PasswordInputProps: {
        allowVisibility?: boolean;
        autoComplete?: string;
        autoFocus?: boolean;
        disabled?: boolean;
        id?: string;
        inputClassName?: string;
        invalid?: boolean;
        maxHashInputLength?: number;
        name?: string;
        onBlur?: () => void;
        onFocus?: () => void;
        placeholder?: string;
        setValue: (value: TextFieldValue) => void;
        sideEffect?: (v: TextFieldValue) => void;
        StrengthEstimator?: (props: PasswordStrengthEstimatorProps) => JSX.Element;
        value: TextFieldValue;
        visibilityButtonClassName?: string;
        withStrengthEstimator?: boolean;
    } & Pick<TextInputProps, "before" | "after" | "gap"> & Partial<
        ClassNameProps & StyleProps,
    >

    Type Declaration

    • OptionalallowVisibility?: boolean

      Indicates if a show/hide button should be included.

    • OptionalautoComplete?: string

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

    • OptionalautoFocus?: boolean

      Indicates if the input should be auto-focused.

    • Optionaldisabled?: boolean

      Indicates if the input is disabled.

    • Optionalid?: string

      The ID of the input.

    • OptionalinputClassName?: string

      CSS class name to give to the input.

    • Optionalinvalid?: boolean

      Indicates if the input is invalid.

    • OptionalmaxHashInputLength?: number

      The maximum length (in bytes) of data that will be used by the hashing algorithm. For example, most implementations of bcrypt have a max input length of 72 bytes meaning that passwords are only unique up to the first 72 bytes. Setting a maxHashInputLength causes the strength estimate of the password to ignore everything after the first maxHashInputLength bytes of the string.

    • 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.

    • OptionalStrengthEstimator?: (props: PasswordStrengthEstimatorProps) => JSX.Element

      A custom component for calculating and displaying password strenght estimates.

    • value: TextFieldValue

      The value of the input.

    • OptionalvisibilityButtonClassName?: string

      CSS class name to give to the visibility toggle button (if rendered).

    • OptionalwithStrengthEstimator?: boolean

      Indicates if a <PasswordStrengthEstimator> component should be included. Should be used, and only used when setting a password, not entering a password for authentication

    Settings

    Member Visibility