Skip to main content

SearchItemGroup

<ui5-search-item-group> | Since 2.9.0
info

The following entity is available under an experimental flag and its API and behavior are subject to change.

The ui5-search-item-group is type of suggestion item, that can be used to split the ui5-search-item suggestions into groups.

Properties​

headerAccessibleName​

DescriptionDefines the accessible name of the header.
Typestring | undefined
Defaultundefined

headerText​

DescriptionDefines the header text of the group.
Typestring | undefined
Defaultundefined

wrappingType​

DescriptionDefines if the text of the component should wrap when it's too long. When set to "Normal", the content (title, description) will be wrapped using the ui5-expandable-text component.

The text can wrap up to 100 characters on small screens (size S) and up to 300 characters on larger screens (size M and above). When text exceeds these limits, it truncates with an ellipsis followed by a text expansion trigger.
Available options are:
- None (default) - The text will truncate with an ellipsis.
- Normal - The text will wrap (without truncation).
Type"None" | "Normal" (value descriptions in: WrappingType)
Default"None"
Since2.15.0

Slots​

default​

DescriptionDefines the items of the group.
TypeArray<ListItemBase>
DescriptionDefines the header of the component.
Note: Using this slot, the default header text of group and the value of headerText property will be overwritten.
TypeArray<ListItemBase>

Events​

move​

DescriptionFired when a movable list item is dropped onto a drop target.
Note: move event is fired only if there was a preceding move-over with prevented default action.
TypeCustomEvent<ListItemGroupMoveEventDetail>
Parametersdestination: object
Contains information about the destination of the moved element. Has element and placement properties.
source: object
Contains information about the moved element under element property.
Since2.1.0
BubblesYes
CancelableNo

move-over​

DescriptionFired when a movable list item is moved over a potential drop target during a dragging operation.
If the new position is valid, prevent the default action of the event using preventDefault().
TypeCustomEvent<ListItemGroupMoveEventDetail>
Parametersdestination: object
Contains information about the destination of the moved element. Has element and placement properties.
source: object
Contains information about the moved element under element property.
Since2.1.0
BubblesYes
CancelableYes - via preventDefault()

Methods​

No methods available for this component.

CSS Parts​

For more information on how to use CSS shadow parts, see Usage of CSS Shadow Parts.

NameDescription
headerUsed to style the header item of the group
titleUsed to style the title of the group header

CSS Custom States​

No CSS custom states available for this component.