aboutsummaryrefslogtreecommitdiffstats
path: root/lib/public
diff options
context:
space:
mode:
authorJoas Schilling <coding@schilljs.com>2024-07-11 13:24:10 +0200
committerbackportbot[bot] <backportbot[bot]@users.noreply.github.com>2024-07-19 08:06:30 +0000
commit66e1d866a21da982a8b00cda8927e46783813228 (patch)
tree3e1949979f837ce1746dccdc03a3636d8720f9b3 /lib/public
parentacc2571a0d0c76071f0da3cef33fda804f963118 (diff)
downloadnextcloud-server-66e1d866a21da982a8b00cda8927e46783813228.tar.gz
nextcloud-server-66e1d866a21da982a8b00cda8927e46783813228.zip
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> [skip ci]
Diffstat (limited to 'lib/public')
-rw-r--r--lib/public/Dashboard/IIconWidget.php4
-rw-r--r--lib/public/Dashboard/IWidget.php14
2 files changed, 16 insertions, 2 deletions
diff --git a/lib/public/Dashboard/IIconWidget.php b/lib/public/Dashboard/IIconWidget.php
index 3f5cf5fb050..8fed0a28d8f 100644
--- a/lib/public/Dashboard/IIconWidget.php
+++ b/lib/public/Dashboard/IIconWidget.php
@@ -29,7 +29,9 @@ namespace OCP\Dashboard;
*/
interface IIconWidget extends IWidget {
/**
- * Get the absolute url for the widget icon
+ * 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
diff --git a/lib/public/Dashboard/IWidget.php b/lib/public/Dashboard/IWidget.php
index 46ba2135775..e0a189ef506 100644
--- a/lib/public/Dashboard/IWidget.php
+++ b/lib/public/Dashboard/IWidget.php
@@ -32,7 +32,12 @@ namespace OCP\Dashboard;
*/
interface IWidget {
/**
- * @return string Unique id that identifies the widget, e.g. the app id
+ * Get a unique identifier for the widget
+ *
+ * To ensure uniqueness, it is recommended to user the app id or start with the
+ * app id followed by a dash.
+ *
+ * @return string Unique id that identifies the widget, e.g. the app id. Only use alphanumeric characters, dash and underscore
* @since 20.0.0
*/
public function getId(): string;
@@ -50,6 +55,13 @@ interface IWidget {
public function getOrder(): int;
/**
+ * CSS class that shows 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.
+ * Therefore, it is NOT recommended to use a css class that sets the background with:
+ * `var(--icon-…)` as those will adapt to dark/bright mode in the web and still be inverted
+ * resulting in a dark icon on dark background.
+ *
* @return string css class that displays an icon next to the widget title
* @since 20.0.0
*/