API Reference > ui-abstract > Item > AbstractGroupItemProps

AbstractGroupItemProps Interface

Beta  

Definition for a Group Button that opens a group of items.

Extends

Properties

Name Type Description
direction undefined | GroupButtonDirection Direction of the popup relative to the button  
groupId string Id of Group item  
items AnyItemProps[] Items shown in the GroupButton popup  
itemsInColumn undefined | number Maximum number of items in each column in the popup  
paneLabelKey undefined | string if set, it is used to define a key that is used to look up a localized string.  
panelLabel string | StringGetter if set, it is used to explicitly set a label at top of open group component.  

Inherited properties

Name Type Inherited from Description
applicationData undefined | any AbstractItemProps can be used by application to store miscellaneous data.
badgeType undefined | BadgeType AbstractItemProps Badge to be overlaid on the item.
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.
isActive undefined | false | true AbstractItemProps if set, component will be considered "active" an will display an "active stripe" - defaults to false
isEnabled undefined | false | true AbstractItemProps if set, component will be enabled - defaults to true
isPressed undefined | false | true AbstractItemProps if set, component will be considered selected but will NOT display an "active stripe" - defaults to false.
isVisible undefined | false | true AbstractItemProps if set, component will be visible - defaults to true
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: 13 June, 2024