ComponentsBlocksFormsPackages

Navigation & disclosureExplore · Adapt · Compose

Sidebar

Sidebar provides a collapsible application navigation rail. Organize content into understandable destinations and reveal detail when it becomes relevant. Keep the active location or expanded state easy to recognize. Explore the live examples, inspect their source and choose the composition that fits your interface before connecting it to your application's data.

The examples use @/components/kamod-ui/sidebar in a Preact project. Follow the live result and its source together: compare supported options in the API reference, refine presentation with the component styles guide, and use shared theme tokens for consistent colors and surfaces. Preserve keyboard behavior and meaningful labels as you replace the sample content.

In this guide 7 sections
Interactive previewTry it before you copy it
Live Preact example Local preview theme · Responsive styles follow the preview width

Installation

Import SidebarProvider and sidebar primitives from @/components/kamod-ui/sidebar.

pnpm add @kamod-ch/ui

The @/components/kamod-ui/… imports in these examples refer to local source files. Configure that alias when copying source, or use the corresponding exports from @kamod-ch/ui when installing the package. Connect the global theme CSS and Tailwind source detection before your first render.

Usage

Wrap the layout in SidebarProvider, render Sidebar next to SidebarInset, and toggle with SidebarTrigger.

import { Sidebar } from "@/components/kamod-ui/sidebar";

Choose a complete composition from the examples below; required child components and props vary by pattern.

Component examples & variants

Explore Sidebar in different contexts, from the starting pattern to the compositions below. Begin with Basic Sidebar, then compare the examples that match your content, state and layout. These are working patterns to adapt, not a list of interchangeable variant values: check the API reference before using a prop or combining behaviors. Look at the surrounding labels, supporting text and spacing as well as the component itself.

Read the result and its implementation together. Use each showcase’s Code view to inspect imports and composition, or its Prompt view to prepare a setup or adaptation brief. Try the narrow preview and local theme controls before connecting real data, and use Reset to return an example to its initial state. Keep layout changes in class utilities where appropriate; follow the component styles guide for hierarchy and the theming guide for shared surfaces and colors. The accessibility notes explain what to preserve when making those changes.

Basic Sidebar

A sidebar with grouped navigation and an inset content area.

src/components/SidebarExample.tsx
import {
  Sidebar, SidebarContent, SidebarGroup, SidebarGroupContent, SidebarGroupLabel,
  SidebarHeader, SidebarInset, SidebarMenu, SidebarMenuButton, SidebarMenuItem,
  SidebarProvider, SidebarTrigger, Separator,
} from "@/components/kamod-ui/sidebar";

export const Example = () => (
  <SidebarProvider>
    <Sidebar>
      <SidebarHeader>Workspace</SidebarHeader>
      <SidebarContent>
        <SidebarGroup>
          <SidebarGroupLabel>Nav</SidebarGroupLabel>
          <SidebarGroupContent>
            <SidebarMenu>
              <SidebarMenuItem>
                <SidebarMenuButton isActive>Home</SidebarMenuButton>
              </SidebarMenuItem>
            </SidebarMenu>
          </SidebarGroupContent>
        </SidebarGroup>
      </SidebarContent>
    </Sidebar>
    <SidebarInset>
      <header class="flex h-12 items-center gap-2 border-b px-3">
        <SidebarTrigger />
        <Separator orientation="vertical" class="h-4" />
        <span class="text-sm">Dashboard</span>
      </header>
    </SidebarInset>
  </SidebarProvider>
);
API reference

Props and data

Configure Sidebar using the contracts below. Read the documented options alongside the source definitions to understand which values your application supplies and which details the component owns. Start with a prop or helper, then follow its type link to inspect the declaration without leaving the page.

Props, slots and variants for this component.

Type cards are extracted from this checkout’s TypeScript source at build time. Props inherited through HTMLAttributes, Omit or variant helpers remain references in those declarations; their fields are not flattened here. Match the reference to your installed version, and check a package’s exports before writing an import type. A type exported by a source file is not necessarily re-exported by @kamod-ch/ui.TypeScript

Component props

Read each option with its owning component. The
marker identifies required fields verified in that declaration. A ? means a field can be omitted; it does not promise a fallback value. Existing documented defaults remain alongside the descriptions. For callbacks, check the argument and return types before connecting your own state or services.

Sidebar

Sidebar component props and accepted values.

Sidebar documented props
Prop / typeDescription
SidebarProvider defaultOpen
booleanSidebarProps

Documented SidebarProvider defaultOpen option for Sidebar. Check its type alongside the usage examples before supplying a value.

Documented defaulttrue

Sidebar collapsible
"offcanvas" | "icon" | "none"SidebarProps

Documented Sidebar collapsible option for Sidebar. Check its type alongside the usage examples before supplying a value.

Documented default"offcanvas"

Sidebar variant
"sidebar" | "floating" | "inset"SidebarProps

Documented Sidebar variant option for Sidebar. Check its type alongside the usage examples before supplying a value.

Documented default"sidebar"

Sidebar side
"left" | "right"SidebarProps

Documented Sidebar side option for Sidebar. Check its type alongside the usage examples before supplying a value.

Documented default"left"

SidebarTrigger
toggle buttonSidebarProps

Documented SidebarTrigger option for Sidebar. Check its type alongside the usage examples before supplying a value.

Documented defaultrecommended

Data type reference

Expand a card to inspect and copy the exact declaration. The code header identifies its repository file; follow imported or inherited types in the implementation source when you need the complete dependency chain. Required-field summaries cover fields declared directly in that type. Source-only helpers and inferred schema outputs describe the local implementation, not additional props you can pass to every component.

Sidebar props

SidebarProps
Exported source declaration from Sidebar.tsx. Referenced types retain their original names; inspect that file for imports and supporting definitions.

SidebarContent props

SidebarContentProps
Exported source declaration from SidebarContent.tsx. Referenced types retain their original names; inspect that file for imports and supporting definitions.

SidebarFooter props

SidebarFooterProps
Exported source declaration from SidebarFooter.tsx. Referenced types retain their original names; inspect that file for imports and supporting definitions.

SidebarInput props

SidebarInputProps
Exported source declaration from SidebarGroup.tsx. Referenced types retain their original names; inspect that file for imports and supporting definitions.

SidebarSeparator props

SidebarSeparatorProps
Exported source declaration from SidebarGroup.tsx. Referenced types retain their original names; inspect that file for imports and supporting definitions.

SidebarGroup props

SidebarGroupProps
Exported source declaration from SidebarGroup.tsx. Referenced types retain their original names; inspect that file for imports and supporting definitions.

SidebarGroupLabel props

SidebarGroupLabelProps
Exported source declaration from SidebarGroup.tsx. Referenced types retain their original names; inspect that file for imports and supporting definitions.

SidebarGroupAction props

SidebarGroupActionProps
Exported source declaration from SidebarGroup.tsx. Referenced types retain their original names; inspect that file for imports and supporting definitions.

SidebarGroupContent props

SidebarGroupContentProps
Exported source declaration from SidebarGroup.tsx. Referenced types retain their original names; inspect that file for imports and supporting definitions.

SidebarHeader props

SidebarHeaderProps
Exported source declaration from SidebarHeader.tsx. Referenced types retain their original names; inspect that file for imports and supporting definitions.

SidebarInset props

SidebarInsetProps
Exported source declaration from SidebarInset.tsx. Referenced types retain their original names; inspect that file for imports and supporting definitions.

SidebarMenu props

SidebarMenuProps
Exported source declaration from SidebarMenu.tsx. Referenced types retain their original names; inspect that file for imports and supporting definitions.

SidebarMenuItem props

SidebarMenuItemProps
Exported source declaration from SidebarMenu.tsx. Referenced types retain their original names; inspect that file for imports and supporting definitions.

SidebarMenuButton props

SidebarMenuButtonProps
Exported source declaration from SidebarMenu.tsx. Referenced types retain their original names; inspect that file for imports and supporting definitions.

SidebarMenuAction props

SidebarMenuActionProps
Exported source declaration from SidebarMenu.tsx. Referenced types retain their original names; inspect that file for imports and supporting definitions.

SidebarMenuBadge props

SidebarMenuBadgeProps
Exported source declaration from SidebarMenu.tsx. Referenced types retain their original names; inspect that file for imports and supporting definitions.

SidebarMenuSkeleton props

SidebarMenuSkeletonProps
Exported source declaration from SidebarMenu.tsx. Referenced types retain their original names; inspect that file for imports and supporting definitions.

SidebarMenuSub props

SidebarMenuSubProps
Exported source declaration from SidebarMenu.tsx. Referenced types retain their original names; inspect that file for imports and supporting definitions.

SidebarMenuSubItem props

SidebarMenuSubItemProps
Exported source declaration from SidebarMenu.tsx. Referenced types retain their original names; inspect that file for imports and supporting definitions.

SidebarMenuSubButton props

SidebarMenuSubButtonProps
Exported source declaration from SidebarMenu.tsx. Referenced types retain their original names; inspect that file for imports and supporting definitions.

SidebarContextValue

SidebarContextValue
Exported source declaration from SidebarProvider.tsx. Referenced types retain their original names; inspect that file for imports and supporting definitions.
Required fields
state, open, setOpen, openMobile, setOpenMobile, isMobile, toggleSidebar

SidebarProvider props

SidebarProviderProps
Exported source declaration from SidebarProvider.tsx. Referenced types retain their original names; inspect that file for imports and supporting definitions.

SidebarRail props

SidebarRailProps
Exported source declaration from SidebarRail.tsx. Referenced types retain their original names; inspect that file for imports and supporting definitions.

SidebarTrigger props

SidebarTriggerProps
Exported source declaration from SidebarTrigger.tsx. Referenced types retain their original names; inspect that file for imports and supporting definitions.

Accessibility

Build the complete interaction, including the parts outside Sidebar. The notes below distinguish the current implementation from the labels, content and behavior your application supplies. Start with the live preview, check the props and data reference, and test the finished composition with real content rather than assuming that an unchanged visual example covers every use case.

Built-in behavior and defaults

Sidebar includes a labeled SidebarTrigger and uses Sheet for its mobile overlay. Desktop collapse and mobile open state serve different layouts. Navigation links still require application-supplied destinations, labels and current-page semantics.

Labels and relationships

Name navigation landmarks and groups by their purpose. When desktop collapse hides text, retain accessible names on icon links and controls. Add aria-current="page" to the actual current destination rather than assuming an active background announces location.

Keyboard and focus

Check desktop tab order, collapse/expand and the mobile sheet as separate flows. The provider includes a Ctrl/Meta shortcut; verify it does not conflict with your app. Mobile dismissal should return focus to a useful trigger.

States and integration details

Do not leave duplicate desktop/mobile navigation trees exposed to keyboard users. Hidden groups must not retain focusable descendants, and a scrollable sidebar must not hide the currently focused link beneath a pinned footer.

Verify the complete interaction

Check behavior as well as markup. Work through these scenarios in the application where the component will be used. Automated checks can help find structural problems; also review the reading experience with a screen reader, keyboard focus and the actual feedback from your application.

  1. Navigate a long sidebar by keyboard, collapse it and verify every surviving icon has a name.
  2. Open and close the mobile sheet with keyboard and touch, checking focus containment and return.
  3. Change routes, resize across the breakpoint and confirm current-page and open-group states remain coherent.

Recheck the result after changing theme tokens, translations or class overrides. Include text enlargement, narrow layouts and reduced-motion settings where animation is present. Inspect the component source when a behavior differs from your expectation; a role or state attribute does not implement keyboard interaction by itself.

For background, read the WAI-ARIA authoring guidance and keyboard interface guidance. These explain the patterns; verify browser and assistive-technology behavior for the implementation and audience you actually support.

Build it into your interface

Use the Sidebar examples as a starting point, then review the behavior in the context of your own screen. Layout, state and content should work together.

Connect the behavior

Use stable identifiers when items come from data, especially when they can be reordered. Keep links as real destinations and use disclosure controls for revealing content. Decide whether selection belongs to local state, the URL or a parent component before connecting callbacks.

Copy the composition, then connect its intent. Replace sample records and callbacks with your own data flow. For options such as value, defaultValue, open or onChange, use only those documented in this component's API; different components expose different contracts.

Give each piece of state one owner. Keep a temporary selection inside the interface when nothing else needs it; lift shared values into a parent when other controls depend on them. Read the prop reference before combining controlled values with defaults. A default normally initializes a control; it is not a substitute for updating its current value.

Connect requests in an event handler or your application’s data layer, never as a side effect of rendering. Keep pending, completed and failed outcomes distinct, preserve useful input after an error, and offer a clear recovery action. If the integration subscribes to an external source, remove that subscription when its owner unmounts; cancel or ignore obsolete requests so an earlier response cannot replace newer results.

Start with the live preview, then exercise the same interaction with your actual data. The type definitions describe accepted values; they do not implement persistence, navigation or server-side validation for you. Keep those responsibilities in the application that composes the UI.

Refine the presentation

Let a parent own the surrounding spacing. Keep related elements together with gap and use semantic surface/foreground pairs so the composition follows the active theme. The wrapper below changes the surrounding layout without assuming extra props on Sidebar.

src/components/ExampleSurface.tsx
import type { ComponentChildren } from "preact";

export function ExampleSurface({ children }: { children: ComponentChildren }) {
  return (
    <div class="grid min-w-0 gap-4 rounded-lg border border-border bg-card p-4 text-card-foreground sm:p-6">
      {children}
    </div>
  );
}

Put the chosen example inside ExampleSurface, then refine supported variants and sizes using the API above. For application-wide changes, adjust theme tokens instead of repeating fixed colors. See Component styles for hierarchy, density and focus treatments.

Review the complete interaction

  • Try long labels, nested content and an empty list without changing the focus order.
  • Verify the documented arrow-key and activation behavior where the pattern supports it.
  • Check the selected or expanded item after data changes and while navigating back to the page.

The preview's narrow control changes its container width. Also resize the browser when checking viewport-based Tailwind utilities such as sm: and md:, and test overlays in the full page where their portals render.

Compose a complete interface

Sidebar is one part of the interaction. Choose companion components for the information or actions that still need a place on the screen. The references below are suggestions to compose deliberately, not extra dependencies you must add to every example.

Keep one source of truth for the operation and let each component communicate a different part of it. For example, waiting, no results and failure need different explanations. Avoid showing contradictory states together, and keep recovery actions close to the message that explains them.

Start with the smallest composition that explains the task. Browse the component library for individual controls or the block collections for complete layouts. Reuse shared theme tokens so these pieces feel consistent in light and dark mode.

Sources & design references

Follow Sidebar from its implementation to the ideas behind your own composition. Start with the local API, explore a visual direction, then bring the result back to your app’s shared styles.

Implementation · Preact

Kamod UI implementation

Start with the code that powers this page. The Sidebar source in Kamod UI is the implementation reference. Use the installation guide for setup and the API reference for supported props, composition and events before adapting an example.

Source locationpackages/core/src/components/sidebar

Compare imports, default values and state handling with the example you chose. The repository’s main branch can be ahead of your installed version; check your package.json and lockfile when an API differs. Retain applicable license notices when reusing source.

Design direction · Shared foundations

Build on a shared design language

Start with the component styles guide to choose a clear hierarchy and consistent spacing. Keep the same treatment for similar actions, and let content and behavior determine which details deserve emphasis.

This page does not identify a matching external design collection. Use the local examples as your starting point and the component library to find neighboring patterns. Shared bg-card, text-card-foreground and border-border utilities help those pieces feel related.

Bring it back to your app

A reference becomes useful when it fits your real content. Work through these decisions in order:

  1. Keep the behavior grounded. Start with the interactive examples, then connect your data and callbacks using the integration guidance. Preserve labels, keyboard access and disabled states as you change the presentation.
  2. Make the styling repeatable. Use the styles guide for local class adjustments and theming documentation for shared color decisions. Keep semantic surface and foreground pairs together in both light and dark mode.
  3. Check the complete screen. See how components combine in the block collections, then try long labels, loading states and narrow layouts in your own composition. The Theme Toggle guide helps you expose a scheme switch in the finished interface.