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
  363cda72_4f98_6d25_8ff6_0da233bec045["useSidebar()"]
  334954a9_5573_f901_08c0_da02d404f69b["sidebar.tsx"]
  363cda72_4f98_6d25_8ff6_0da233bec045 -->|defined in| 334954a9_5573_f901_08c0_da02d404f69b
  23171d57_3af4_605b_e43c_b46139668564["Sidebar()"]
  23171d57_3af4_605b_e43c_b46139668564 -->|calls| 363cda72_4f98_6d25_8ff6_0da233bec045
  0890270f_6355_ae97_b5cc_c089a1583836["SidebarTrigger()"]
  0890270f_6355_ae97_b5cc_c089a1583836 -->|calls| 363cda72_4f98_6d25_8ff6_0da233bec045
  deaea569_4a13_1905_bdcc_f7a0006868bd["SidebarRail()"]
  deaea569_4a13_1905_bdcc_f7a0006868bd -->|calls| 363cda72_4f98_6d25_8ff6_0da233bec045
  6dda20f9_caec_7e22_afaf_af3322019b0b["SidebarMenuButton()"]
  6dda20f9_caec_7e22_afaf_af3322019b0b -->|calls| 363cda72_4f98_6d25_8ff6_0da233bec045
  style 363cda72_4f98_6d25_8ff6_0da233bec045 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

apps/v4/examples/base/ui/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
}