RailLayout

A narrow vertical strip of mounts, usually icons.

import { BUILTIN_LAYOUTS } from '@textui/core';

const rail = BUILTIN_LAYOUTS.find((layout) => layout.name === 'rail');

Props

| Prop | Type | Default | | | — | — | — | — | | surface | SurfaceName | required | | | mounts | Mount[] | required | | | state | SurfaceState | required | |

Plus everything on BoxProps.

The activity strip down the left of a workbench. Each mount contributes an icon from its display metadata, and the rail stays narrow whatever they are.

Selecting one is what usually changes what the sidebar surface shows, but that wiring is the application’s - the rail reports, it does not route.

See also


Back to top

MIT licensed. Pre-1.0 - the surface is still moving.