Skip to content

Breadcrumbs

widgetsdisplay

Breadcrumbs: renders a non-interactive path trail of segments with separators and truncation

Installation

$ bunx termuijs add breadcrumbs

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

Usage

ts
import { Breadcrumbs } from '@termuijs/widgets'
ts
new Breadcrumbs(segments: string[], style: Partial<Style> = {}, opts: BreadcrumbsOptions = {})

API Reference

Breadcrumbs

PropTypeRequiredDescription
segmentsstring[]required
separatorstringoptionalSeparator drawn between segments
activeColorColoroptionalColor of the last (current) segment
#display#breadcrumbs