API reference
flagstaff/tab-bar
Every export of flagstaff/tab-bar, with its signature and doc comment: tabBar, plus 2 types.
import { tabBar } from 'flagstaff/tab-bar';Functions
tabBar
A tab bar: the active label off a terminal, every tab with the active one marked on one.
function tabBar({ separator }?: TabBarOptions): Component<TabBarState>;| Parameter | Type |
|---|---|
{ separator } (optional) | TabBarOptions |
Returns Component<TabBarState>
Interfaces
TabBarOptions
interface TabBarOptions {
/** Drawn between tabs, muted. Default ` · `. */
separator?: string;
}TabBarState
interface TabBarState {
/** The labels, in order. */
tabs: readonly string[];
/** Index of the active tab. Out of range, no tab is active and the static is empty. */
active: number;
}