Skip to main content

Sidebar API overview

Sidebar methods#

NameDescription
collapse()collapses a sidebar
destructor()removes a Sidebar instance and releases occupied resources
disable()disables and dims items of Sidebar
enable()enables disabled items of Sidebar
expand()expands a sidebar
getSelected()returns an array of IDs of selected items
hide()hides items of Sidebar
isCollapsed()checks whether Sidebar is collapsed
isDisabled()checks whether an item of Ribbon is disabled
isSelected()checks whether a specified Sidebar item is selected
paint()repaints Sidebar on a page
select()selects a specified Sidebar item
show()shows items of Sidebar
toggle()expands/collapses Sidebar
unselect()unselects a selected Sidebar item
important

Use TreeCollection methods to work with data.

Sidebar events#

NameDescription
afterCollapsefires after collapsing a sidebar
afterExpandfires after expanding a sidebar
afterHidefires after hiding an item of Sidebar
beforeCollapsefires before collapsing a sidebar
beforeExpandfires before expanding a sidebar
beforeHidefires before hiding an item of Sidebar
clickfires after a click on a control
inputBlurfires when a control is blurred
inputCreatedfires when a new input is added
inputFocusfires when a control is focused
openMenufires on expanding a menu control
important

Use TreeCollection events to work with data.

Sidebar properties#

NameDescription
collapseddefines that a sidebar is initialized in the collapsed state
cssadds style classes to Sidebar
dataspecifies an array of data objects to set into Sidebar
menuCssadds style classes to all containers of Sidebar controls with nested items
minWidthsets the minimal width of a sidebar in the collapsed state
widthsets the width of a sidebar

Sidebar Custom HTML properties#

A Custom HTML control can possess the following properties.

Sidebar MenuItem properties#

A MenuItem control may have the following properties.

Sidebar NavItem properties#

A NavItem control can have the following properties.

Sidebar Separator properties#

A Separator control may possess the following properties.

Sidebar Spacer properties#

A Spacer control may have the following properties.

Sidebar Title properties#

A Title control may possess the following properties.