Skip to content

useListState

widgetsdata

Hook that creates a fresh ListState

Installation

$ bunx termuijs add use-list-state

Copies the source into src/components/use-list-state/ and installs @termuijs/widgets.

Usage

ts
import { useListState } from '@termuijs/widgets'
ts
const items = [
  { id: '001', label: 'item-alpha', value: 80 },
  { id: '002', label: 'item-beta',  value: 60 },
]

<useListState items={items} />

API Reference

useListState

PropTypeDefaultDescription
itemsT[]requiredData rows
columnsColumn[]requiredColumn definitions
onSelect(item: T) => voidRow select handler
loadingbooleanfalseLoading state
#data#use-list-state