blessed-components - v1.20.0
    Preparing search index...

    Interface PasswordFieldData

    Stateful data accepted by the Blessed passwordField adapter.

    interface PasswordFieldData {
        characters?: PasswordFieldCharacters;
        defaultReveal?: boolean;
        defaultValue?: string;
        disabled?: boolean;
        error?: string;
        hint?: string;
        label: string;
        onRevealChange?: (reveal: boolean) => void;
        onSubmit?: (value: string) => void;
        onValueChange?: (value: string) => void;
        placeholder?: string;
        reveal?: boolean;
        required?: boolean;
        value?: string;
    }
    Index

    Properties

    characters? defaultReveal? defaultValue? disabled? error? hint? label onRevealChange? onSubmit? onValueChange? placeholder? reveal? required? value?

    Properties

    characters?: PasswordFieldCharacters

    Character tokens used by the pure renderer.

    defaultReveal?: boolean

    Initial reveal state for uncontrolled reveal usage.

    defaultValue?: string

    Initial password value for uncontrolled usage.

    disabled?: boolean

    Whether focus and editing are unavailable.

    error?: string

    Error text. When present it takes precedence over hint.

    hint?: string

    Hint text shown when no error is present.

    label: string

    Field label.

    onRevealChange?: (reveal: boolean) => void

    Called when reveal state changes through the imperative API or shortcut.

    onSubmit?: (value: string) => void

    Called when the user or imperative API requests a submitted value.

    onValueChange?: (value: string) => void

    Called after user or imperative edits request a value change.

    placeholder?: string

    Placeholder shown when value is empty.

    reveal?: boolean

    Controlled reveal state.

    required?: boolean

    Whether the label should include a required indicator.

    value?: string

    Controlled password value.

    Settings

    Member Visibility

    On This Page

    Properties