Sidebar

A sidebar component which handles device resizing and remove scroll bar automatically.

Usage

import * as Base from 'fumadocs-core/sidebar';
 
return (
  <Base.SidebarProvider>
    <Base.SidebarTrigger />
    <Base.SidebarList />
  </Base.SidebarProvider>
);

Prop	Type	Default
`children`	`ReactNode`	-
`onOpenChange?`	`((v: boolean) => void)`	-
`open?`	`boolean`	-

Opens the sidebar on click.

Prop	Type	Default
`as?`	`ElementType`	-

Data Attribute	Values	Description
`data-open`	`true, false`	Is sidebar opening

Prop	Type	Default
`removeScrollOn?`	`string`	-
`as?`	`ElementType`	-
`blockScrollingWidth?`	`number`	-

Usage

Sidebar Provider

Sidebar Trigger

Sidebar List

On this page