useSidebar() — ui Function Reference

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

Function tsx DocumentationAtlas ContentSourcing called by 4

Entity Profile

DocumentationAtlas→ ContentSourcing→ useSidebar() — ui Function Reference

Dependency Diagram

graph TD
  8c33e434_24fc_7386_9971_8b2330bfde84["useSidebar()"]
  cc4e35e8_a38d_157c_ff53_3fbfa32c26c4["sidebar.tsx"]
  8c33e434_24fc_7386_9971_8b2330bfde84 -->|defined in| cc4e35e8_a38d_157c_ff53_3fbfa32c26c4
  0bfd3aff_8b44_f2c7_dcb9_4f9f30be7262["Sidebar()"]
  0bfd3aff_8b44_f2c7_dcb9_4f9f30be7262 -->|calls| 8c33e434_24fc_7386_9971_8b2330bfde84
  da751867_f6c7_993f_fec2_dfc53db4c492["SidebarTrigger()"]
  da751867_f6c7_993f_fec2_dfc53db4c492 -->|calls| 8c33e434_24fc_7386_9971_8b2330bfde84
  b4914d34_4bf4_0707_b89a_9653eff9727f["SidebarRail()"]
  b4914d34_4bf4_0707_b89a_9653eff9727f -->|calls| 8c33e434_24fc_7386_9971_8b2330bfde84
  55cd097b_ebd6_e97d_603e_bd000ddc2ce4["SidebarMenuButton()"]
  55cd097b_ebd6_e97d_603e_bd000ddc2ce4 -->|calls| 8c33e434_24fc_7386_9971_8b2330bfde84
  style 8c33e434_24fc_7386_9971_8b2330bfde84 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

apps/v4/examples/base/ui-rtl/sidebar.tsx lines 46–53

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

  return context
}