Skip to content

Breadcrumb

A navigation trail/breadcrumb component for Ink 5. Shows the user’s current position in a hierarchy.

Install

Terminal window
npm install @matthesketh/ink-breadcrumb

Usage

import { Breadcrumb } from '@matthesketh/ink-breadcrumb';
<Breadcrumb path={['Dashboard', 'api-server', 'Logs']} />

Output: Dashboard › api-server › **Logs**

Props

PropTypeDefaultDescription
pathstring[]requiredBreadcrumb segments
separatorstring' › 'Separator between segments
activeColorstring'cyan'Colour of the last (active) item
inactiveColorstring'gray'Colour of parent items

License

MIT