PORTALS-2795 - Support virtualizing TanStack tables #1485
There are no files selected for viewing
This file contains 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
This file contains 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 |
|---|---|---|
| @@ -1,25 +1,59 @@ | ||
| import { flexRender, Row, Table } from '@tanstack/react-table' | ||
| import { useMemo } from 'react' | ||
| import { | ||
| StyledTableContainer, | ||
| StyledTableContainerProps, | ||
| } from '../styled/StyledTableContainer' | ||
| import { MemoizedTableBody, TableBody, TableBodyProps } from './TableBody' | ||
| import { | ||
| getColumnSizeCssVariable, | ||
| getHeaderSizeCssVariable, | ||
| } from './TanStackTableUtils' | ||
| import { StyledTanStackTableSlotProps, StyledTanStackTableSlots } from './types' | ||
|
|
||
| export type StyledTanStackTableProps<TData = unknown, TRowType = Row<TData>> = { | ||
| table: Table<TData> | ||
| styledTableContainerProps?: StyledTableContainerProps | ||
| fullWidth?: boolean | ||
| slots?: StyledTanStackTableSlots<TData, TRowType> | ||
| slotProps?: StyledTanStackTableSlotProps<TData, TRowType> | ||
|
Comment on lines
+18
to
+19
There was a problem hiding this comment. In an effort to reduce duplicate code, I added There was a problem hiding this comment. This is my first exposure to the slots design pattern, and I can see the utility. I think it was a good call to copy this pattern in this implementation |
||
| } & Pick<TableBodyProps<TData, TRowType>, 'rows' | 'rowTransform'> | ||
|
|
||
| /** | ||
| * Component that renders a styled table using @tanstack/react-table. Pass your table instance into the component and | ||
| * it will render the table with the appropriate headers and rows. | ||
| */ | ||
| export default function StyledTanStackTable< | ||
| TData = unknown, | ||
| TRowType = Row<TData>, | ||
| >(props: StyledTanStackTableProps<TData, TRowType>) { | ||
| const { | ||
| table, | ||
| styledTableContainerProps, | ||
| fullWidth = true, | ||
| slots = {}, | ||
| slotProps = {}, | ||
| } = props | ||
| const { | ||
| Thead = 'thead', | ||
| Th = 'th', | ||
| Table = 'table', | ||
| ...tableBodySlots | ||
| } = slots | ||
| const { | ||
| Table: tableSlotProps = {}, | ||
| Thead: theadSlotProps = {}, | ||
| Th: thSlotProps = {}, | ||
| ...tableBodySlotProps | ||
| } = slotProps | ||
|
|
||
| const tableBodyProps: TableBodyProps<TData, TRowType> = { | ||
| table, | ||
| slots: tableBodySlots, | ||
| slotProps: tableBodySlotProps, | ||
| rows: props.rows!, | ||
| rowTransform: props.rowTransform!, | ||
| } | ||
|
|
||
| /** | ||
| * Instead of calling `column.getSize()` on every render for every header | ||
|
|
@@ -51,19 +85,28 @@ export default function StyledTanStackTable<T = unknown>( | |
|
|
||
| return ( | ||
| <StyledTableContainer {...styledTableContainerProps}> | ||
| <Table | ||
| {...tableSlotProps} | ||
| style={{ | ||
| ...columnSizeVars, | ||
| width: tableWidth, | ||
| ...tableSlotProps['style'], | ||
| }} | ||
| > | ||
| <Thead {...theadSlotProps}> | ||
| {table.getHeaderGroups().map(headerGroup => { | ||
| return ( | ||
| <tr key={headerGroup.id}> | ||
| {headerGroup.headers.map(header => ( | ||
| <Th | ||
| key={header.id} | ||
| colSpan={header.colSpan} | ||
| {...thSlotProps} | ||
| style={{ | ||
| width: `calc(var(${getHeaderSizeCssVariable( | ||
| header.id, | ||
| )}) * 1px)`, | ||
| ...thSlotProps['style'], | ||
| }} | ||
| > | ||
| {header.isPlaceholder | ||
|
|
@@ -81,14 +124,14 @@ export default function StyledTanStackTable<T = unknown>( | |
| onTouchStart={header.getResizeHandler()} | ||
| /> | ||
| )} | ||
| </Th> | ||
| ))} | ||
| </tr> | ||
| ) | ||
| })} | ||
| </Thead> | ||
| <TableBodyElement<TData, TRowType> {...tableBodyProps} /> | ||
| </Table> | ||
| </StyledTableContainer> | ||
| ) | ||
| } | ||
This file contains 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,123 @@ | ||
| import { VirtualItem, Virtualizer } from '@tanstack/react-virtual' | ||
| import { noop } from 'lodash-es' | ||
| import React, { useContext } from 'react' | ||
| import { mergeSlotProps } from '../../utils/slots/SlotUtils' | ||
| import StyledTanStackTable, { | ||
| StyledTanStackTableProps, | ||
| } from './StyledTanStackTable' | ||
|
|
||
| import { TrProps } from './types' | ||
|
|
||
| type StyledVirtualTanStackTableProps<T = unknown> = Omit< | ||
| StyledTanStackTableProps<T, VirtualItem>, | ||
| 'slots' | 'rows' | 'rowTransform' | ||
| > & { | ||
| rowVirtualizer: Virtualizer<any, any> | ||
| onTableContainerScroll?: (target: EventTarget) => void | ||
| } | ||
|
|
||
| // Context to pass the row virtualizer to the Tr component | ||
| const RowVirtualizerContext = React.createContext< | ||
| Virtualizer<any, any> | undefined | ||
| >(undefined) | ||
|
|
||
| /** | ||
| * A table row component modified to be used with @tanstack/react-virtual. | ||
| */ | ||
| export function VirtualizedTr<TData = unknown>( | ||
| props: TrProps<TData, VirtualItem>, | ||
| ) { | ||
| const { row: virtualItem, tableRow: _tableRow, ...rest } = props | ||
| const rowVirtualizer = useContext(RowVirtualizerContext) | ||
| return ( | ||
| <tr | ||
| data-index={virtualItem.index} // needed for dynamic row height measurement | ||
| ref={node => rowVirtualizer?.measureElement(node)} //measure dynamic row height | ||
| {...rest} | ||
| style={{ | ||
| ...rest.style, | ||
| display: 'flex', | ||
| position: 'absolute', | ||
| transform: `translateY(${virtualItem.start}px)`, //this should always be a `style` as it changes on scroll | ||
| width: '100%', | ||
| }} | ||
| /> | ||
| ) | ||
| } | ||
|
|
||
| /** | ||
| * Stylized table component that is compatible with @tanstack/react-table and @tanstack/react-virtual to display a | ||
| * virtualized table, i.e. a table that uses a virtualizer to only render the DOM nodes that contain data that is visible | ||
| * within the viewport. For cases where the table rows do not need to be virtualized, use {@link StyledTanStackTable}. | ||
| */ | ||
| export default function StyledVirtualTanStackTable<T = unknown>( | ||
|
There was a problem hiding this comment. New component that adds the styles / component overrides needed for virtualization to work |
||
| props: StyledVirtualTanStackTableProps<T>, | ||
| ) { | ||
| const { | ||
| table, | ||
| styledTableContainerProps, | ||
| fullWidth = true, | ||
| rowVirtualizer, | ||
| slotProps = {}, | ||
| onTableContainerScroll = noop, | ||
| } = props | ||
|
|
||
| const virtualRows = rowVirtualizer.getVirtualItems() | ||
|
|
||
| return ( | ||
| <RowVirtualizerContext.Provider value={rowVirtualizer}> | ||
| <StyledTanStackTable<T, VirtualItem> | ||
| table={table} | ||
| rows={virtualRows} | ||
| rowTransform={row => table.getRowModel().rows[row.index]} | ||
| fullWidth={fullWidth} | ||
| styledTableContainerProps={{ | ||
| ...styledTableContainerProps, | ||
| style: { | ||
| overflow: 'auto', //our scrollable table container | ||
| position: 'relative', //needed for sticky header | ||
| ...styledTableContainerProps?.style, | ||
| }, | ||
| sx: { | ||
| 'thead > tr': { | ||
| display: 'flex', | ||
| width: '100%', | ||
| }, | ||
| }, | ||
| onScroll: e => onTableContainerScroll(e.target), | ||
| }} | ||
| {...styledTableContainerProps} | ||
| slots={{ | ||
| Tr: VirtualizedTr, | ||
| }} | ||
| slotProps={mergeSlotProps(slotProps, { | ||
| Table: { | ||
| style: { | ||
| display: 'grid', | ||
| }, | ||
| }, | ||
| Thead: { | ||
| style: { | ||
| display: 'grid', | ||
| position: 'sticky', | ||
| top: 0, | ||
| zIndex: 1, | ||
| }, | ||
| }, | ||
| Th: { | ||
| style: { | ||
| display: 'flex', | ||
| }, | ||
| }, | ||
| Tbody: { | ||
| style: { | ||
| display: 'grid', | ||
|
There was a problem hiding this comment. Uses a |
||
| height: `${rowVirtualizer.getTotalSize()}px`, //tells scrollbar how big the table is | ||
| position: 'relative', //needed for absolute positioning of rows | ||
| }, | ||
| }, | ||
| })} | ||
| /> | ||
| </RowVirtualizerContext.Provider> | ||
| ) | ||
| } | ||
This file contains 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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@tanstack/react-virtual is very small, and was easy to figure out how to get it to work with @tanstack/react-table compared to react-window, since examples exist in the react-table docs.
We're also removing another virtualization library embedded in react-base-table, so while I don't want to have multiple dependencies that do the same thing, I think this is progress.