List

PRO

Styled list renderer supporting bullets, dashes, arrows, stars, numbers, tasks, and nested item support.

static output6 stylesnested

# Preview

task-tree demo

BOOTING PREVIEW

# Usage

import { List } from '@taracod/termui';

const list = new List({ style: 'bullet' });
console.log(list.render([
  'First item',
  { text: 'Second', children: [
    { text: 'Child A' },
    { text: 'Child B' },
  ]},
  'Third item',
]));

const tasks = new List({ style: 'task' });
console.log(tasks.render([
  { text: 'Setup', checked: true },
  { text: 'Build', checked: true },
  { text: 'Test', checked: false },
]));

# API

Prop	Type	Default	Description
style	ListStyle	bullet	bullet, dash, arrow, star, numbered, task
items	ListItem[]	required	Strings or nested list item objects
indent	number	2	Spaces to indent nested children
color	AnsiColor	blue	Marker color