Skip to content

SideBar

SideBars são componentes utilizados para criar soluções de navegação e menus.



Recomendamos o uso de SideBars quando:

  • For necessário separar o conteúdo por páginas e navergar por elas.
  • Não for o caso de utilizar soluções como sideBar, sidebars, cards ou links como navegação.

Não recomendamos o uso de SideBars quando:

  • Houver muitos itens a serem mostrados no menu.
  • For necessário mostrar os links verticalmente.

Obs.:

  • No objeto de configuração são aceitas as propriedades label, icon, type, route e items;
  • O type pode ser assumir 3 valores:
    • route, para rotas internas (é renderizado um router-link com elas);
    • link para elementos que não devem redirecionar para nenhnuma rota;
    • external para links que devem ser abertos em uma nova guia;

Uso

js
<CdsSideBar
	variant="green"
	:items
	:activeItem="items[4]"
	userName="Joana Mendes"
	userRole="Administradora"
	userPicture="https://thispersondoesnotexist.com/"
	:collapsible="true"
	:collapsibleState="false"
	logoImage="https://framerusercontent.com/images/Xdjpf9nazmZOoS2SUnbbkwsaFk.png"
	:light="false"
	:searchButton="false"
	:show-logout="false"
	@sidebar-click="logClick"
	@search-button-click="logSearchButtonClick"
	@collapse-click="logCollapseClick"
	@logout="logLogout"
>
	<template #logo>
		<img
			v-if="!args.light"
			src="https://framerusercontent.com/images/Xdjpf9nazmZOoS2SUnbbkwsaFk.png"
		>
		<img
			v-else
			src="https://framerusercontent.com/images/cF8DHaPnyhgullDGcpLnyXwGUp4.png"
		>
	</template>
</CdsSideBar>

Preview

Mostrar log

Props

Nome
Tipo
Default
Opções
Descrição
variantstring'green'green
teal
blue
indigo
violet
pink
red
orange
amber
dark
A variante de cor. São 10 variantes implementadas: 'green', 'teal', 'blue', 'indigo', 'violet', 'pink', 'red', 'orange','amber' e 'white'. A variante só terá efeito quando a SideBar estiver no modo light.
* items (required)array[] -- Define a lista dos itens do SideBar a serem mostrados. Os itens da lista devem ser objetos com path ou route, e com uma label
* activeItem (required)object{} -- O item ativo da SideBar
showLogoutbooleantrue -- Controla exibição do botão "sair" no footer da sidebar
showProfileMenubooleanfalse -- Controla exibição do menu/dropdown ao clicar nas informações de perfil
profileMenuItemsarray[] -- Controla os itens do menu/dropdown exibidos ao clicar nas informações de perfil
userNamestring'' -- Nome do usuário logado. Essa informação é colocada ao lado do Avatar
userRolestring'' -- Perfil do usuário logado. Essa informação é colocada ao lado do Avatar
userPicturestringnull -- Imagem do usuário logado. Informação é usada para montar o Avatar
collapsiblebooleanfalse -- Permite que a sidebar seja colapsada em uma versão mínima
collapsibleStatebooleannull -- Controla o estado da sidebar, se aberta ou colapsada.
logoImagestringnull -- Imagem do logo que será renderizada
lightbooleanfalse -- Ativa o modo light da sidebar
searchButtonbooleanfalse -- Ativa o modo light da sidebar

Eventos

Nome
Descrição
@search-button-click
@logout
@sidebar-click
@collapse-click
@profile-menu-option-click
@logo-click

Slots

Nome
Descrição
#logo

Última atualização:

Released under the Apache-2.0 License.