API Reference › appui-react › Item › ItemProps

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.  
badgeType undefined | BadgeType Badge to be overlaid on the item.  
description string | StringGetter | ConditionalStringValue if set, it is used to explicitly set the description shown by a component.  
descriptionKey undefined | string if set, it is used to define a key that is used to look up a localized string.  
icon undefined | IconSpec abstract icon definition, used when create itemDef from abstract item (ie.  
isActive undefined | boolean 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 | boolean if set, component will be considered selected but will NOT display an "active stripe" - defaults to false.  
label string | StringGetter | ConditionalStringValue if set, it is used to explicitly set the label shown by a component.  
labelKey undefined | string if set, it is used to define a key that is used to look up a localized string.  
tooltip string | StringGetter | ConditionalStringValue used to explicitly set the tooltip shown by a component.  
tooltipKey undefined | string if set, it is used to define a key that is used to look up a localized string.  

Inherited properties

Name Type Inherited from Description
className undefined | string IconProps Custom CSS class name
iconSpec undefined | IconSpec IconProps CSS class name or SvgPath for icon.
itemId undefined | string IconProps Optional unique identifier for item.
style undefined | CSSProperties IconProps Custom CSS style properties

Defined in

Last Updated: 05 April, 2024