ComponentsBlocksFormsPackages

Sidebar 2 — Collapsible sections with a sticky breadcrumb header

Layout block

A sidebar with collapsible sections. Adapt the Sidebar components from @kamod-ch/ui to your navigation, branding and page content. Replace sample destinations with your own routes, then check the mobile layout and keyboard navigation in the live demo. The source and setup steps show which files belong to this variant.

Interactive previewTry it before you copy it

Variant 2 of 16

Getting started

Download this variant into your Preact project, install the dependencies you are missing and connect your own navigation and page content. The source stays local, so you can change its layout without introducing another application framework.

  1. Download this variant and extract its sidebar-02 folder into src/components/blocks. Install the dependencies below, then import the component. The folder includes its own helpers and demo data; no other sidebar variants are needed. Relative imports are already set up inside the folder, so you can move it as a unit and replace the sample navigation and content with your own. The archive already contains the outer sidebar-02/ folder: extract it once, rather than creating a second nested folder with the same name. The import examples assume src/App.tsx.

    Download block
    12 files · source ZIP
    Install dependencies

    Prefer manual copying? Open the Showcase’s Code tab and copy each listed file into the same folder structure above. Its labels are the destination paths inside sidebar-02/, and its imports already match the download. Keep the included license with your copy.

  2. Install only what your app does not already have. Preact renders the block, Kamod UI provides its interactive components, and Icons supplies its icons. Themes and Signals support the shared Kamod setup.

    pnpm add @kamod-ch/ui @kamod-ch/icons preact @kamod-ch/themes @preact/signals

  3. Follow the theme and Tailwind setup. Import your global stylesheet and make sure Tailwind scans the copied source and Kamod components. Keep your existing setup if the app already uses Kamod.

    import { Sidebar02 } from "./components/blocks/sidebar-02";

    The @kamod-ch/blocks/sidebar/sidebar-02 path identifies source in this repository; the blocks package is private. Use the local import above rather than trying to install that path as a published package.

    Check the first render: the sidebar, borders and page background should follow your app’s theme. If the layout appears unstyled, check the global CSS import and Tailwind source detection before changing the block’s classes. If an import fails, first compare your folder paths with the copy list; renaming only one file can break its relative imports.

Integration

Start with the complete preview composition, then adapt its local source to your app. The exported Sidebar02 takes no props; navigation, content and behavior are configured inside your copied files.

Think of this block as an editable starting layout. Rendering <Sidebar02 /> runs the JSX already written in your copied file: its sidebar, header, sample data and placeholder content. The supplied wrapper does not read navigation props or children, so your own content needs to be connected inside that composition first.

A block such as Application Shell 1 exposes a defined API for navigationGroups, breadcrumbs and children. These sidebar variants instead expose their arrangement as source you can edit. That lets a documentation sidebar, a two-pane layout and a settings dialog each keep their own structure without fitting every difference into one configuration object. You get direct control over the layout, with the responsibility of wiring it to your app.

The file you render owns the composition
Open sidebar-02.tsx to see how the pieces fit together. Keep its provider and layout structure while replacing the parts you need. The Sidebar02 wrapper is your local page; the core Sidebar inside it is a configurable UI component.
Data and helper props still do the work
The no-props entrypoint does not remove the inner components’ APIs. Your copied file passes data and options to the helpers it uses. Update the sample values in data/ or pass application values at those call sites. Follow Adapt the local composition for this variant’s example and Local props and data for the supported inputs.
Your content goes into the existing page area
This variant uses DashboardShell. Its children replace the placeholder panels while retaining the surrounding shell. Your router decides which page to show; the block does not choose routes or fetch your application data. See Connect your application.

A small content change looks like this. This is an excerpt to edit inside your copied file, keeping the rest of its JSX in place. It is not a replacement for the whole block or a new prop on Sidebar02.

// Inside sidebar-02.tsx; keep existing shell props.
<DashboardShell>
  <div class="p-4">Your page content</div>
</DashboardShell>

You can introduce your own props later. If multiple routes need the same layout, add a typed children prop or navigation inputs to your local Sidebar02, then explicitly forward them to the relevant helpers. The downloaded wrapper does not do that automatically. Start by rendering the original below, then make the local edits one step at a time.

Render the block once in your page or route layout. It already includes its own SidebarProvider, so you do not need another provider around this example.

import { Sidebar02 } from "./components/blocks/sidebar-02";

export const App = () => <Sidebar02 />;

Your copied sidebar-02.tsx contains the complete composition. Start with its imports from data/ to replace sample labels and destinations, then update the local components that consume them. The snippet below replaces one part of that file; keep the surrounding provider and layout in place.

// Replace the NavDocs data in sidebar-02.tsx.
<NavDocs collapsibleSections groups={[{
  title: "Workspace",
  items: [{ title: "Projects", url: "/projects", isActive: true }],
}]} />

These are local edits, not props to pass to <Sidebar02 />. See Local props and data for the helpers this variant actually includes and their supported inputs.

Pass your page content as children to the existing DashboardShell to replace its placeholder content. Supply breadcrumbs from the current route, with the current page last. Custom children replace the demo’s padded content wrapper too, so add your own spacing.

// In sidebar-02.tsx; keep existing layout props.
<DashboardShell
  breadcrumbs={[
    { label: "Workspace", href: "/" },
    { label: "Projects" },
  ]}
>
  <div class="flex flex-1 flex-col gap-4 p-4">
    <h1 class="text-2xl font-semibold">Projects</h1>
    <p>Your routed content goes here.</p>
  </div>
</DashboardShell>
  • Routing and actions. Real URLs navigate normally; # links are placeholders. For client-side routing, adapt the local links to your router and derive active styling from its current route. Expanding a navigation group does not select a destination. Connect any search, account or form controls you keep to real application handlers.
  • Close mobile navigation deliberately. The demo link helper only prevents # navigation. It does not close the mobile sheet after a client-side route change. In a helper rendered inside the existing provider, use useSidebar() and call setOpenMobile(false) after handling an ordinary destination click. Preserve modified clicks and avoid closing the sheet when a user only expands a branch.
  • Preserve the layout. Keep the existing main landmark and keep sidebar controls inside their existing provider. Keep the composition mounted across page changes to retain its local UI state. Review this variant’s responsive behavior before moving controls; desktop and mobile navigation can differ. Follow the production checklist before shipping.

API reference

Sidebar02 is a ready-made demonstration page with no public props. The reference below describes the local helpers and data you can configure after copying the source. Definitions come directly from the implementation; descriptions explain where your application takes over. Start with the component or data shape you want to change, then follow its type link to the complete definition. Keep sample values in data/ separate from the behavior in your copied components. This lets you replace labels and destinations without rewriting the surrounding layout in sidebar-02.tsx.

The signatures below come from the copied source files. Use the data type reference to inspect complete definitions and required fields. Optional callbacks do not imply that a backend is included. Select a table row’s type name to open its definition automatically. Use import type from the corresponding copied file when typing your own data or component inputs. This reference describes the shipped source; changes in your local files will not update this page.TypeScript
Each field includes its type and integration behavior. The asterisk
marks required fields. Navigation helpers require their data; omitted optional fields use the defaults described below. The definitions retain the actual source’s optional markers and callback return types. Read each field together with its owning type: the same name can have a different purpose on another helper. A ? means the field may be omitted, not that every optional field has a fallback value. When a field accepts an array, its required marker means you must supply the array; check the helper’s behavior before using an empty [].
Local helper props and data fields
Prop / typeDescription
label
stringBreadcrumbConfig		Text for one breadcrumb in the header’s ordered trail. Place the current page last: that final item is always rendered as page text, even if it has an href. Earlier items become links only when they supply href. Keep labels concise and distinct within the trail because they also serve as rendering keys.
href
stringBreadcrumbConfig		Optional URL for an intermediate breadcrumb. When present on a non-final item it renders a BreadcrumbLink; when omitted, the item renders as page text instead. The last breadcrumb never becomes a link, even if a URL is supplied. Set real parent destinations here rather than relying on the fallback trail’s # placeholder.
hiddenOnMobile
booleanBreadcrumbConfig		Hides this breadcrumb and its preceding separator below 768px; omitted or false keeps them visible. Use it for intermediate hierarchy levels when space is limited. The helper does not protect the final item from this flag, so leave it unset on the current page. Review the whole trail on mobile after hiding items so the remaining context is still understandable.
children
ComponentChildrenDashboardShellProps		Your page content rendered directly beneath DashboardShell’s optional breadcrumb header inside SidebarInset. Supplying content replaces the placeholder panels completely; add your own padding, layout and loading states around it. Null or undefined falls back to the selected placeholder arrangement. Use this on the local DashboardShell in your copied composition, not as a prop on the exported SidebarXX wrapper.
breadcrumbParent
stringDashboardShellProps		Parent label in the fallback two-level breadcrumb trail, used when breadcrumbs is omitted or empty. Defaults to Build Your Application and is hidden below 768px; an empty string removes it. Its fallback link points to #. Use the breadcrumbs array instead when the parent needs a real destination or the hierarchy contains more levels.
breadcrumbPage
stringDashboardShellProps		Current-page label in the fallback breadcrumb trail; defaults to Data Fetching. It stays visible on mobile and is rendered as page text rather than a link. This value is ignored when a non-empty breadcrumbs array is supplied. Update it from your page context, or switch to that array for a fully specified hierarchy.
breadcrumbs
BreadcrumbConfig[]DashboardShellProps		Ordered trail of labels and optional destinations; place the current page last. A non-empty array replaces breadcrumbParent and breadcrumbPage, while an empty array still uses their fallback values rather than hiding the trail. Use hiddenOnMobile selectively on intermediate items. To remove the whole header and its toggle, use showHeader instead.
headerClass
stringDashboardShellProps		Class string replacing the header’s default flex layout, height, border and horizontal padding. Include any structural classes you still need when overriding it; this is not merely appended to the defaults. stickyHeader independently adds sticky positioning, top offset, stacking and background classes. The value has no visible effect when showHeader is false.
contentClass
stringDashboardShellProps		Extra classes merged into the grid, list and squares placeholder wrappers, alongside their flex layout and padding classes. This does not style custom children or the outer SidebarInset. The centered placeholder uses its own fixed wrapper and ignores this value. Once you supply real content, put its classes on your own elements instead.
triggerClass
stringDashboardShellProps		Class string passed to the breadcrumb header’s SidebarTrigger, replacing the default -ml-1 margin. Use it to adjust the toggle’s position within your chosen header layout while retaining the core trigger behavior. An empty string removes that default margin. It has no visible effect when showHeader is false and does not control whether the sidebar is open.
headerInner
booleanDashboardShellProps		Wraps the sidebar toggle, separator and breadcrumbs in a shared inner row; defaults to false. Enable it when the header needs an outer surface and a separately padded group of controls. The row receives flex alignment plus headerInnerClass, whose default is px-3. This changes markup and spacing only, not navigation or sidebar state.
headerInnerClass
stringDashboardShellProps		Classes merged with the inner header row’s fixed flex alignment and gap when headerInner is true. Defaults to px-3; supplying a value replaces that default padding rather than appending to it. Use this for the row around the toggle, separator and breadcrumbs, while headerClass styles the outer header. It is ignored when the inner row is disabled.
stickyHeader
booleanDashboardShellProps		Adds sticky top positioning, z-index and the theme background to the breadcrumb header; defaults to false. It keeps that header visible within the applicable scroll container rather than making the entire page fixed. Review ancestor overflow when integrating the copied layout because it affects sticky behavior. No sticky header is rendered when showHeader is false.
showHeader
booleanDashboardShellProps		Controls whether DashboardShell renders its breadcrumb header, separator and sidebar toggle; defaults to true. Setting it to false leaves the content area intact but also removes that built-in toggle. If your composition supplies its own header, place a SidebarTrigger there when users still need to open or collapse navigation. This flag does not hide the sidebar itself.
placeholder
"grid" | "list" | "squares" | "centered"DashboardShellProps		Selects the demonstration content shown when children is null or undefined; defaults to grid. Choose grid for three summary panels and a larger area, list for repeated rows, squares for a tile grid or centered for a narrower centered composition. These are static visual placeholders, not loading or data-fetching components. The option is ignored as soon as you supply your own content.
contentPaddingTop
booleanDashboardShellProps		Controls top padding on the grid, list and squares placeholder wrappers; defaults to true. Setting it to false retains their side and bottom padding but removes the top gap, useful when matching a particular header composition. It does not affect custom children. The centered placeholder has its own fixed padding and also ignores this option.
title
stringDocumentationGroup		Heading displayed above this documentation group’s links. When collapsibleSections is enabled it also labels the disclosure button; otherwise it remains a static group label. Use a concise category name and keep group titles unique because NavDocs uses them as keys. The title does not itself define a destination.
items
NavigationLink[]DocumentationGroup		Links belonging to this documentation group, displayed in array order. Supply each label and destination and mark the current link with isActive when appropriate. An empty array leaves an empty group rather than removing its heading. With collapsibleSections enabled, an active child causes the group to start open; later route changes do not control its disclosure state.
groups
DocumentationGroup[]NavDocsProps		Documentation groups rendered in array order, each with a heading and its own destination list. Supply your application’s hierarchy here; NavDocs does not load fixtures or discover routes automatically. An empty array renders no groups. Use collapsibleSections to make the group headings toggle their links, and set a child’s isActive value to initially expand its group.
collapsibleSections
booleanNavDocsProps		Enables independent disclosure controls for documentation groups; defaults to false, so all group links are visible. When enabled, a group starts open if one of its items is active, and users can then toggle it locally. Later route changes do not turn that initial value into controlled open state. This option does not collapse the outer sidebar or affect mobile navigation.
title
stringNavigationLink		Visible destination label used in navigation rows and, where supported, collapsed-sidebar tooltips. Choose short, distinguishable names and keep titles unique within each list because the helpers also use them as rendering keys. Changing a title does not change its URL or select the current route.
url
stringNavigationLink		Destination used when the item renders as a link. Replace the demo’s # with an application route or a real URL; the shared click handler prevents navigation only for that exact placeholder. A parent with children may instead act as a disclosure or dropdown trigger, so its URL is not necessarily followed. Router-specific link components must be wired into the copied helper.
isActive
booleanNavigationLink		Optional current-destination marker; omitting it leaves the item unmarked. Documentation links and direct primary links use it for their active styling and aria-current. Collapsible groups use active data for their initial open state, not as controlled disclosure state. Nested primary links, dropdown entries and Favorites do not currently read this marker; adapt those renderers if you need route highlighting there.
versions
string[]VersionSwitcherProps		Version labels displayed in the documentation dropdown, in the supplied order. Use unique strings without a leading v because the helper adds that prefix itself. The array must be supplied, but an empty array produces a menu with no choices. Selecting a label changes local display state only; connect release-specific routes and navigation data in your application.
defaultVersion
stringVersionSwitcherProps		Initial displayed version when VersionSwitcher mounts. Supply a value from versions so the initial label corresponds to an available choice. This is not a controlled value: changing it later does not reset the switcher’s local selection, and removing the selected version from the choices does not update the label. Adapt the helper to controlled state if version changes must follow your router.

Configure the core Sidebar directly in your copied page: side chooses left or right, variant controls the surface, and collapsible chooses offcanvas, icon or none. The references here list only types included in this variant’s download. SearchFormProps refers to Preact’s form attributes rather than declaring custom search inputs. The helper does not implement search or expose its input value as a prop; connect the input and prevent the form’s default submission in your local copy when implementing client-side search.

Expand a definition to copy its exact TypeScript shape. Required fields are listed below each summary for fields declared in that definition. The code header shows the file's installation path; copy the definition with the button beside it. For intersections, also inspect the referenced base type’s required fields. Local types can be imported from the same files as your copied components; they are not added to the zero-prop page wrapper.

Breadcrumb Config

BreadcrumbConfig
Data shape from components/dashboard-shell.tsx. Supply real application values using the required and optional fields below.
Required fields
label

Dashboard Shell Props

DashboardShellProps
Local helper inputs from components/dashboard-shell.tsx. These configure the helper inside the copied page, not the exported variant itself.

Documentation Group

DocumentationGroup
Data shape from components/nav-docs.tsx. Supply real application values using the required and optional fields below.
Required fields
title, items

Nav Docs Props

NavDocsProps
Local helper inputs from components/nav-docs.tsx. These configure the helper inside the copied page, not the exported variant itself.
Required fields
groups

Navigation Link

NavigationLink
Data shape from components/navigation.ts. Supply real application values using the required and optional fields below.
Required fields
title, url

Search Form Props

SearchFormProps
Local helper inputs from components/search-form.tsx. These configure the helper inside the copied page, not the exported variant itself.

Version Switcher Props

VersionSwitcherProps
Local helper inputs from components/version-switcher.tsx. These configure the helper inside the copied page, not the exported variant itself.
Required fields
versions, defaultVersion

Variant details

Each documentation group has its own disclosure, so readers can hide sections they do not need. The page uses a sticky breadcrumb header and a list of placeholder rows. Change NavDocs and DashboardShell props in sidebar-02.tsx; group expansion is local UI state, not a saved preference.

Edit sidebar-02.tsx for layout and data/ for example content. Reusable interactions live in components/. Each variant is an explicit composition; there is no configuration switch or dependency on another variant.

A closer look

A documentation layout that lets readers reduce a long outline to the sections they need. Each section heading controls its own group of links. Search and version selection remain above the outline, and a sticky breadcrumb header keeps page context visible while the content scrolls.

Where this layout adds value
Useful for manuals with several independent topics, onboarding guides or reference collections with many sections. Readers can keep a relevant group open and collapse neighboring groups without losing the overall category structure. This saves vertical space while leaving the categories discoverable.
The tradeoff to consider
Collapsed groups hide their destinations until opened. A reader may need more actions to discover a page than in an always-visible outline. Expansion is separate from routing, so applications that change routes without remounting the layout need to decide how the newly active group becomes visible.

Choose by the way people move through your app, not only by the preview’s appearance. These nearby variants change a specific part of that experience; they are alternatives, not files you need to install alongside this block.

Sidebar 1
Leaves every documentation group visible. It is simpler when the navigation is short and immediate link discovery matters most.
Sidebar 5
Collapses individual application submenu branches rather than whole documentation groups, with icons and a workspace selector.

The layout shares VersionSwitcher, SearchForm and NavDocs with Sidebar 1. Its important local choice is collapsibleSections on NavDocs: each group gets a core Collapsible. DashboardShell uses stickyHeader and a list placeholder, which you replace with your own content rather than treating it as a supplied document renderer.

In the downloaded folder, index.ts exports Sidebar02. Its sidebar-02.tsx owns the arrangement. Any included helpers live in components/, fixtures in data/, and any included brand artwork in branding/. These paths describe your installation folder, which is generated from the actual implementation with its relative imports rewritten together.

Edit the composition where it is assembled. The exported wrapper does not accept a navigation configuration or forward children. Its inner components still have their own inputs. Replace data at their call sites and insert your content in the existing page area; the Usage guide shows the appropriate insertion point for this variant. You can introduce a typed wrapper API later if multiple routes need to reuse your adapted layout.

A group containing an active item starts open through defaultOpen. Each disclosure then manages its own open state; this is not an exclusive accordion. Updating isActive later does not by itself synchronize an already mounted disclosure. Version selection remains a local label change, and search requires application behavior.

Presentation state belongs to the layout
An open menu, expanded branch or selected demo value describes the interface at that moment. It does not automatically load data, authorize access or change the URL. Preserve useful local UI state while letting your application own the current page and real records.
Route state belongs to your application
Derive active destinations, page content and breadcrumbs from one route or selection model. An isActive flag supplies styling; it is not a router. Where a helper initializes a disclosure with defaultOpen, decide whether later route changes should also update that disclosure.

Inspect Local props and data before wiring a callback. Only the inputs documented for the copied helper are available; introducing another callback also requires updating its implementation.

Group disclosures remain usable inside the mobile navigation sheet. Keep section labels short enough for the narrower panel.

Below 768px, collapsible core sidebars use the mobile sheet. Desktop open and mobile openMobile are separate states in SidebarProvider; restoring a desktop preference does not open the sheet. Static regions using collapsible="none" follow their own layout and visibility classes instead.

Test the space left for your actual content, not just the empty panels. Long navigation labels, a wide data table and a short viewport can expose different constraints. Let text wrap where it carries meaning, keep any necessary scrolling local to its content, and offer another way to reach essential controls when a secondary pane is hidden.

A section heading is a disclosure button, not a destination link. Preserve its expanded state announcement and keyboard activation. If a group also needs an overview page, provide a distinct link instead of making the same click both navigate and collapse.

Current location and meaningful names
Use real links for destinations and buttons for actions. Set aria-current="page" on the current destination; visible selection alone is insufficient. Give icon-only controls meaningful names, and make breadcrumbs agree with the page being shown rather than leaving their sample labels unchanged.
Keyboard, focus and content landmarks
Retain core disclosure, menu and overlay behavior. Check Tab, Shift+Tab, Enter, Space and Escape where applicable, including focus return after dismissal. The existing page area already provides a main landmark; insert content within it rather than adding nested main elements. Give distinct navigation regions meaningful labels when your adaptation contains more than one. The core provider also registers Ctrl/Cmd+B to toggle navigation; check this shortcut against your application’s editor or other global shortcuts, and avoid mounting duplicate providers for the same layout.

Validate your finished integration at 320px, 768px, 1024px and 1440px, with keyboard-only input, 200% zoom, both color modes and long real content. Check short screens and the on-screen keyboard as well. Reusing the primitives helps preserve behavior, but cannot guarantee accessibility after your content or structure changes.

Choose whether readers' manual expansion choices should survive navigation, and whether entering a hidden page should open its group. If you need that behavior, control disclosure state in the copied NavDocs helper. Keep route matching, breadcrumbs and documentation-version selection consistent before adding persistence.

  1. Replace demo navigation. Supply real URLs: the shared stopNavigation helper only cancels links whose destination is #. Add your router’s link handling if needed. Connect actions to your services and show useful pending, empty or failure states where they apply. Hiding a link does not replace authorization in your application.
  2. Make state ownership deliberate. Keep the layout mounted if its UI state should survive route changes. If desktop collapse must survive a reload, restore an initial or controlled value through SidebarProvider. Its cookie write alone does not read and restore that preference for your app.
  3. Replace placeholders before tuning the layout. Test your real pages and theme first, then adjust widths, spacing and overflow. Use semantic tokens so borders, backgrounds and interactive states continue to follow light and dark mode.

Start with Connect your application for the integration point, then use the data type reference to shape your inputs. Keep the copied folder together while changing its internals; there is no dependency on another sidebar variant’s installation.

Keep building

Use the checked-in Kamod implementation as your reference when adapting this variant. The showcase’s Code tab includes its supporting files, and the setup instructions explain where to place them and how to keep their imports intact. Before changing a helper, trace where it is used in the composition and check its inputs in the Props and data reference. This helps you adapt one part of the block without overlooking the files or behavior it depends on.

Source: Sidebar 2 on GitHub

Keep your local copy focused on the layout and interactions your app actually uses. Start with the data and content, then adjust composition and styling using the same semantic theme tokens.

Ready to integrate? Follow Add this block and the local usage example.

Design inspiration

This variant follows the corresponding sidebar design in the shadcn/ui collection. Use the reference to compare independently collapsible navigation groups and their relationship to the page header. When adapting the Kamod version, start with your navigation hierarchy and page content, then follow the local composition example to connect the layout to your app.

Attribution: shadcn/ui sidebar-02.

Kamod expresses this layout with Preact components, its own sidebar behavior and semantic theme tokens. The copied variant keeps its composition, helpers and demo data together; your application supplies real destinations, content and actions.

Inspect the original variant’s source for the reference composition. The variant details above describe this implementation’s behavior and integration boundaries.

Use the original as a design reference. To install the Preact version shown here, follow Add this block and use this page’s download or Code tab. Its files and imports are prepared for Kamod.