SidebarGroup

SidebarGroup keeps related destinations visible in a sidebar. Choose it for persistent site structure; use Tabs for a few peer views inside the page someone is already reading.

Examples

Current destination

active marks the page someone is on, while a badge can carry a stable count or status. Make the callback perform navigation or update the surrounding content; the group does not own either.

Project

Selected: Overview

Collapsible section

collapsible turns the label into a disclosure control. Use defaultCollapsed only when the initial density helps people scan a long sidebar, not to hide the primary destination by default.

When to use

Use SidebarGroup for persistent, grouped destinations in an application shell or a sidebar.

Reach for something else when:

The destinations are a few peer views within one page — use Tabs.
The choice is a temporary action list — use Dropdown.
The person needs to switch the current tenant or account — use WorkspaceSwitcher.

Accessibility

Items are native buttons; active adds aria-current="page". Make each item callback navigate or update the current view, so its button behavior leads somewhere meaningful.
A collapsible label is a <button aria-expanded>; a non-collapsible label is not a button at all. Its chevron is an empty aria-hidden span rotated by CSS.
Item-level onSelect runs before the group-level onSelect(id, item). Use the item callback for local work and the group callback for the shared selection effect.
The label is a structural heading for this group of buttons, not an action unless collapsible is set.

API and code

Name	Type	Required	Description
`label`	`string`	—	Section label, rendered in uppercase by the styles package.
`items`	`SidebarGroupItem[]`	—	Items rendered in the supplied order.
`collapsible`	`boolean`	—	Whether the section label can collapse the item list.
`defaultCollapsed`	`boolean`	—	Whether a collapsible group is initially collapsed.
`onSelect`	`(id: string, item: SidebarGroupItem) => void`	—	Called with the selected item's id and full item record.
`className`	`string`	—	Additional class names appended after Lyra classes.
`children`	`ReactNode`	—	Extra content rendered after the group items.

x-data="lyraSidebarGroup({ … })"

Option	Type	Required	Description
`defaultCollapsed`	`boolean`	—	Whether the group starts with its consumer-rendered items unmounted. Default: `false`.

The active destination is a button with aria-current; the disclosure label is a separate button:

html

<div class="lyra-sbgroup">
  <button class="lyra-sbgroup__label lyra-sbgroup__label--btn" type="button" aria-expanded="true">
    <span>Project</span>
    <span class="lyra-sbgroup__chev" aria-hidden="true"></span>
  </button>
  <div class="lyra-sbgroup__items">
    <button class="lyra-sbgroup__item lyra-sbgroup__item--active" type="button" aria-current="page">
      <span class="lyra-sbgroup__item-label">Overview</span>
    </button>
    <button class="lyra-sbgroup__item" type="button">
      <span class="lyra-sbgroup__item-label">Activity</span>
      <span class="lyra-sbgroup__item-badge">8</span>
    </button>
  </div>
</div>

<lyra:sidebar-group> Generated from lyra-ds/blade v0.10.0.

The behavior comes from lyraSidebarGroup() — install @lyra-ds/alpine and see the HTML + Alpine tab.

Prop	Default	Required	Example values
`label`	`null`	—	—
`items`	`[]`	—	—
`collapsible`	`false`	—	—
`defaultCollapsed`	`false`	—	—

blade

<lyra:sidebar-group label="Workspace" collapsible :items="[
    ['id' => 'overview', 'label' => 'Overview', 'active' => true],
    ['id' => 'projects', 'label' => 'Projects', 'badge' => '12'],
    ['id' => 'members', 'label' => 'Members'],
]" />