AppSidebar

The collapsible navigation sidebar of the admin layout.

Installation

pnpm dlx shadcn@latest add @chelone/app-sidebar
Loading preview…

The collapsible navigation sidebar of the admin layout.

Props

PropTypeDefaultDescription
appBarAlwaysOnboolean—When `true`, signals that the AppBar is always visible (not hidden on scroll). Accepted for forward-compat; not otherwise consumed here.
brandReactNode—Brand label rendered in the sidebar header. Defaults to `"Chelone"`.
brandHrefstring—Where the brand links to as a plain anchor, with no router and no basename prefix: for a link out of the app, such as the site home. Wins over `brandTo`. A `javascript:` or other unsafe scheme renders no `href`.
brandIconReactNode—Brand icon rendered before the label. Defaults to the `Shell` icon.
brandTostring—Where the brand links to, used as given (not prefixed with the basename). Defaults to the dashboard under the basename.
childrenReactNode—Replaces the default `<Menu />` rendered inside the content area. Pass a custom navigation tree for full control over sidebar items.
closedSizenumber—Width of the sidebar in its collapsed/icon-only state, in pixels. Defaults to 48: the 32px icon button plus the 8px padding on each side.
sizenumber—Width of the sidebar in its open/expanded state, in pixels. Defaults to 240.