-
Notifications
You must be signed in to change notification settings - Fork 350
refactor(react-virtualized-helpers): migrate withInfiniteLoader from … #4744
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
mergify
merged 1 commit into
box:master
from
bonchevskyi:refactor/flow-to-ts-react-virtualized-helpers
Aug 7, 2026
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
File renamed without changes.
File renamed without changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| export { default as withInfiniteLoader } from './withInfiniteLoader'; | ||
| export type { InfiniteLoaderConfig, WithInfiniteLoaderProps } from './withInfiniteLoader'; |
File renamed without changes.
66 changes: 66 additions & 0 deletions
66
src/components/react-virtualized-helpers/withInfiniteLoader.tsx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,66 @@ | ||
| import * as React from 'react'; | ||
| import InfiniteLoader from '@box/react-virtualized/dist/commonjs/InfiniteLoader'; | ||
|
|
||
| /** A single row index, as passed to `isRowLoaded`. */ | ||
| interface Index { | ||
| index: number; | ||
| } | ||
|
|
||
| /** An inclusive range of row indices, as passed to `loadMoreRows` and `onRowsRendered`. */ | ||
| interface IndexRange { | ||
| startIndex: number; | ||
| stopIndex: number; | ||
| } | ||
|
|
||
| type OnRowsRendered = (params: IndexRange) => void; | ||
|
|
||
| type WithOnRowsRendered = { | ||
| onRowsRendered?: OnRowsRendered; | ||
| }; | ||
|
|
||
| function getDisplayName(WrappedComponent: React.ComponentClass<WithOnRowsRendered>) { | ||
| return WrappedComponent.displayName || WrappedComponent.name || 'Component'; | ||
| } | ||
|
|
||
| export interface InfiniteLoaderConfig { | ||
| /** Returns a truthy value when the requested row has loaded. */ | ||
| isRowLoaded: (params: Index) => unknown; | ||
| /** Callback invoked when more rows must be loaded. Its result may resolve after loading finishes. */ | ||
| loadMoreRows: (params: IndexRange) => PromiseLike<unknown> | void; | ||
| /** Minimum number of rows to load in each batch. */ | ||
| minimumBatchSize?: number; | ||
| /** Total number of rows in the list. */ | ||
| rowCount: number; | ||
| /** Number of rows from the rendered range at which to start loading. */ | ||
| threshold?: number; | ||
| } | ||
|
|
||
| export interface WithInfiniteLoaderProps { | ||
| /** Configuration passed to the react-virtualized InfiniteLoader. */ | ||
| infiniteLoaderProps: InfiniteLoaderConfig; | ||
| } | ||
|
|
||
| function withInfiniteLoader<P extends WithOnRowsRendered>(WrappedComponent: React.ComponentClass<P>) { | ||
| const InfiniteLoaderComponent = ({ | ||
| infiniteLoaderProps: { isRowLoaded, loadMoreRows, minimumBatchSize, rowCount, threshold }, | ||
| ...rest | ||
| }: WithInfiniteLoaderProps & Omit<P, keyof WithOnRowsRendered>) => ( | ||
| <InfiniteLoader | ||
| isRowLoaded={isRowLoaded} | ||
| loadMoreRows={loadMoreRows} | ||
| minimumBatchSize={minimumBatchSize} | ||
| rowCount={rowCount} | ||
| threshold={threshold} | ||
| > | ||
| {({ onRowsRendered, registerChild }) => ( | ||
| <WrappedComponent {...(rest as unknown as P)} ref={registerChild} onRowsRendered={onRowsRendered} /> | ||
| )} | ||
| </InfiniteLoader> | ||
| ); | ||
|
|
||
| InfiniteLoaderComponent.displayName = `WithInfiniteLoader(${getDisplayName(WrappedComponent)})`; | ||
|
|
||
| return InfiniteLoaderComponent; | ||
| } | ||
|
|
||
| export default withInfiniteLoader; | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.