Skip to content

BaseMenuList

Base Component for SideBar Menu Entries (this component is currently not ssr-capable)

Props

Prop nameDescriptionTypeValuesDefault
selectActivedefine if entries are selectable -> d.h. the selectboxes are showingboolean-false
listlist of menu entries - array of objects
v-model:list may be used on this prop
Entry properties that can be displayed:

required:
id string - give every item an unique id

optional:
title string - main text line in the list item
description string - second text line in the list item
active boolean - steer from outside if item should be displayed active (with left
side color border)
selected boolean - steer from outside if entry select box should be checked
disabled boolean - steer from outside if entry select box should be disabled
icon string - a valid BaseIcon icon name

Also see BaseMenuEntry component for more information on
the mentioned properties.
array-[]
activeEntryindex of the entry that should currently be active
TODO: check if it would be better to use id here!
number--1
selectedListprovide a list of entries that should appear selectedarray-[]
useDraggablemake the single menu list items draggableboolean-false
dragNamespecify the group name for the drag receiver
important: if you intend to use the drag functionality set useDraggable
to true
string-'menuEntry'

Events

Event namePropertiesDescription
selectedindex string - the index of the selected item
selected boolean - was items selected
event emitted when entry is clicked and select is active
clickedundefined String - the index of the respective entryevent emitted when a menu entry is clicked
update:list

Slots

NameDescriptionBindings
entry-text-contentuse this slot to individualize the displayed text peritem Object - the complete entry provided by list
entry-right-side-elementsuse this slot to add elements to the right side of an entry. This slot contentis-selected boolean - was item selected
item Object - the complete entry provided by list
thumbnailsUse this scoped slot to supply a list of thumbnails (i.e. BaseIcon) for item, where item is one list element. See also the example below.

Demo

Example of BaseMenuEntry with various entry thumbnails supplied via thumbnails slot.