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

    Interface PasswordFieldHandle

    Imperative handle returned by passwordField.

    interface PasswordFieldHandle {
        clear(): boolean;
        focus(): void;
        revealed(): boolean;
        setReveal(reveal: boolean): boolean;
        setValue(value: string): boolean;
        submit(): boolean;
        toggleReveal(): boolean;
        value(): string;
        element: TextboxElement;
        destroy(): void;
        setData(data: PasswordFieldData): void;
    }

    Hierarchy (View Summary)

    Index

    Properties

    element: TextboxElement

    Underlying Blessed element available for standard element operations.

    Methods

    • Sets an enabled password value and reports whether editing occurred.

      Parameters

      • value: string

      Returns boolean