The ui5-li-group is a special list item, used only to create groups of list items.
This is the item to use inside a ui5-list.
ES6 Module Import
import "@ui5/webcomponents/dist/ListItemGroup.js";
Properties
| Description | Defines the header text of the ui5-li-group. |
| Type | string | undefined |
| Default | undefined |
| Description | Defines the accessible name of the header. |
| Type | string | undefined |
| Default | undefined |
wrappingType
| Description | Defines 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" |
| Default | "None" |
| Since | 2.15.0 |
Slots
default
| Description | Defines the items of the ui5-li-group. |
| Type | Array<ListItemBase> |
| Description | Defines the header of the component.
Note: Using this slot, the default header text of group and the value of headerText property will be overwritten. |
| Type | Array<ListItemBase> |
Events
move-over
| Description | Fired 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(). |
| Type | CustomEvent<ListItemGroupMoveEventDetail> |
| Parameters | source: object
Contains information about the moved element under element property.
destination: object
Contains information about the destination of the moved element. Has element and placement properties. |
| Since | 2.1.0 |
| Bubbles | Yes |
| Cancelable | Yes - via preventDefault() |
move
| Description | Fired 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. |
| Type | CustomEvent<ListItemGroupMoveEventDetail> |
| Parameters | source: object
Contains information about the moved element under element property.
destination: object
Contains information about the destination of the moved element. Has element and placement properties. |
| Since | 2.1.0 |
| Bubbles | Yes |
| Cancelable | No |
Methods
No methods available for this component.
CSS Parts
| Name | Description |
|---|
| header | Used to style the header item of the group |