# BaseMenuList
Base Component for SideBar Menu Entries (this component is currently not ssr-capable)
# Props
Prop name | Description | Type | Values | Default |
---|---|---|---|---|
selectActive | define if entries are selectable -> d.h. the selectboxes are showing | boolean | - | false |
list | list of menu entries - array of objects Entry properties that can be displayed: required: id string - give every item an unique idoptional: title string - main text line in the list itemdescription string - second text line in the list itemactive boolean - steer from outside if item should be displayed active (with leftside color border) selected boolean - steer from outside if entry select box should be checkeddisabled boolean - steer from outside if entry select box should be disabledicon string - a valid BaseIcon icon nameAlso see BaseMenuEntry component for more information on the mentioned properties. | array | - | [] |
activeEntry | index of the entry that should currently be active TODO: check if it would be better to use id here! | number | - | -1 |
selectedList | provide a list of entries that should appear selected | array | - | [] |
dragName | specify the group name for the drag receiver | string | - | 'menuEntry' |
# Events
Event name | Properties | Description |
---|---|---|
clicked | undefined String - the index of the respective entry | event emitted when a menu entry is clicked |
selected | index string - the index of the selected itemselected boolean - was items selected | event emitted when entry is clicked and select is active |
# Slots
Name | Description | Bindings |
---|---|---|
entry-text-content | use this slot to individualize the displayed text per | item Object - the complete entry provided by list |
entry-right-side-elements | use this slot to add elements to the right side of an entry. This slot content | is-selected boolean - was item selecteditem Object - the complete entry provided by list |
thumbnails | Use 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.