@wix/design-system
Version:
@wix/design-system
55 lines (51 loc) • 1.56 kB
Markdown
### dataHook
- type: string
- description: The dataHook of the Sidebar
### className
- type: string
- description: The classes of the Sidebar
### children
- type: React.ReactNode
- description: Sidebar menu children
### skin
- type: SidebarSkin
- description: Sets the skin of the Sidebar
### header
- type: React.ReactNode
- description: Renders header element
### footer
- type: React.ReactNode
- description: Renders footer element
### hidden
- type: boolean
- description: Controls if the sidebar is shown or hidden, using an animation to switch between the two
### selectedKey
- type: string
- description: The selected item key
### isLoading
- type: boolean
- description: Control whether the sidebar displays a loading animation, true by default
### ariaLabel
- type: string
- description: Define a string that labels the current element in case where a text label is not visible on the screen
### width
- type: string | number
- description: Defines the width
### minimized
- type: boolean
- description: Enables minimized mode
### enableMinimizeToggle
- type: boolean
- description: Enables toggle button
### minimizeToggleTooltip
- type: string
- description: Defines the tooltip content of minimization toggle.
### onMinimizeToggleClick
- type: () => void
- description: Defines a callback function which is called every time a minimize toggle button is clicked.
### zIndex
- type: number
- description: Defines the z-index of the sidebar.
### next
- type: boolean
- description: Defined if to use new sidebar design (when less then 3 levels)