Skip to content

SiCircleStatusComponent documentation

selector
si-circle-status

Input Properties

Name Type Default Description
ariaLabel
 TranslatableString Aria label for icon and status combo. Needed for a11y
boolean false Whether the status should appear with a pulsing circle around the badge.
blinkPulse
 Observable<boolean> Blink pulse generator for synchronized blinking with other components
eventIcon
 string Custom icon class for event out
eventOut
 boolean false event direction is out
icon
 string Set a domain type icon (e.g. element-door ) for which the status shall be shown. Leave undefined for visualizing the status without an icon.
size
 ("small" | "regular") 'regular' Set the size using either regular or small only works when used together with icon
status
 EntityStatusType The status (success, info, warning, danger) to be visualized.
color
Deprecated		 string A custom color (e.g. #fefefe ) for exceptional cases.
Deprecated: use the semantic status input instead.

Types Documentation

(string & Translatable)
Represents a translatable string. This can either be a translation key, e.g. ACTIONS.EDIT that will be automatically translated when displayed on the UI or a pre-translated string, e.g. Edit . Equivalent to a normal string in usage and functionality.
(ExtendedStatusType | "pending" | "progress")
(StatusType | "unknown")
("success" | "info" | "warning" | "danger" | "caution" | "critical")

Except where otherwise noted, content on this site is licensed under MIT License.