useSidebar() — ui Function Reference

Architecture documentation for the useSidebar() function in sidebar.tsx from the ui codebase.

Function tsx DocumentationAtlas Changelog called by 4

Entity Profile

DocumentationAtlas→ Changelog→ useSidebar() — ui Function Reference

Dependency Diagram

graph TD
  51e5796c_e5a5_e248_0af5_922f70c3662a["useSidebar()"]
  c3d1b2a8_7455_5144_ec35_453b78980e06["sidebar.tsx"]
  51e5796c_e5a5_e248_0af5_922f70c3662a -->|defined in| c3d1b2a8_7455_5144_ec35_453b78980e06
  19718d2f_02e2_1cf3_3c58_c008e9334d6d["Sidebar()"]
  19718d2f_02e2_1cf3_3c58_c008e9334d6d -->|calls| 51e5796c_e5a5_e248_0af5_922f70c3662a
  d5d9b59c_3b3d_65e4_fcd6_ff9429078d1a["SidebarTrigger()"]
  d5d9b59c_3b3d_65e4_fcd6_ff9429078d1a -->|calls| 51e5796c_e5a5_e248_0af5_922f70c3662a
  35b3b74a_d011_926d_c90e_5cf11ddbce5c["SidebarRail()"]
  35b3b74a_d011_926d_c90e_5cf11ddbce5c -->|calls| 51e5796c_e5a5_e248_0af5_922f70c3662a
  719a0e88_3d3f_5d70_3954_ed2652739559["SidebarMenuButton()"]
  719a0e88_3d3f_5d70_3954_ed2652739559 -->|calls| 51e5796c_e5a5_e248_0af5_922f70c3662a
  style 51e5796c_e5a5_e248_0af5_922f70c3662a fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

apps/v4/examples/radix/ui/sidebar.tsx lines 45–52

function useSidebar() {
  const context = React.useContext(SidebarContext)
  if (!context) {
    throw new Error("useSidebar must be used within a SidebarProvider.")
  }

  return context
}