aboutsummaryrefslogtreecommitdiffstats
path: root/lib/public/Dashboard/IIconWidget.php
diff options
context:
space:
mode:
Diffstat (limited to 'lib/public/Dashboard/IIconWidget.php')
-rw-r--r--lib/public/Dashboard/IIconWidget.php25
1 files changed, 25 insertions, 0 deletions
diff --git a/lib/public/Dashboard/IIconWidget.php b/lib/public/Dashboard/IIconWidget.php
new file mode 100644
index 00000000000..203a89279b0
--- /dev/null
+++ b/lib/public/Dashboard/IIconWidget.php
@@ -0,0 +1,25 @@
+<?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;
+}