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

    Interface BlessedComponentHandle<TData, TElement>

    Shared imperative contract implemented by Blessed component adapters.

    Adapters own one element but never own the parent screen. Imperative data updates do not call screen.render(), which lets applications batch them before flushing the terminal. Interactive adapters may render after direct keyboard or mouse input so focus and selection feedback is immediately visible.

    interface BlessedComponentHandle<
        TData,
        TElement extends blessed.Widgets.Node = blessed.Widgets.BoxElement,
    > {
        element: TElement;
        destroy(): void;
        setData(data: TData): void;
    }

    Type Parameters

    • TData

      Complete renderer input accepted by setData.

    • TElement extends blessed.Widgets.Node = blessed.Widgets.BoxElement

      Blessed element owned by the adapter.

    Hierarchy (View Summary)

    Index

    Properties

    Methods

    Properties

    element: TElement

    Underlying Blessed element available for standard element operations.

    Methods

    • Re-renders component content using complete replacement data.

      The element identity is preserved. Call screen.render() explicitly when one or more updates should become visible.

      Parameters

      Returns void