Skip to content

Commit 3101511

Browse files
committed
docs: add listRef property mentioned
1 parent c59ea9b commit 3101511

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

+8
Original file line numberDiff line numberDiff line change
@@ -195,6 +195,10 @@ To see how it works you can check the [AsyncDataIdle](./__stories__/AsyncDataIdl
195195

196196
This option works in tandem with the `placeholder` option. With it, you can set the task timeout for the `requestIdleCallback`. The `buildingTaskTimeout` will be sent directly as the `requestIdleCallback`'s `timeout` option.
197197

198+
##### `listRef: Ref<FixedSizeList>`
199+
200+
This option allows you to get the instance of the internal `react-window` list. It is usually unnecessary because all necessary methods are already provided but still can be useful for edge cases.
201+
198202
##### `rowComponent: component`
199203

200204
This property receives a custom `Row` component for the `FixedSizeList` that will override the default one. It can be used for adding new functionality.
@@ -406,6 +410,10 @@ Since `VariableSizeList` in general inherits properties from the `FixedSizeList`
406410

407411
The `Node` component. It is the same as the [`FixedSizeTree`](#fixedsizetree)'s one but receives properties from the [`VariableSizeNodePublicState`](#types-1) object.
408412

413+
##### `listRef: Ref<VariableSizeList>`
414+
415+
Same as [`listRef`](#listref-reffixedsizelist) of `FixedSizeTree`.
416+
409417
##### `rowComponent: component`
410418

411419
See [`rowComponent`](#rowcomponent-component) in the `FixedSizeTree` section; the `getRecordData` returns the [`VirtualSizeNodePublicState`](#types-1) object.

0 commit comments

Comments
 (0)