Skip to content

KeyValue

widgetsdata

KeyValue: aligned key: value pairs

Installation

$ bunx termuijs add key-value

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

Usage

ts
import { KeyValue } from '@termuijs/widgets'
ts
new KeyValue(pairs: Array<KeyValuePair> | Record<string, any>, style: Partial<Style> = {}, opts: KeyValueOptions = {},)

API Reference

KeyValue

PropTypeRequiredDescription
pairsArray<KeyValuePair> | Record<stringrequired
separatorstringoptionalSeparator between key and value (default: ': ')
keyColorimport('@termuijs/core').ColoroptionalColor for keys
valueColorimport('@termuijs/core').ColoroptionalColor for values
#data#key-value