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

    Function list

    • Creates an interactive single-selection List backed by a Blessed box.

      The adapter composes collection identity through FocusScope, selection through Selection, and viewport movement through ScrollArea. It supports Arrow Up/Down, Home/End, Page Up/Down, Enter, Space, row click, and mouse wheel.

      The component never calls screen.render(). Applications retain control of render batching after keyboard events, imperative operations, or setData.

      Type Parameters

      Parameters

      • options: ListOptions<TItem>

        Parent node, stateful data, and optional box settings.

      Returns ListHandle<TItem>

      Handle for focus, movement, selection, updates, and cleanup.