# flagstaff/tab-bar

> Every export of flagstaff/tab-bar, with its signature and doc comment: tabBar, plus 2 types.

Source: https://flagstaff.interlace.tools/docs/api/tab-bar

<!-- Generated by scripts/api-reference.ts from the built dist/*.d.ts. Do not edit; run `npx tsx scripts/api-reference.ts`. -->

```ts
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.

```ts
function tabBar({ separator }?: TabBarOptions): Component<TabBarState>;
```

| Parameter | Type |
| :-- | :-- |
| `{ separator }` (optional) | `TabBarOptions` |

**Returns** `Component<TabBarState>`

## Interfaces

### TabBarOptions

```ts
interface TabBarOptions {
    /** Drawn between tabs, muted. Default ` · `. */
    separator?: string;
}
```

### TabBarState

```ts
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;
}
```