ItemProps Interface

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.  
betaBadge undefined | false | true Indicates whether to draw a Beta badge.  
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
iconSpec undefined | IconSpec IconProps CSS class name or SvgSprite for icon
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  
stateSyncIds undefined | string[] SyncUiProps  
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: 20 September, 2019