Skip to content

SiValueWidgetBodyComponent documentation

selector
si-value-widget-body

The body of the <​si-value-widget​> . Useful for compositions.

Input Properties

Name Type Default Description
description
 TranslatableString Short description of the value. A description is mandatory to show an icon. Only visible if value is available.
disableAutoLoadingIndicator
 boolean false Option to disable automatic start of skeleton loading indication.
icon
 string The element icon name. Only visible if value is available.
initialLoadingIndicatorDebounceTime
 number 300 Initial delay time in milliseconds before enabling loading indicator. Only used once initially during construction.
showLoadingIndicator
 boolean false Input to start and stop the skeleton loading indication.
status
 EntityStatusType Show a status icon instead of the icon .
unit
 TranslatableString The unit of the value (e.g. kWh or users). Only visible if value is available.
value
Required		 (TranslatableString | undefined) The main value to be displayed. If no value is set, the skeleton indicates the loading of the value. Disable the automatic loading mechanism by setting SiWidgetBodyBaseComponent.disableAutoLoadingIndicator .

Attributes and Methods

Name Type Default Description
ngOnChanges()
 () => void A callback method that is invoked immediately after the default change detector has checked data-bound properties if at least one has changed, and before the view and content children are checked.
(readonly) showLoadingIndicator
 Signal<boolean> ...

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.