State
DataChangeParams
Section titled “DataChangeParams”Parameters passed to callbacks when data changes in the list.
Type Parameters
Section titled “Type Parameters”| Type Parameter | Default type | Description |
|---|---|---|
Data | any | The type of the data items in the list. |
Properties
Section titled “Properties”autoscrollToBottomBehavior?
Section titled “autoscrollToBottomBehavior?”
optionalautoscrollToBottomBehavior:ScrollBehavior| {location: () => ItemLocation | null | undefined; }
newData
Section titled “newData”Data
DataWithScrollModifier
Section titled “DataWithScrollModifier”The shape of the message list data prop. It includes the data to render and any extra scroll position modification that should be applied when the data changes.
Type Parameters
Section titled “Type Parameters”| Type Parameter | Description |
|---|---|
Data | The type of the data items in the list. |
Properties
Section titled “Properties”Data[] | null | undefined
scrollModifier?: ScrollModifier
Section titled “scrollModifier?: ScrollModifier”ListScrollLocation
Section titled “ListScrollLocation”Describes the location of the list relative to the viewport and the scroll element.
Properties
Section titled “Properties”bottomOffset
Section titled “bottomOffset”number
The distance between the scroller element bottom edge and the viewport bottom edge.
If 0, the list is at the bottom.
isAtBottom
Section titled “isAtBottom”boolean
A convenience flag that indicates whether the list is at the bottom. The flag is also true when the list is currently scrolling to the bottom.
listOffset
Section titled “listOffset”number
The distance between the list top edge and the viewport top edge.
When the list is above the viewport (when scrolling down), this value is a negative number. When the list is scrolled to the top, this value is 0.
scrollHeight
Section titled “scrollHeight”number
The scroll height of the scroller wrapper.
visibleListHeight
Section titled “visibleListHeight”number
The height of the visible portion of the list without any headers and footers.