diff --git a/docs/flatlist.md b/docs/flatlist.md index 0bddc32a40f..985b4fbf401 100644 --- a/docs/flatlist.md +++ b/docs/flatlist.md @@ -600,30 +600,6 @@ Multiple columns can only be rendered with `horizontal={false}` and will zig-zag --- -### `onEndReached` - -```tsx -(info: {distanceFromEnd: number}) => void; -``` - -Called once when the scroll position gets within `onEndReachedThreshold` of the rendered content. - -| Type | -| -------- | -| function | - ---- - -### `onEndReachedThreshold` - -How far from the end (in units of visible length of the list) the bottom edge of the list must be from the end of the content to trigger the `onEndReached` callback. Thus a value of 0.5 will trigger `onEndReached` when the end of the content is within half the visible length of the list. - -| Type | -| ------ | -| number | - ---- - ### `onRefresh` ```tsx diff --git a/docs/sectionlist.md b/docs/sectionlist.md index d43fbc3c459..18f9960e900 100644 --- a/docs/sectionlist.md +++ b/docs/sectionlist.md @@ -221,26 +221,6 @@ Rendered at the very beginning of the list. Can be a React Component (e.g. `Some --- -### `onEndReached` - -Called once when the scroll position gets within `onEndReachedThreshold` of the rendered content. - -| Type | -| ----------------------------------------- | -| (info: {distanceFromEnd: number}) => void | - ---- - -### `onEndReachedThreshold` - -How far from the end (in units of visible length of the list) the bottom edge of the list must be from the end of the content to trigger the `onEndReached` callback. Thus a value of 0.5 will trigger `onEndReached` when the end of the content is within half the visible length of the list. - -| Type | Default | -| ------ | ------- | -| number | `2` | - ---- - ### `onRefresh` If provided, a standard RefreshControl will be added for "Pull to Refresh" functionality. Make sure to also set the `refreshing` prop correctly. To offset the RefreshControl from the top (e.g. by 100 pts), use `progressViewOffset={100}`. diff --git a/docs/virtualizedlist.md b/docs/virtualizedlist.md index 9c941586458..ae9f9671b19 100644 --- a/docs/virtualizedlist.md +++ b/docs/virtualizedlist.md @@ -421,25 +421,21 @@ The maximum number of items to render in each incremental render batch. The more ### `onEndReached` -```tsx -(info: {distanceFromEnd: number}) => void; -``` - -Called once when the scroll position gets within `onEndReachedThreshold` of the rendered content. +Called once when the scroll position gets within within `onEndReachedThreshold` from the logical end of the list. -| Type | -| -------- | -| function | +| Type | +| ----------------------------------------- | +| (info: {distanceFromEnd: number}) => void | --- ### `onEndReachedThreshold` -How far from the end (in units of visible length of the list) the bottom edge of the list must be from the end of the content to trigger the `onEndReached` callback. Thus a value of 0.5 will trigger `onEndReached` when the end of the content is within half the visible length of the list. +How far from the end (in units of visible length of the list) the trailing edge of the list must be from the end of the content to trigger the `onEndReached` callback. Thus, a value of 0.5 will trigger `onEndReached` when the end of the content is within half the visible length of the list. -| Type | -| ------ | -| number | +| Type | Default | +| ------ | ------- | +| number | `2` | --- @@ -475,6 +471,26 @@ Used to handle failures when scrolling to an index that has not been measured ye --- +### `onStartReached` + +Called once when the scroll position gets within within `onStartReachedThreshold` from the logical start of the list. + +| Type | +| ------------------------------------------- | +| (info: {distanceFromStart: number}) => void | + +--- + +### `onStartReachedThreshold` + +How far from the start (in units of visible length of the list) the leading edge of the list must be from the start of the content to trigger the `onStartReached` callback. Thus, a value of 0.5 will trigger `onStartReached` when the start of the content is within half the visible length of the list. + +| Type | Default | +| ------ | ------- | +| number | `2` | + +--- + ### `onViewableItemsChanged` Called when the viewability of rows changes, as defined by the `viewabilityConfig` prop.