Sidebar

Persistent navigation region with responsive token-backed padding.

Preview

A live, theme-aware example rendered with the published component.

Import

Import from the focused entry point below, or use the same named export from @tavojs/ui. Both are public APIs; measure the built application when comparing their bundle cost.

TSX

tsximport { Sidebar } from "@tavojs/ui/sidebar";

The component import loads compiled component CSS. Enable tavoUi() for your project theme variables, or import @tavojs/ui/theme.css once for the package default theme. The equivalent CSS-safe component alias is @tavojs/ui/css/sidebar.

When to use

Use it when

Use Sidebar for navigation or supporting content that remains part of the application layout.

Choose something else when

Use Sheet when the panel should temporarily overlay the page, trap focus, provide a backdrop, and close after the task.

Examples

These examples include imports and local state where interaction requires it. Render the exported component in a page after completing UI installation. Demo state stays in the mounted component; connect file handling, persistence, and data loading to your application as needed.

Sidebar example

TSXCreate: src/components/examples/SidebarExample1.tsx

tsximport { Sidebar } from "@tavojs/ui/sidebar";
import { Button } from "@tavojs/ui";

export function SidebarExample1() {
  return (
    <>
      <Sidebar><Button variant="soft">Overview</Button></Sidebar>
    </>
  );
}

Common props and defaults

A curated starting point. The complete TypeScript API below includes additional props and compound member contracts.

Prop	Type	Default	Description
`className`	`string`	—	Optional class hook applied to the public root element owned by the component.
`padding`	`ResponsiveValue<"none" \| "sm" \| "md" \| "lg">`	—	Configures padding for this component.

Complete TypeScript API

Import from @tavojs/ui/sidebar. Published exports: Sidebar, SidebarProps.

`SidebarProps`

Property	Type	Required	Description
`children`	`Child`	No	Inherited children attribute accepted by Sidebar.
`className`	`string`	No	Optional class hook applied to the public root element owned by the component.
`sx`	`Sx`	No	Inherited sx attribute accepted by Sidebar.
`id`	`string`	No	Inherited id attribute accepted by Sidebar.
`role`	`string`	No	Inherited role attribute accepted by Sidebar.
`style`	`Record<string, unknown>`	No	Inherited style attribute accepted by Sidebar.
`title`	`string`	No	Inherited title attribute accepted by Sidebar.
`tabIndex`	`number`	No	Inherited tabIndex attribute accepted by Sidebar.
`hidden`	`boolean`	No	Inherited hidden attribute accepted by Sidebar.
`disabled`	`boolean`	No	Inherited disabled attribute accepted by Sidebar.
`onClick`	`TavoEventHandler<MouseEvent>`	No	Inherited onClick attribute accepted by Sidebar.
`onChange`	`TavoEventHandler<Event>`	No	Inherited onChange attribute accepted by Sidebar.
`onInput`	`TavoEventHandler<Event>`	No	Inherited onInput attribute accepted by Sidebar.
`onKeyDown`	`TavoEventHandler<KeyboardEvent>`	No	Inherited onKeyDown attribute accepted by Sidebar.
`onFocus`	`TavoEventHandler<FocusEvent>`	No	Inherited onFocus attribute accepted by Sidebar.
`onBlur`	`TavoEventHandler<FocusEvent>`	No	Inherited onBlur attribute accepted by Sidebar.
`padding`	`ResponsiveValue<"none" \| Spacing>`	No	Configures padding for this component.

State ownership and DOM target

Concern	Contract
State	No component state contract is exposed; the application owns the rendered content and surrounding behavior.
DOM target	Public passthrough props target the component root. Treat nested elements and private class names as implementation details.

Anatomy and related components

This component exposes one public component root rather than a compound member API.

Limitations

Use Sheet when the panel should temporarily overlay the page, trap focus, provide a backdrop, and close after the task.

Use only the documented props, entry points, and compound members. Internal DOM nesting and CSS class names can change without becoming part of the public component contract.

Accessibility

Layout primitives are semantic-neutral unless a component prop selects an element role.

Choose semantic elements such as main, nav, aside, or section when the region has document meaning.
Keep heading order and landmark labels app-owned.

Component status

Contract	Current value
Maturity	stable
Category	layout
Component import	`@tavojs/ui/sidebar`
Explicit CSS import	`@tavojs/ui/css/sidebar`
Preview	Interactive preview available on this page