Sidebar

Full Description

Name	Type	Default Value
children	any
children components
className	string
user classes for the main HTML tag
innerRef	(object \| Function \| string)
ref to the main tag
fixed	boolean	true
set fixed type of sidebar
unfoldable	boolean
set unfoldable type of sidebar
overlaid	boolean
set overlaid type of sidebar
breakpoint	(false \| \| sm \| md \| lg \| xl)	lg
set sidebar breakpoint
minimize	boolean
show minimize verson of sidebar
show	(true \| false \| responsive)	responsive
show/hide the sidebar
size	(sm \| lg \| xl)
set the size of sidebar
hideOnMobileClick	boolean	true
determine the hide effect on mobile
aside	boolean
set the type to aside
colorScheme	string	dark
color scheme
dropdownMode	(openActive \| close \| closeInactive \| noAction)
set dropdown effect
onShowChange	Function
on show state change callback
onMinimizeChange	Function
on minimize change callback

Render CBrand version for sidebar component.

Render CButtonClose version for sidebar component.

Name	Type	Default Value
tag	(Function \| string)	div
main HTML tag name
className	string
user classes for the main HTML tag
innerRef	(object \| Function \| string)
ref to the main tag

Name	Type	Default Value
tag	(Function \| string)	div
main HTML tag name
className	string
user classes for the main HTML tag
innerRef	(object \| Function \| string)
ref to the main tag

Name	Type	Default Value
tag	(Function \| string)	div
main HTML tag name
className	string
user classes for the main HTML tag
innerRef	(object \| Function \| string)
ref to the main tag

Name	Required	Type	Default Value
className		string
user classes for the main HTML tag
innerRef		(object \| Function \| string)
ref to the main tag

Name	Required	Type	Default Value
className		string
user classes for the main HTML tag
children		any
children components
innerRef		(object \| Function \| string)
ref to the main tag

Name	Required	Type	Default Value
className		string
user classes for the main HTML tag
children		any
children components
innerRef		(object \| Function \| string)
ref to the main tag
name		string
icon		(object \| string)
fontIcon		string
show		boolean
route		string

Name	Required	Type	Default Value
className		string
user classes for the main HTML tag
innerRef		(object \| Function \| string)
ref to the main tag

Name	Required	Type	Default Value
className		string
user classes for the main HTML tag
innerRef		(object \| Function \| string)
ref to the main tag

Name	Required	Type	Default Value
children		any
children components
className		string
user classes for the main HTML tag
innerRef		(Function \| string \| object)
ref to the main tag
icon		(string \| object)
use if you want to add icon as CIcon component; available options: - string - if you need to pass only CIcon 'name' prop, - object - if you want to pass more of CIcon props/ attributes
fontIcon		string
use if you want to add css font icon; value of prop are css classes of the icon
badge		object
if set badge will be displayed on the right side of the link; keys in object are CBadge component props, content of the badge is defined by additional 'text' key
addLinkClass		string
add classes to link element
label		boolean
sets link to label style
name		string
sets text of the item
color		string
background color