MCPcopy Create free account
hub / github.com/UI5/webcomponents / List

Class List

packages/main/src/List.ts:186–1645  ·  view source on GitHub ↗

* @class * * ### Overview * * The `ui5-list` component allows displaying a list of items, advanced keyboard * handling support for navigating between items, and predefined modes to improve the development efficiency. * * The `ui5-list` is a container for the available list items: * * - `ui5

Source from the content-addressed store, hash-verified

184 * @csspart growing-button-inner - Used to style the button inner element
185 */
186@customElement({
187 tag: "ui5-list",
188 fastNavigation: true,
189 renderer: jsxRenderer,
190 template: ListTemplate,
191 styles: [
192 listCss,
193 ],
194})
195/**
196 * Fired when an item is activated, unless the item's `type` property
197 * is set to `Inactive`.
198 *
199 * **Note**: This event is not triggered by interactions with selection components such as the checkboxes and radio buttons,
200 * associated with non-default `selectionMode` values, or if any other **interactive** component
201 * (such as a button or input) within the list item is directly clicked.
202 * @param {HTMLElement} item The clicked item.
203 * @public
204 */
205@event("item-click", {
206 bubbles: true,
207 cancelable: true,
208})
209
210/**
211 * Fired when the `Close` button of any item is clicked
212 *
213 * **Note:** This event is only applicable to list items that can be closed (such as notification list items),
214 * not to be confused with `item-delete`.
215 * @param {HTMLElement} item the item about to be closed.
216 * @public
217 * @since 1.0.0-rc.8
218 */
219@event("item-close", {
220 bubbles: true,
221})
222
223/**
224 * Fired when the `Toggle` button of any item is clicked.
225 *
226 * **Note:** This event is only applicable to list items that can be toggled (such as notification group list items).
227 * @param {HTMLElement} item the toggled item.
228 * @public
229 * @since 1.0.0-rc.8
230 */
231@event("item-toggle", {
232 bubbles: true,
233})
234
235/**
236 * Fired when the Delete button of any item is pressed.
237 *
238 * **Note:** A Delete button is displayed on each item,
239 * when the component `selectionMode` property is set to `Delete`.
240 * @param {HTMLElement} item the deleted item.
241 * @public
242 */
243@event("item-delete", {

Callers

nothing calls this directly

Calls 5

customElementFunction · 0.85
propertyFunction · 0.85
i18nFunction · 0.85
eventFunction · 0.50
slotFunction · 0.50

Tested by

no test coverage detected

Used in the wild real call sites across dependent graphs

searching dependent graphs…