Hex Core JS
    Preparing search index...

    Type Alias PasswordFieldProps<FV>

    PasswordFieldProps: Omit<FieldProps<FV, TextFieldValue>, "format" | "display"> & {
        allowVisibility?: boolean;
        Input?: (props: PasswordFieldInputProps) => JSX.Element | null;
        maxHashInputLength?: number;
        maxLength?: number;
        minLength?: number;
        minStrength?: 1 | 2 | 3 | 4;
        placeholder?: string;
        visibilityButtonClassName?: string;
        withStrengthEstimator?: boolean;
    } & Partial<ClassNameProps & StyleProps>

    Type Parameters

    Type Declaration

    • OptionalallowVisibility?: boolean

      Indicates if a show/hide button should be included.

    • OptionalInput?: (props: PasswordFieldInputProps) => JSX.Element | null

      The input component to use when editing.

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

    • OptionalmaxLength?: number

      Maximum length for values (validation).

    • OptionalminLength?: number

      Minimum length for values (validation).

    • OptionalminStrength?: 1 | 2 | 3 | 4

      Minimum strength for the entered password (validation).

    • Optionalplaceholder?: string

      Placeholder text to display in the input when the value is blank.

    • 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