Dashboard
The dashboard app aims to provide the user with a general overview of their Nextcloud and shows information that is currently important.
App developers can integrate into the dashboard app and provide their own widgets.
Register a dashboard widget
A dashboard widget is represented by a class implementing the OCP\Dashboard\IWidget interface. This class will be instantiated whenever the dashboard is loaded. Any bootstrap code that is needed for the widget can be implemented inside of the load method and will be called when the dashboard is loaded.
<?php
namespace OCA\MyApp\Dashboard;
use OCP\Dashboard\IWidget;
use OCP\IInitialStateService;
use OCP\IL10N;
use OCP\IURLGenerator;
use OCP\IUserSession;
class MyAppWidget implements IWidget {
private IInitialStateService $initialStateService;
private IL10N $l10n;
private IURLGenerator $urlGenerator;
public function __construct(
IInitialStateService $initialStateService,
IL10N $l10n,
IURLGenerator $urlGenerator
) {
$this->initialStateService = $initialStateService;
$this->l10n = $l10n;
$this->urlGenerator = $urlGenerator;
}
/**
* @return string Unique id that identifies the widget, e.g. the app id
*/
public function getId(): string {
return 'myappwidgetid';
}
/**
* @return string User facing title of the widget
*/
public function getTitle(): string {
return $this->l10n->t('My app');
}
/**
* @return int Initial order for widget sorting
* in the range of 10-100, 0-9 are reserved for shipped apps
*/
public function getOrder(): int {
return 0;
}
/**
* @return string css class that displays an icon next to the widget title
*/
public function getIconClass(): string {
return 'icon-class';
}
/**
* @return string|null The absolute url to the apps own view
*/
public function getUrl(): ?string {
return $this->urlGenerator->linkToRouteAbsolute('myapp.view.index');
}
/**
* Execute widget bootstrap code like loading scripts and providing initial state
*/
public function load(): void {
$this->initialStateService->provideInitialState('myapp', 'myData', []);
\OCP\Util::addScript('myapp', 'dashboard');
}
}
The MyAppWidget class needs to be registered during the app bootstrap.
<?php
declare(strict_types=1);
namespace OCA\MyApp\AppInfo;
use OCP\AppFramework\App;
use OCP\AppFramework\Bootstrap\IBootContext;
use OCP\AppFramework\Bootstrap\IBootstrap;
use OCP\AppFramework\Bootstrap\IRegistrationContext;
use OCA\MyApp\Dashboard\MyAppWidget;
class Application extends App implements IBootstrap {
public const APP_ID = 'myapp';
public function __construct(array $urlParams = []) {
parent::__construct(self::APP_ID, $urlParams);
}
public function register(IRegistrationContext $context): void {
$context->registerDashboardWidget(MyAppWidget::class);
}
public function boot(IBootContext $context): void {
}
}
The IConditionalWidget interface
The IConditionalWidget interface adds the isEnabled method to provide the option for a widget to opt-out later. While registering the widget the information whether or not a widget should be displayed to the specific user might not be available or to complex to calculate up front. In this case the IConditionalWidget allows you to check the conditions only when really needed.
public function isEnabled(): bool {
return false;
}
Provide a user interface
The user interface can be registered through the public OCA.Dashboard.register JavaScript method. The first parameter represents the widget id that has already been specified in the IWidget implementation. The callback parameter will be called to render the widget in the frontend. The user interface can be added to the provided DOM element el.
The following example shows how a Vue.js component could be used to render the widget user interface, however this approach works for any other framework as well as plain JavaScript:
import Dashboard from './components/Dashboard.vue'
document.addEventListener('DOMContentLoaded', () => {
OCA.Dashboard.register('myappwidgetid', (el) => {
const View = Vue.extend(Dashboard)
const vm = new View({
propsData: {},
store,
}).$mount(el)
})
})
Dashboard API
Render dashboard widgets using the API
Added in version 27.1.
Dashboard widgets can be rendered in the browser using the dashboard API. This allows to render widgets without any JavaScript and frontend code. This new method is beneficial for performance as the widgets are rendered from API data using a generic vue.js component provided by the Dashboard app.
To render a widget using the new API, you need to implement the OCP\Dashboard\IAPIWidgetV2 interface. Optionally, you may implement the OCP\Dashboard\IReloadableWidget interface to have the widget reload periodically.
Providing widgets to clients
To provide more information about your widget through the dashboard API for clients, you can implement those additional interfaces:
IButtonWidget to add buttons to be rendered by the client in the widget
IIconWidget to set the widget icon URL
IOptionWidget to set additional options
IAPIWidget to actually provide the widget content (the item list)
The IIconWidget interface
The IIconWidget interface adds the getIconUrl method to provide the URL to the widget icon. In the following example it returns the URL to the img/app.svg file in your app.
public function getIconUrl(): string {
return $this->urlGenerator->getAbsoluteURL(
$this->urlGenerator->imagePath(Application::APP_ID, 'app.svg')
);
}
The IOptionWidget interface
The IOptionWidget interface adds the getWidgetOptions method to provide additional widget options. It returns a WidgetOptions object which only contains the roundItemIcons boolean value for now. This tells the clients if the widget item icons should be rounded or kept as squares.
public function getWidgetOptions(): WidgetOptions {
return new WidgetOptions(true);
}
The IAPIWidget interface
If you want your widget content to be accessible with the dashboard API for Nextcloud clients, it must implement the OCP\Dashboard\IAPIWidget interface rather than OCP\Dashboard\IWidget. This interface contains an extra getItems method which returns an array of OCP\DashboardModel\WidgetItem objects.
/**
* @inheritDoc
*/
public function getItems(string $userId, ?string $since = null, int $limit = 7): array {
return $this->myService->getWidgetItems($userId, $since, $limit);
}
OCP\DashboardModel\WidgetItem contains the item information. Its constructor is:
public function __construct(string $title = '',
string $subtitle = '',
string $link = '',
string $iconUrl = '',
string $sinceId = '');
title: The main widget text content
subtitle: The secondary text content
link: A link to the target resource
iconUrl: URL to a square icon (svg or jpg/png of at least 44x44px)
sinceId: Item ID or timestamp. The client will then send the latest known sinceId in next dashboard API request.
Added in version 27.1.
overlayIconUrl: Small overlay icon to show in the bottom right corner of iconUrl. This is used by the activity widget to show the activity type icon.
The IAPIWidgetV2 interface
If you want to render a widget in the browser using this API you must implement the OCP\Dashboard\IAPIWidgetV2 interface. The widget registration does not change compared to the old method. The type of a widget will be detected automatically during the registration. When migrating old, JavaScript based widgets the load method should be left empty.
This interface adds a single method getItemsV2 which returns OCP\Dashboard\Model\WidgetItems.
/**
* @inheritDoc
*/
public function getItemsV2(string $userId, ?string $since = null, int $limit = 7): WidgetItems {
return $this->myService->getWidgetItemsV2($userId, $since, $limit);
}
OCP\DashboardModel\WidgetItems contains the all items and additional meta information to render the widget. Its constructor is:
public function __construct(
private array $items = [],
private string $emptyContentMessage = '',
private string $halfEmptyContentMessage = '',
)
items: An array of OCP\DashboardModel\WidgetItem.
emptyContentMessage: The message to show if no items are available.
halfEmptyContentMessage: An optional message to show above the item list. This is useful if there are no important items but you still want to show some items to the user. Have a look at the following example from the Talk app:
Here is a full example of a widget that implements the OCP\Dashboard\IAPIWidgetV2 interface:
<?php
class MyWidget implements IButtonWidget, IIconWidget, IReloadableWidget {
public function __construct(
private IL10N $l10n,
private IURLGenerator $urlGenerator,
) {
}
/**
* @inheritDoc
*/
public function getId(): string {
return 'blazinglyfast';
}
/**
* @inheritDoc
*/
public function getTitle(): string {
return $this->l10n->t('My blazingly fast widget');
}
/**
* @inheritDoc
*/
public function getOrder(): int {
return 0;
}
/**
* @inheritDoc
*/
public function getIconClass(): string {
return 'icon-class';
}
/**
* @inheritDoc
*/
public function getIconUrl(): string {
return $this->urlGenerator->getAbsoluteURL(
$this->urlGenerator->imagePath('blazinglyfast', 'icon.svg')
);
}
/**
* @inheritDoc
*/
public function getUrl(): ?string {
return $this->urlGenerator->linkToRouteAbsolute('blazinglyfast.view.index');
}
/**
* @inheritDoc
*/
public function load(): void {
// No need to provide initial state or inject javascript code anymore
}
/**
* @inheritDoc
*/
public function getItemsV2(string $userId, ?string $since = null, int $limit = 7): WidgetItems {
// TODO
$items = [/* fancy items */];
return new WidgetItems(
$items,
empty($items) ? $this->l10n->t('No items') : '',
);
}
/**
* @inheritDoc
*/
public function getWidgetButtons(string $userId): array {
return [
new WidgetButton(
WidgetButton::TYPE_MORE,
$this->urlGenerator->linkToRouteAbsolute('blazinglyfast.view.index'),
$this->l10n->t('More items'),
),
];
}
/**
* @inheritDoc
*/
public function getReloadInterval(): int {
return 60;
}
}
The IReloadableWidget interface
The IReloadableWidget interface adds the getReloadInterval method to provide a periodic reload interval in seconds. New items will be requested from the OCS API after this interval to refresh the widget. Internally, the getItemsV2 method will be called to get the new items.
public function getReloadInterval(): int {
// Reload data every minute
return 60;
}
Note
This interface requires a widget to implement the OCP\Dashboard\IAPIWidgetV2 interface and won’t work with old widgets.
Use the API
The list of enabled widgets can be requested like that:
curl -u user:passwd https://my.nextcloud.org/ocs/v2.php/apps/dashboard/api/v1/widgets \
-H "Accept: application/json" \
-X GET
Example response:
{
"ocs": {
"meta": {
"status": "ok",
"statuscode": 200,
"message": "OK"
},
"data": {
"spreed": {
"id": "spreed",
"title": "Talk mentions",
"order": 10,
"icon_class": "dashboard-talk-icon",
"icon_url": "https://my.nextcloud.org/apps/spreed/img/app-dark.svg",
"widget_url": "https://my.nextcloud.org/index.php/apps/spreed/",
"item_icons_round": true,
"buttons": [
{
"type": "more",
"text": "More unread mentions",
"link": "https://my.nextcloud.org/index.php/apps/spreed/"
}
]
},
"github_notifications": {
"id": "github_notifications",
"title": "GitHub notifications",
"order": 10,
"icon_class": "icon-github",
"icon_url": "https://my.nextcloud.org/apps/integration_github/img/app-dark.svg",
"widget_url": "https://my.nextcloud.org/index.php/settings/user/connected-accounts",
"item_icons_round": true,
"buttons": [
{
"type": "more",
"text": "More notifications",
"link": "https://github.com/notifications"
}
]
},
}
}
}
The items list for each enabled widgets can be requested like that:
curl -u user:passwd http://my.nc/ocs/v2.php/apps/dashboard/api/v1/widget-items \
-H Content-Type:application/json \
-X GET \
-d '{"sinceIds":{"myappwidgetid":"2021-03-22T15:01:10Z","my_other_appwidgetid":"333"}}'
If your client periodically gets widget items content with this API, include the latest sinceId for each widget to avoid getting the items you already have.
Example response:
{
"ocs": {
"meta": {
"status": "ok",
"statuscode": 200,
"message": "OK"
},
"data": {
"github_notifications": [
{
"subtitle": "nextcloud-docker-dev#87",
"title": "Improve getting started",
"link": "https://github.com/juliushaertl/nextcloud-docker-dev/pull/87",
"iconUrl": "https://my.nextcloud.org/index.php/apps/integration_github/avatar/juliushaertl",
"sinceId": "2022-10-13T12:34:19Z"
},
{
"subtitle": "integration_github",
"title": "v1.0.11",
"link": "https://github.com/nextcloud/integration_github/releases",
"iconUrl": "https://my.nextcloud.org/index.php/apps/integration_github/avatar/nextcloud",
"sinceId": "2022-10-13T12:32:04Z"
},
{
"subtitle": "text#3209",
"title": "Rich workspaces: If there is no Readme.md, don’t show editor placeholder but move into \"+\" menu",
"link": "https://github.com/nextcloud/text/issues/3209",
"iconUrl": "https://my.nextcloud.org/index.php/apps/integration_github/avatar/nextcloud",
"sinceId": "2022-10-13T12:14:39Z"
}
],
"spreed": [
{
"subtitle": "- Send chat messages without notifying the recipients in case it is not urgent",
"title": "Talk updates ✅",
"link": "https://my.nextcloud.org/index.php/call/hw39yxkp",
"iconUrl": "https://my.nextcloud.org/core/img/actions/group.svg",
"sinceId": ""
},
{
"subtitle": "@roberto What's up?",
"title": "Jane",
"link": "https://my.nextcloud.org/index.php/call/z87agy2o",
"iconUrl": "https://my.nextcloud.org/index.php/avatar/toto/64",
"sinceId": ""
}
]
}
}
}