IIconWidget
extends
IWidget
in
Allow getting the absolute icon url for a widget
Tags
Table of Contents
Methods
- getIconClass() : string
- CSS class that shows the widget icon (should be colored black or not have a color)
- getIconUrl() : string
- Get the absolute url for the widget icon (should be colored black or not have a color)
- getId() : string
- Get a unique identifier for the widget
- getOrder() : int
- getTitle() : string
- getUrl() : string|null
- load() : void
- Execute widget bootstrap code like loading scripts and providing initial state
Methods
getIconClass()
CSS class that shows the widget icon (should be colored black or not have a color)
public
getIconClass() : string
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.
Tags
Return values
string —css class that displays an icon next to the widget title
getIconUrl()
Get the absolute url for the widget icon (should be colored black or not have a color)
public
getIconUrl() : string
The icon will be inverted automatically in mobile clients and when using dark mode
Tags
Return values
stringgetId()
Get a unique identifier for the widget
public
getId() : string
To ensure uniqueness, it is recommended to user the app id or start with the app id followed by a dash.
Tags
Return values
string —Unique id that identifies the widget, e.g. the app id. Only use alphanumeric characters, dash and underscore
getOrder()
public
getOrder() : int
Tags
Return values
int —Initial order for widget sorting
getTitle()
public
getTitle() : string
Tags
Return values
string —User facing title of the widget
getUrl()
public
getUrl() : string|null
Tags
Return values
string|null —The absolute url to the apps own view
load()
Execute widget bootstrap code like loading scripts and providing initial state
public
load() : void