$ List

static output6 styles

Styled list renderer supporting 6 styles (bullet, dash, arrow, star, numbered, task) with nested item support.

# Preview

list demo

Bullet list with nesting:

● First item

● Second with children

○ Child A

○ Child B

● Third item

Task list:

✔ Set up project

✔ Write components

○ Add tests

○ Deploy

Numbered list:

1. Clone the repository

2. Install dependencies

3. Run the showcase

4. Start building!

Other styles:

▸ arrow ★ star ─ dash a) letter

# Usage

example.ts

import { List } from "@vr_patel/tui";

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

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

// Also: "numbered", "letter", "arrow", "star", "dash"

# API

Prop	Type	Default	Description
style	ListStyle	"bullet"	bullet \| dash \| arrow \| star \| numbered \| letter \| task
indent	number	2	Spaces per nesting level
bulletColor	string	fg.cyan	Color for bullet characters
checkedColor	string	fg.green	Color for checked task items
uncheckedColor	string	fg.gray	Color for unchecked task items