ListOptions

ScrollOrientation

ListType

defaultListOptions

https://lynxjs.org/api/elements/built-in/list.html#required-item-key

The item-key attribute is a required attribute on <list-item>.

Synonym for keyProp Allows a user to specify a Key inside of an [Attribute action]

https://lynxjs.org/api/elements/built-in/list.html#enable-scroll

Indicates whether the <list> component is allowed to scroll.

https://lynxjs.org/api/elements/built-in/list.html#enable-nested-scroll

Indicates whether <list> can achieve nested scrolling with other scrollable containers. When enabled, the inner container scrolls first, followed by the outer container.

https://lynxjs.org/api/elements/built-in/list.html#list-main-axis-gap

Specifies the spacing of <list> child nodes in the main axis direction, which needs to be written in the style.

https://lynxjs.org/api/elements/built-in/list.html#list-cross-axis-gap

Specifies the spacing of list child nodes in the cross axis direction, which needs to be written in the style.

https://lynxjs.org/api/elements/built-in/list.html#sticky

Declared on the <list> component to control whether the <list> component as a whole is allowed to be sticky at the top or bottom.

https://lynxjs.org/api/elements/built-in/list.html#sticky-offset

The offset distance from the top or bottom of <list> for sticky positioning, in px.

https://lynxjs.org/api/elements/built-in/list.html#sticky-top

Declared on the <list-item> child node to control whether the node will be sticky at the top.

https://lynxjs.org/api/elements/built-in/list.html#sticky-bottom

Declared on the <list-item> child node to control whether the node will be sticky at the bottom.

https://lynxjs.org/api/elements/built-in/list.html#bounces

• iOS* only

Declared on the <list-item> child node to control whether the node will be sticky at the bottom.

Default value: True

https://lynxjs.org/api/elements/built-in/list.html#initial-scroll-index

Specifies the node position to which <list> automatically scrolls after rendering effective only once.

https://lynxjs.org/api/elements/built-in/list.html#need-visible-item-info

Controls whether the scroll event callback parameters include the position information of the currently rendering node.

The scroll events include: * scroll * scrolltoupper * scrolltolower

Default value: False

https://lynxjs.org/api/elements/built-in/list.html#upper-threshold-item-count

Triggers a scrolltoupper event once when the number of remaining displayable child nodes at the top of <list> is less than `upper-threshold-item-count` for the first time.

https://lynxjs.org/api/elements/built-in/list.html#lower-threshold-item-count

Triggers a scrolltolower event once when the number of remaining displayable child nodes at the bottom of <list> is less than `lower-threshold-item-count` for the first time.

https://lynxjs.org/api/elements/built-in/list.html#scroll-event-throttle

Sets the time interval for the <list> callback scroll event, in milliseconds (ms). By default, the scroll event is called back every 200 ms.

Default Value: 200

https://lynxjs.org/api/elements/built-in/list.html#item-snap

Used to mark the unique identifier for this data source update, which will be returned in the layoutcomplete event callback.

• factor: The parameter for paginated positioning, with a range of `[0, 1]`.
• offset: Additional offset parameter added on top of factor.

https://lynxjs.org/api/elements/built-in/list.html#need-layout-complete-info

Controls whether the layoutcomplete event includes the node layout information before and after this layout, the <list> Diff information that triggered this layout, and the current <list> scroll state information.

https://lynxjs.org/api/elements/built-in/list.html#layout-id

Used to mark the unique identifier for this data source update, which will be returned in the layoutcomplete event callback.

Default Value: -1

https://lynxjs.org/api/elements/built-in/list.html#preload-buffer-count

This attribute controls the number of nodes outside <list> that are preloaded.

Default Value: 0

https://lynxjs.org/api/elements/built-in/list.html#scroll-bar-enable

• iOS* only

Indicates whether the <list> component scroll bar is displayed.

Default value: True

https://lynxjs.org/api/elements/built-in/list.html#reuse-identifier

Sets the reuse id for <list-item>. When rendering child nodes, the <list> component reuses <list-item> based on the reuse-identifier attribute value. Only <list-item> with the same reuse-identifier attribute value will be reused.

https://lynxjs.org/api/elements/built-in/list.html#full-span

The full-span attribute is used to indicate that a <list-item> occupies a full row or column.

https://lynxjs.org/api/elements/built-in/list.html#estimated-main-axis-size-px

Specifies the placeholder size in the main axis direction for <list-item> before it is fully rendered, in px. If not set, the default value is the size of <list> in the main axis direction.