Skip to content
On this page

NcDashboardWidgetItem

Props

Prop nameDescriptionTypeValuesDefault
idThe item id (optional)string|number-undefined
targetUrlThe item element is a link to this URL (optional)string-undefined
avatarUrlWhere to get the avatar image. (optional) Used if avatarUsername is not defined.string-undefined
avatarUsernameName to provide to the Avatar. (optional) Used if avatarUrl is not defined.string-undefined
avatarIsNoUserIs the avatarUsername not a user's name? (optional, false by default)boolean-false
overlayIconUrlSmall icon to display on the bottom-right corner of the avatar (optional)string-undefined
mainTextItem main text (mandatory)string-
subTextItem subline text (optional)string-''
itemMenuAn object containing context menu entries that will be displayed for each items (optional)object-{}
forceMenuSpecify whether the 3 dot menu is forced when only one action is presentboolean-true

Events

Event namePropertiesDescription
<undefined>

Slots

NameDescriptionBindings
avatarSlot for passing a user avatar.
actionsThis slot can be used to provide actions for each dashboard widget item.

General description

This component is meant to be used inside a DashboardWidget component.