<list> · Hyperview

The <list> element represents a list of items. Unlike child elements of a <view>, children of a <list> element undergo optimizations to efficiently render hundreds of items.

<list style="MyList">
  <item key="a">
    <text>Item A</text>
  </item>

  <item key="b">
    <text>Item B</text>
  </item>

  <item key="c">
    <text>Item C</text>
  </item>
</list>

Structure

A <list> element will only render <item> and <items> children elements. Other elements will be ignored during rendering.

Behavior attributes

A list will accept the standard behavior attributes. However, a list will only trigger the refresh behavior (through the pull-to-refresh gesture). Other behaviors, such as presses, should be handled by the <item> elements in the list.

`style`

Type	Required
string	No

A space-separated list of styles to apply to the text. See Styles.

`itemHeight`

Type	Required
integer	No

An optional number that fixes the height of every item in the list. The presence of this property helps optimize layout for very long lists, by simplifying the calculation for which items are on screen.

`id`

Type	Required
string	No

A global attribute uniquely identifying the element in the whole document.

`hide`

Type	Required
false (default), true	No

If hide="true", the element will not be rendered on screen. If the element or any of the element's children have a behavior that triggers on "load" or "visible", those behaviors will not trigger while the element is hidden.

`scroll-orientation`

Type	Required
vertical (default), horizontal	No

An attribute indicating the direction in which the body will scroll.

`shows-scroll-indicator`

Type	Required
true (default), false	No

An attribute indicating whether the scroll bar should be shown.

`keyboard-dismiss-mode`

Type	Required
none (default), `on-drag`, `interactive`	No

An attribute that controls the virtual keyboard behavior when the scrollable view is interacted with. Note: interactive value is only supported on iOS. When set to this value, the keyboard is dismissed interactively with the drag and moves in synchrony with the touch, dragging upwards cancels the dismissal. On Android this is not supported and it will have the same behavior as none.

`keyboard-should-persist-taps`

Type	Required
never (default), `always`, `handled`	No

An attribute that controls the virtual keyboard behavior when the scrollable view is tapped.