Sidebar

Organize secondary navigation in a collapsible side panel.

Sidebar

Default

Add a sidebar menu with the s-sidebar component, there are two subcomponents s-sidebar-item and s-sidebar-group

Group

You can group items and hide them with the s-sidebar-group sub-component.

The component has a slot: header in which we add a sub-component s-sidebar-item with the property arrow and without the property id to not change the active state when clicking

Code copied

Reduce

You can make the component 50px wide and only show the icons with the property reduce this property is dynamic

For the sidebar to work correctly it is necessary to add to the items the icon slot either with an icon or with for example the first letter of the text

Code copied

Hover expand

You can add the functionality to expand and collapse the sidebar with the mouse, with the property hover-expand

Code copied

Color

Change the color of the sidebar, if necessary you can also change the color of the text to white with the textWhite property

Code copied

Open

You can define if the sidebar is visible or hidden with the open property, this property by default is false

Code copied

Position Right

Change the position of the sidebar to the right and its animation with the right property

Code copied

API

PROPS

PropertyTypeValuesDescriptiondefaultExampleMore
open/v-model:openBooleantruefalseDetermines if the component is visible.
v-modelStringidDetermines the item that is in active status.
absolutebooleantruefalseDetermine if the component is of absolute position.
reduceBooleantruefalseDetermine if the component is in a reduced state with a width of 50px.
hover-expandBooleantruefalseAdds the functionality to expand when the user enters inside the sidebar and vice versa.
shapestringsquareDetermine if the component has no border radius
not-shadowBooleantruefalseRemove the shadow from the sidebar
backgroundStringTheme colorsRGBHEXChange the background color of the sidebar
text-whiteBooleantruefalseChange the text color to white
not-line-activeBooleantruefalseRemove the active line from items
s-sidebar-item:toStringurlGenerate a new vue-router route
s-sidebar-item:hrefStringurlGenerate a new route
rightBooleantruefalseDetermines if the component is positioned to the right
No matching data

SLOTS

PropertyTypeValuesDescriptiondefaultExampleMore
headerslotAdd the elements below the logo and above the items.
s-sidebar-item#iconslotIt is the space to add the icon or a representative letter.
No matching data
Last Updated: 2026-08-17, 08:33:54