0
0
mirror of https://github.com/nextcloud/server.git synced 2024-12-29 00:18:42 +00:00
nextcloud_server/lib/public/Dashboard/IIconWidget.php
Joas Schilling 37d331233c fix(dashboard): Document expected icon behaviour
Signed-off-by: Joas Schilling <coding@schilljs.com>
Signed-off-by: nextcloud-command <nextcloud-command@users.noreply.github.com>
2024-07-11 13:14:03 +00:00

26 lines
580 B
PHP

<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: 2022 Nextcloud GmbH and Nextcloud contributors
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace OCP\Dashboard;
/**
* Allow getting the absolute icon url for a widget
*
* @since 25.0.0
*/
interface IIconWidget extends IWidget {
/**
* Get the absolute url for the widget icon (should be colored black or not have a color)
*
* The icon will be inverted automatically in mobile clients and when using dark mode
*
* @return string
* @since 25.0.0
*/
public function getIconUrl(): string;
}