A component to be used as custom list item within the ui5-list
the same way as the standard ui5-li
.
The component accepts arbitrary HTML content to allow full customization.
Properties​
accessibleName​
Description | Defines the text alternative of the component. Note: If not provided a default text alternative will be set, if present. |
Type | string |
Default | "" |
Since | 1.0.0-rc.15 |
Description | Defines the visual indication and behavior of the list items. Available options are Active (by default), Inactive , Detail and Navigation . Note: When set to Active or Navigation , the item will provide visual response upon press and hover, while with type Inactive and Detail - will not. |
Type | "Inactive" | "Active" | "Detail" | "Navigation" |
Default | "Active" |
accessibilityAttributes​
Description | An object of strings that defines several additional accessibility attribute values for customization depending on the use case. It supports the following fields: - ariaSetsize : Defines the number of items in the current set of listitems or treeitems when not all items in the set are present in the DOM. The value of each aria-setsize is an integer reflecting number of items in the complete set. Note: If the size of the entire set is unknown, set aria-setsize="-1" . - ariaPosinset : Defines an element's number or position in the current set of listitems or treeitems when not all items are present in the DOM. The value of each aria-posinset is an integer greater than or equal to 1, and less than or equal to the size of the set when that size is known. |
Type | AccessibilityAttributes |
Default | |
Since | 1.15.0 |
navigated​
Description | The navigated state of the list item. If set to true , a navigation indicator is displayed at the end of the list item. |
Type | boolean |
Default | false |
Since | 1.10.0 |
Description | Defines the text of the tooltip that would be displayed for the list item. |
Type | string |
Default | "" |
Since | 1.23.0 |
highlight​
Description | Defines the highlight state of the list items. Available options are: "None" (by default), "Success" , "Warning" , "Information" and "Error" . |
Type | "None" | "Success" | "Warning" | "Error" | "Information" |
Default | "None" |
Since | 1.24 |
selected​
Description | Defines the selected state of the ListItem . |
Type | boolean |
Default | false |
default​
Description | Defines the content of the component. |
Type | Array<Node> |
Description | Defines the delete button, displayed in "Delete" mode. Note: While the slot allows custom buttons, to match design guidelines, please use the ui5-button component. Note: When the slot is not present, a built-in delete button will be displayed. |
Type | Array<IButton> |
Since | 1.9.0 |
detail-click​
Description | Fired when the user clicks on the detail button when type is Detail . |
Type | CustomEvent |
Methods​
No methods available for this component.
CSS Parts​
Name | Description |
---|
native-li | Used to style the main li tag of the list item |
content | Used to style the content area of the list item |
detail-button | Used to style the button rendered when the list item is of type detail |
delete-button | Used to style the button rendered when the list item is in delete mode |
radio | Used to style the radio button rendered when the list item is in single selection mode |
checkbox | Used to style the checkbox rendered when the list item is in multiple selection mode |