84e2646909
Summary: To make the DataSource abstraction reusable for other teams and an upcoming talk, this diff moves all DataSource storage & virtualization logic in one folder. Will set up a build process and demo project in later diffs. Reviewed By: nikoant Differential Revision: D28056700 fbshipit-source-id: 7cfe5b40bbbe387da711f765a604a45029d451c7
109 lines
3.1 KiB
TypeScript
109 lines
3.1 KiB
TypeScript
/**
|
|
* Copyright (c) Facebook, Inc. and its affiliates.
|
|
*
|
|
* This source code is licensed under the MIT license found in the
|
|
* LICENSE file in the root directory of this source tree.
|
|
*
|
|
* @format
|
|
*/
|
|
|
|
import {DataSource} from './DataSource';
|
|
import React, {memo, useCallback, useEffect, useState} from 'react';
|
|
|
|
import {RedrawContext} from './DataSourceRendererVirtual';
|
|
|
|
type DataSourceProps<T extends object, C> = {
|
|
/**
|
|
* The data source to render
|
|
*/
|
|
dataSource: DataSource<T, any, any>;
|
|
/**
|
|
* additional context that will be passed verbatim to the itemRenderer, so that it can be easily memoized
|
|
*/
|
|
context?: C;
|
|
/**
|
|
* Takes care of rendering an item
|
|
* @param item The item as stored in the dataSource
|
|
* @param index The index of the item being rendered. The index represents the offset in the _visible_ items of the dataSource
|
|
* @param context The optional context passed into this DataSourceRenderer
|
|
*/
|
|
itemRenderer(item: T, index: number, context: C): React.ReactElement;
|
|
useFixedRowHeight: boolean;
|
|
defaultRowHeight: number;
|
|
onKeyDown?: React.KeyboardEventHandler<HTMLDivElement>;
|
|
onUpdateAutoScroll?(autoScroll: boolean): void;
|
|
emptyRenderer?: null | ((dataSource: DataSource<T>) => React.ReactElement);
|
|
};
|
|
|
|
/**
|
|
* This component is UI agnostic, and just takes care of rendering all items in the DataSource.
|
|
* This component does not apply virtualization, so don't use it for large datasets!
|
|
*/
|
|
export const DataSourceRendererStatic: <T extends object, C>(
|
|
props: DataSourceProps<T, C>,
|
|
) => React.ReactElement = memo(function DataSourceRendererStatic({
|
|
dataSource,
|
|
useFixedRowHeight,
|
|
context,
|
|
itemRenderer,
|
|
onKeyDown,
|
|
emptyRenderer,
|
|
}: DataSourceProps<any, any>) {
|
|
/**
|
|
* Virtualization
|
|
*/
|
|
// render scheduling
|
|
const [, setForceUpdate] = useState(0);
|
|
|
|
const redraw = useCallback(() => {
|
|
setForceUpdate((x) => x + 1);
|
|
}, []);
|
|
|
|
useEffect(
|
|
function subscribeToDataSource() {
|
|
let unmounted = false;
|
|
|
|
dataSource.view.setWindow(0, dataSource.limit);
|
|
dataSource.view.setListener((_event) => {
|
|
if (unmounted) {
|
|
return;
|
|
}
|
|
setForceUpdate((x) => x + 1);
|
|
});
|
|
|
|
return () => {
|
|
unmounted = true;
|
|
dataSource.view.setListener(undefined);
|
|
};
|
|
},
|
|
[dataSource, setForceUpdate, useFixedRowHeight],
|
|
);
|
|
|
|
useEffect(() => {
|
|
// initial virtualization is incorrect because the parent ref is not yet set, so trigger render after mount
|
|
setForceUpdate((x) => x + 1);
|
|
}, [setForceUpdate]);
|
|
|
|
/**
|
|
* Rendering
|
|
*/
|
|
const records = dataSource.view.output();
|
|
if (records.length > 500) {
|
|
console.warn(
|
|
"StaticDataSourceRenderer should only be used on small datasets. For large datasets the 'scrollable' flag should enabled on DataTable",
|
|
);
|
|
}
|
|
|
|
return (
|
|
<RedrawContext.Provider value={redraw}>
|
|
<div onKeyDown={onKeyDown} tabIndex={0}>
|
|
{records.length === 0
|
|
? emptyRenderer?.(dataSource)
|
|
: records.map((item, index) => (
|
|
<div key={index}>{itemRenderer(item, index, context)}</div>
|
|
))}
|
|
</div>
|
|
</RedrawContext.Provider>
|
|
);
|
|
}) as any;
|