Sidebar

Collapsible application sidebar navigation panel.

Package: @solidiom/sidebar
Version: 0.6.0
Status: experimental

Generated from the package's public source.

API

`Content`component

                        Content(props: SidebarContentProps): Element

Props

class?: string
style?: string | CSSProperties

children: Element

View source

                        Footer(props: SidebarFooterProps): Element

Props

class?: string
style?: string | CSSProperties

children: Element

View source

`Header`component

                        Header(props: SidebarHeaderProps): Element

Props

class?: string
style?: string | CSSProperties

children: Element

View source

`Panel`component

                        Panel(props: SidebarPanelProps): Element

Props

aria-label?: string — Accessible label for the navigation landmark.
class?: string
style?: string | CSSProperties

children: Element

View source

`Rail`component

                        Rail(props: SidebarRailProps): Element

Props

class?: string
style?: string | CSSProperties

children: Element

View source

`Root`component

                        Root(props: SidebarRootProps): Element

Props

collapsedWidth?: string — Width when collapsed.
collapsible?: boolean — Whether the sidebar can be collapsed.
defaultOpen?: boolean — Default open state (uncontrolled).
disabled?: boolean — Disable all interactions.
expandedWidth?: string — Width when expanded.
onOpenChange?: (open: boolean) => void — Called when open/collapsed state changes.
open?: Accessor<boolean> — Controlled open state.
side?: "left" | "right" — Which side the sidebar is on.

children: Element

View source

`SidebarContentProps`interface

Props

class?: string
style?: string | CSSProperties

children: Element

View source

`SidebarFooterProps`interface

Props

class?: string
style?: string | CSSProperties

children: Element

View source

`SidebarHeaderProps`interface

Props

class?: string
style?: string | CSSProperties

children: Element

View source

`SidebarPanelProps`interface

Props

aria-label?: string — Accessible label for the navigation landmark.
class?: string
style?: string | CSSProperties

children: Element

View source

`SidebarRailProps`interface

Props

class?: string
style?: string | CSSProperties

children: Element

View source

`SidebarRootProps`interface

Props

collapsedWidth?: string — Width when collapsed.
collapsible?: boolean — Whether the sidebar can be collapsed.
defaultOpen?: boolean — Default open state (uncontrolled).
disabled?: boolean — Disable all interactions.
expandedWidth?: string — Width when expanded.
onOpenChange?: (open: boolean) => void — Called when open/collapsed state changes.
open?: Accessor<boolean> — Controlled open state.
side?: "left" | "right" — Which side the sidebar is on.

children: Element

View source

`SidebarTriggerProps`interface

Props

class?: string
style?: string | CSSProperties

children: Element

View source

`Trigger`component

                        Trigger(props: SidebarTriggerProps): Element

Props

class?: string
style?: string | CSSProperties

children: Element

View source

API

#Contentcomponent

Props

#Footercomponent

Props

#Headercomponent

Props

#Panelcomponent

Props

#Railcomponent

Props

#Rootcomponent

Props

#SidebarContentPropsinterface

Props

#SidebarFooterPropsinterface

Props

#SidebarHeaderPropsinterface

Props

#SidebarPanelPropsinterface

Props

#SidebarRailPropsinterface

Props

#SidebarRootPropsinterface

Props

#SidebarTriggerPropsinterface

Props

#Triggercomponent

Props

`Content`component

`Footer`component

`Header`component

`Panel`component

`Rail`component

`Root`component

`SidebarContentProps`interface

`SidebarFooterProps`interface

`SidebarHeaderProps`interface

`SidebarPanelProps`interface

`SidebarRailProps`interface

`SidebarRootProps`interface

`SidebarTriggerProps`interface

`Trigger`component