Enact

moonstone/VirtualFlexList

import VirtualFlexList from '@enact/moonstone/VirtualFlexList';

Members

VirtualFlexListComponent❌

since 1.14.0. Will be replaced by ui/VirtualFlexList in 2.0.0

moonstone/VirtualFlexList~VirtualFlexList is a VirtualFlexList with Moonstone styling which has a variable width or height.

import VirtualFlexList from '@enact/moonstone/VirtualFlexList';
Properties
corner
cornerShape

The component for corner in a list. It has component property to render the list corner and background property for background inline style.

headers
headersShape

Row and column headers in a list including the following properties.

col for a column header row for a row header

Thoese properties have the following properties.

component is the render function for an item. count is the property for the number of items vertically. data is any data which is passed to the render funtion. height is the item height. width is the item width. background is for background inline style.

items
itemsShape

List items including the following properties.

colCount is the number of items horizontally. component is the render function for an item. data is any data which is passed to the render funtion. height is the item height. rowCount is the number of items vertically. width is the item width. background is for background inline style.

The object including data, index, and key properties are passed as the parameters of the component render function.

maxFlexScrollSize
Number

The predefined maxScrollSize for variable width or height.

onPositionChange
Function

Called when position updates

The object including x, y properties for position, are passed as the parameters of the onPositionChange callback function.

x
Number

Position x.

y
Number

Position y.

VirtualFlexListBaseComponent

moonstone/VirtualFlexList.VirtualFlexListBase is a base component for VirtualFlexList.

import {VirtualFlexListBase} from '@enact/moonstone/VirtualFlexList';

cornerShapeObject

The shape for the component of the list corner for moonstone/VirtualFlexList.corner.

component
Object

React element, a render function.

background
String

Background inline style.

headersColumnOrRowObject

The information of a column or a row header for moonstone/VirtualFlexList.headersShape.

component
Function

The render function for an item.

count
Number

Item count. It should be a number.

data
Object

Any data which is passed to the render funtion.

height
Number

The item height.

width
Number

The item width.

background
String

Background inline style.

headersShapeObject

The shape for the a column or a row headers in a list for moonstone/VirtualFlexList.headers.

col
headersColumnOrRow

The information of a column header.

row
headersColumnOrRow

The information of a row header.

itemsShapeObject

The shape for the list items for moonstone/VirtualFlexList.items.

colCount
NumberFunction

The number of items or the function to get it horizontally.

component
Function

The render function for an item.

data
Object

Any data which is passed to the render funtion.

height
NumberFunction

The item height.

rowCount
NumberFunction

The number of items or the function to get it vertically.

width
NumberFunction

The item width.

background
String

Background inline style.

sizeShapeObject

col
NumberFunction

The size for column data/item. It should be either number or function to get it.

row
NumberFunction

The size for row data/item. It should be either number or function to get it.

ArrayBooleanFunctionModuleNumberObjectString