sigilUI

Sidebar

Organize application navigation in an expandable side panel.

@sigil-ui/componentsReact

Preview

Live preview Interactive

Import

import { Sidebar, SidebarHeader, SidebarContent, SidebarFooter, SidebarGroup, SidebarGroupLabel, SidebarItem } from "@sigil-ui/components";

Usage

<Sidebar className="relative h-[calc(var(--s-grid-cell)*6)] border border-[var(--s-border)]">
  <SidebarHeader>Navigation</SidebarHeader>
  <SidebarContent>
    <SidebarGroup>
      <SidebarGroupLabel>Menu</SidebarGroupLabel>
      <SidebarItem>Dashboard</SidebarItem>
      <SidebarItem>Settings</SidebarItem>
    </SidebarGroup>
  </SidebarContent>
</Sidebar>

Sub-components

This component includes the following parts:

  • <SidebarHeader>
  • <SidebarContent>
  • <SidebarFooter>
  • <SidebarGroup>
  • <SidebarGroupLabel>
  • <SidebarItem>

Props

PropTypeDefaultDescription
defaultCollapsedboolean—Start in collapsed (icon-only) mode.

Token integration

CSS VariablePurpose
--s-borderBorder
--s-border-styleBorder style
--s-surfaceSurface
--s-textText
--s-duration-normalDuration normal
--s-sidebar-widthSidebar width
--s-radius-fullRadius full
--s-text-mutedText muted
--s-shadow-smShadow sm
--s-duration-fastDuration fast
--s-primaryPrimary
--s-radius-mdRadius md