Skip to content

Definition

widgetsdata

Definition: term + definition pairs, stacked vertically

Installation

$ bunx termuijs add definition

Copies the source into src/components/definition/ and installs @termuijs/core, @termuijs/widgets.

Usage

ts
import { Definition } from '@termuijs/widgets'
ts
new Definition(pairs: DefinitionPair[] | Record<string, string>, style: Partial<Style> = {}, opts: DefinitionOptions = {},)

API Reference

Definition

PropTypeRequiredDescription
pairsDefinitionPair[] | Record<stringrequired
indentnumberoptionalIndentation for definition lines (default: 2)
spacingbooleanoptionalBlank line between pairs (default: true)
termColorimport('@termuijs/core').ColoroptionalColor for term labels
definitionColorimport('@termuijs/core').ColoroptionalColor for definition text
#data#definition