Sidebar

Sidebar content

The sidebar is a basic version, working as a container that provides a flexible shell for your content.

UX/UI Guidelines

Check the design documentation of the component in ZeroHeight.

Implementations

The component Sidebar is available in the following technologies:

CSS Components

Web Components

Parameters

Parameters

Parameters are the attributes that can be used to customize the component when using it in a project. They apply to the WebComponents implementation and wrappers and to the Vue and React CSS implementations. Some parameters names change between the implementations, in order to follow the conventions of each technology and framework.

For example, the param model is named ngModel in Angular, modelValue in Vue, but stays as model in React.

By default, all the parameters are optional or can be set in different, except for the ones marked as required

The parametrization of the component can be done with the following custom params or properties:

Name	Type	Slottable	Description
config	string		Position of the sidebar
open	boolean		Whether the sidebar is open or not
custom	object		A record of key-value pairs to set the CSS custom tokens. It's a complex attribute set as an JS object in stringified JSON format. Example: <z-sidebar custom='{"fill":"#06e7a3"}' />
custom-str	string		The stringified version of the custom property. It follows the pattern key:value;key:value;, with the possibility of setting multiple values and spaces between the punctuation characters. Example: <z-sidebar custom-str="fill:#06e7a3" />
z-theme	string		Sets the theme of the component. The possible values are light and dark. <z-sidebar z-theme="dark" />

From Figma to code

...

Customization

INFO

Check everything about the customization mechanics in the "How it works" documentation.

CSS Variable	Type	Description
--z-sidebar--bg	color	Background color of the sidebar
--z-sidebar--color	color	Text color of the sidebar
--z-sidebar--padding	distance	Padding of the sidebar
--z-sidebar--top	distance	Top position of the sidebar
--z-sidebar--radius	distance	Border radius of the sidebar
--z-sidebar--width	distance	Width of the sidebar

Both background and text color can be customized using the --z-sidebar--bg and --z-sidebar--color tokens.

Also the padding, top-position, radius and width of the sidebar can be customized using the --z-sidebar--padding, --z-sidebar--top, --z-sidebar--radius and --z-sidebar--width tokens.

Sidebar content

Accessibility

...

Related components