AbstractItemProps Interface
Beta
Definition that specifies properties shared between many ConfigurableUi components.
Extends
Properties
| Name | Type | Description | |
|---|---|---|---|
| applicationData | undefined | any | can be used by application to store miscellaneous data. | |
| badgeType | undefined | BadgeType | Badge to be overlaid on the item. | |
| isActive | undefined | false | true | if set, component will be considered "active" an will display an "active stripe" - defaults to false | |
| isEnabled | undefined | false | true | if set, component will be enabled - defaults to true | |
| isPressed | undefined | false | true | if set, component will be considered selected but will NOT display an "active stripe" - defaults to false. | |
| isVisible | undefined | false | true | if set, component will be visible - defaults to true |
Inherited properties
| Name | Type | Inherited from | Description |
|---|---|---|---|
| description | string | StringGetter | DescriptionProps | if set, it is used to explicitly set the description shown by a component. |
| descriptionKey | undefined | string | DescriptionProps | if set, it is used to define a key that is used to look up a localized string. |
| iconSpec | undefined | string | AbstractIconProps | Name of icon WebFont entry or if specifying an SVG symbol added by plug on use "svg:" prefix to imported symbol Id. |
| label | string | StringGetter | LabelProps | if set, it is used to explicitly set the label shown by a component. |
| labelKey | undefined | string | LabelProps | if set, it is used to define a key that is used to look up a localized string. |
| stateFunc | undefined | (state: Readonly<BaseItemState>) => BaseItemState | SyncUiProps | Function called to get the new items state |
| stateSyncIds | undefined | string[] | SyncUiProps | Synchronize Ids to listen for |
| tooltip | string | StringGetter | TooltipProps | used to explicitly set the tooltip shown by a component. |
| tooltipKey | undefined | string | TooltipProps | if set, it is used to define a key that is used to look up a localized string. |
Defined in
Last Updated: 08 January, 2020