NcDashboardWidgetItem
Props
Prop name | Description | Type | Values | Default |
---|---|---|---|---|
id | The item id (optional) | string|number | - | undefined |
targetUrl | The item element is a link to this URL (optional) | string | - | undefined |
avatarUrl | Where to get the avatar image. (optional) Used if avatarUsername is not defined. | string | - | undefined |
avatarUsername | Name to provide to the Avatar. (optional) Used if avatarUrl is not defined. | string | - | undefined |
avatarIsNoUser | Is the avatarUsername not a user's name? (optional, false by default) | boolean | - | false |
overlayIconUrl | Small icon to display on the bottom-right corner of the avatar (optional) | string | - | undefined |
mainText | Item main text (mandatory) | string | - | |
subText | Item subline text (optional) | string | - | '' |
itemMenu | An object containing context menu entries that will be displayed for each items (optional) | object | - | {} |
forceMenu | Specify whether the 3 dot menu is forced when only one action is present | boolean | - | true |
Events
Event name | Properties | Description |
---|---|---|
<undefined> |
Slots
Name | Description | Bindings |
---|---|---|
avatar | Slot for passing a user avatar. | |
actions | This 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.