Skip to content

OrderedList

widgetsdisplay

OrderedList: renders a numbered list with optional nesting

Installation

$ bunx termuijs add ordered-list

Copies the source into src/components/ordered-list/ and installs @termuijs/core, @termuijs/widgets.

Usage

ts
import { OrderedList } from '@termuijs/widgets'
ts
new OrderedList(items: OrderedListItem[], style: Partial<Style> = {}, opts: OrderedListOptions = {},)

API Reference

OrderedList

PropTypeRequiredDescription
itemsOrderedListItem[]required
indentnumberoptionalIndent width per level
style'1.' | 'a.' | 'i.'optionalNumbering style: '1.' for arabic, 'a.' for lowercase alpha, 'i.' for lowercase roman
#display#ordered-list