list-item

NOTE

This component is supported since API version 4. Updates will be marked with a superscript to indicate their earliest API version.

<list-item> is a child component of the <list> component and is used to display items in a list. You can customize the width of each <list-item>. However, if you retain the default value stretch of align-items for the parent component <list>, the width of <list-item> is equal to that of <list>. To make the customized <list-item> width take effect, set align-items to other values rather than stretch.

Required Permissions

None

Child Components

This component supports only one child component.

Attributes

In addition to the universal attributes, the following attributes are supported.

Name	Type	Default Value	Mandatory	Description
type	string	default	No	Type of the list-item. A list can contain multiple list-item types. The same type of list items should have the same view layout after being rendered. When the type is fixed, replace the if attribute with the show attribute to ensure that the view layout remains unchanged.
primary	boolean	false	No	Whether the item is the primary item in the group. The value true indicates that the item is the primary item in the group, which is the item that appears in a collapsed group. If there is more than one item marked as primary, the first one is the primary item. If there is no item marked as primary, the first item is the primary item.
section	string	-	No	String used to match the item. This attribute can be left empty. The value cannot be dynamically updated. In a list item group, only the string set for the primary item is valid.
sticky	string	none	No	Whether the current item sticks in place at the top, and the effect when it disappears. This attribute supports vertical lists only and is invalid for items in a group. - none: The current item does not stick at the top. - normal: The current item sticks at the top and disappears with a sliding effect. - opacity: The current item sticks at the top and disappears gradually. This option is only supported on wearables.
clickeffect⁵⁺	boolean	true	No	Whether an effect is displayed when the current item is clicked. - false: No effect is displayed when the item is clicked. - true: An effect is displayed when the item is clicked.

Styles

In addition to the universal styles, the following styles are supported.

Name	Type	Default Value	Mandatory	Description
column-span	<number>	1	No	Number of columns occupied by the current list-item in the list. By default, the list-item occupies one column. This attribute is valid only when the list contains multiple columns.

Events

In addition to the universal events, the following events are supported.

Name	Parameter	Description
sticky	{ state: boolean }	Callback event for a sticky component. value: false: The current item is not in the sticky state. value: true: The current item is in the sticky state. This event is supported only when the item is configured with the sticky attribute.