structyl

Bottom Navigation

stable

Bottom tab-style navigation.

Basic usage

Examples

Three destinations

BottomNavigation uses tab semantics and controlled/uncontrolled selected value.

Controlled value

Use value and onValueChange when route state owns the selected item.

Icons and labels

Use showLabels on the root or showLabel per item.

Features

  • Controlled or uncontrolled.
  • Selected item state.

Installation

bash
pnpm dlx structyl add bottom-navigation

API Reference

BottomNavigation.Root

Bottom tablist root.

PropTypeDefault
value | defaultValuestring

Controlled or uncontrolled selected value.

onValueChange(value: string) => void

Selection callback.

showLabelsboolean

Show all labels instead of only selected labels.

false
classNamestring

Additional Tailwind classes merged with the component defaults.

BottomNavigation.Item

Bottom navigation action.

PropTypeDefault
valuestring

Item value.

labelReact.ReactNode

Visible label slot.

iconReact.ReactNode

Icon slot.

showLabelboolean

Override root label visibility.

classNamestring

Additional Tailwind classes merged with the component defaults.

Bottom Navigation | structyl