CommonItemProps Interface

Definition that specifies properties shared between many ConfigurableUi components.

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.  
description string | ConditionalStringValue if set, it is used to explicitly set the description shown by components that support a description.  
icon string | ConditionalStringValue Name of icon WebFont entry or if specifying an SVG symbol added by plug on use "svg:" prefix to imported symbol Id.  
internalData undefined | Map<string, any> optional data to be used by item implementor.  
isActive undefined | false | true if set, component will be considered "active" an will display an "active stripe" - defaults to false  
isDisabled boolean | ConditionalBooleanValue if true component will be disabled - defaults to false  
isHidden boolean | ConditionalBooleanValue if true component will be hidden - defaults to false  
isPressed undefined | false | true if set, component will be considered selected but will NOT display an "active stripe" - defaults to false.  
label string | ConditionalStringValue if set, it is used to explicitly set the label shown by a component.  
tooltip string | ConditionalStringValue used to explicitly set the tooltip shown by a component.  

Defined in

Last Updated: 15 June, 2021