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

    Function renderList

    • Renders a bounded, terminal-cell-aware list viewport.

      Active, selected, and disabled states use text markers so they remain understandable without terminal color. This renderer is deterministic and does not import Blessed or retain interaction state.

      Type Parameters

      Parameters

      Returns string

      Plain text containing at most height rows.

      RangeError Thrown when dimensions or offset are not non-negative integers.

      renderList({
      activeId: 'build',
      height: 3,
      items: [
      { id: 'test', label: 'Run tests' },
      { id: 'build', label: 'Build package' },
      ],
      selectedId: 'test',
      width: 24,
      });