Skip to content
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.

Sign up for GitHub

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

Allow virtualizing rows when groupBy is active #779

Merged
merged 1 commit into from
Sep 25, 2023
Merged

Allow virtualizing rows when groupBy is active #779

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
109 changes: 49 additions & 60 deletions packages/bento-design-system/src/Table/Table.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,25 +94,20 @@ type Props<
> = {
columns: C;
data: ReadonlyArray<RowType<C>>;
groupBy?: C extends ReadonlyArray<SimpleColumnType<string, any, any>>
? C[number]["accessor"]
: C extends ReadonlyArray<GroupedColumnType<string, any, any>>
? C[number]["columns"][number]["accessor"]
: never;
noResultsTitle?: LocalizedString;
noResultsDescription?: LocalizedString;
noResultsFeedbackSize?: FeedbackProps["size"];
initialSorting?: Array<SortingRule<C>>;
stickyHeaders?: boolean;
height?: { custom: string | number };
onRowPress?: (row: Row<RowType<C>>) => void;
} & (
| {
groupBy?: C extends ReadonlyArray<SimpleColumnType<string, any, any>>
? C[number]["accessor"]
: C extends ReadonlyArray<GroupedColumnType<string, any, any>>
? C[number]["columns"][number]["accessor"]
: never;
virtualizeRows?: never;
}
| { groupBy?: never; virtualizeRows?: boolean | { estimateRowHeight: (index: number) => number } }
) &
SortingProps<C>;
virtualizeRows?: boolean | { estimateRowHeight: (index: number) => number };
} & SortingProps<C>;

/**
* A component that renders a Table, with sorting capabilities
Expand Down Expand Up @@ -300,17 +295,19 @@ export function Table<
}
}, [data.length, headerGroups, stickyLeftColumnsIds, stickyLeftColumnGroupsIds]);

const flatRows = rows.flatMap((row) => (row.isGrouped ? [row, ...row.leafRows] : [row]));

const tableContainerRef = useRef<HTMLDivElement>(null);

const virtualizeRows =
typeof virtualizeRowsConfig === "boolean" ? virtualizeRowsConfig : virtualizeRowsConfig != null;
const estimateSize =
typeof virtualizeRowsConfig === "boolean"
? () => 52 // Default height of a medium-sized text cell
? (index: number) => (flatRows[index]?.isGrouped ? 26 : 52) // Default heights of a group row and of a medium-sized text cell
: virtualizeRowsConfig?.estimateRowHeight ?? (() => 0);

const rowVirtualizer = useVirtualizer({
count: rows.length,
count: flatRows.length,
getScrollElement: () => tableContainerRef.current,
estimateSize,
});
Expand Down Expand Up @@ -360,8 +357,9 @@ export function Table<
.exhaustive();
}

const gridTemplateColumns = flatColumns
.filter(({ accessor }) => accessor !== groupBy)
const nonGroupedColumns = flatColumns.filter(({ accessor }) => accessor !== groupBy);

const gridTemplateColumns = nonGroupedColumns
.map(({ gridWidth = "fit-content" }) => gridWidthStyle(gridWidth))
.join(" ");

Expand All @@ -385,50 +383,39 @@ export function Table<
));
}

const renderedRows = virtualizeRows
? flatColumns
.map((_, index) => (
<div key={`paddingTop${index}`} style={{ marginTop: virtualPaddingTop }} />
))
.concat(
virtualRows.map((virtualRow) => {
const index = virtualRow.index;
const row = rows[index];
prepareRow(row);
return (
<RowContainer key={index} row={row} onPress={onRowPress}>
{renderCells(row.cells, index, onRowPress !== undefined)}
</RowContainer>
);
})
)
.concat(
flatColumns.map((_, index) => (
<div key={`paddingBottom${index}`} style={{ marginBottom: virtualPaddingBottom }} />
))
)
: rows.flatMap((row, index) => {
if (row.isGrouped) {
return [
<SectionHeader
key={row.groupByVal}
label={row.groupByVal}
numberOfStickyColumns={stickyLeftColumnsIds.length}
/>,
...row.leafRows.map((row, index) => {
prepareRow(row);
return renderCells(row.cells, index, false);
}),
];
} else {
prepareRow(row);
return (
<RowContainer key={index} row={row} onPress={onRowPress}>
{renderCells(row.cells, index, onRowPress !== undefined)}
</RowContainer>
);
}
});
const rowsToRender = virtualizeRows
? virtualRows.map((virtualRow) => [flatRows[virtualRow.index], virtualRow.index] as const)
: flatRows.map((row, index) => [row, index] as const);

const paddingTopRow = virtualizeRows
? nonGroupedColumns.map((_, index) => (
<div key={`paddingTop${index}`} style={{ marginTop: virtualPaddingTop }} />
))
: [];
const paddingBottomRow = virtualizeRows
? nonGroupedColumns.map((_, index) => (
<div key={`paddingBottom${index}`} style={{ marginBottom: virtualPaddingBottom }} />
))
: [];

const renderedRows = rowsToRender.map(([row, index]) => {
if (row.isGrouped) {
return (
<SectionHeader
key={row.groupByVal}
label={row.groupByVal}
numberOfStickyColumns={stickyLeftColumnsIds.length}
/>
);
} else {
prepareRow(row);
return (
<RowContainer key={index} row={row} onPress={onRowPress}>
{renderCells(row.cells, index, onRowPress !== undefined)}
</RowContainer>
);
}
});

return (
<Box
Expand Down Expand Up @@ -469,7 +456,9 @@ export function Table<
/>
))
)}
{paddingTopRow}
{renderedRows}
{paddingBottomRow}
</Box>
);
}
Expand Down
23 changes: 20 additions & 3 deletions packages/bento-design-system/stories/Components/Table.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -573,17 +573,34 @@ export const VirtualizedRows = {
args: {
stickyHeaders: true,
height: { custom: 340 },
virtualizeRows: true,
virtualizeRows: { estimateRowHeight: () => 92 },
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not related to this PR, but I noticed that the table can glitch while scrolling if the estimated height is less than the true one. Since we are defaulting internally to the single line text cell height but with the example data we have multiple lines and thus higher rows, we have to provide the estimates from outside for the examples to work smoothly

data: repeatToLength(exampleData, 1_000),
},
} satisfies Story;

export const VirtualizedRowsGrupedHeaders = {
export const VirtualizedRowsGroupedHeaders = {
args: {
columns: exampleGroupedColumns,
stickyHeaders: true,
height: { custom: 340 },
virtualizeRows: true,
virtualizeRows: { estimateRowHeight: () => 92 },
data: repeatToLength(exampleData, 1_000),
},
} satisfies Story;

export const VirtualizedRowsGroupedRows = {
args: {
columns: [
...exampleColumns,
tableColumn.text({
headerLabel: "Group",
accessor: "group",
}),
] as const,
groupBy: "group",
stickyHeaders: true,
height: { custom: 340 },
virtualizeRows: { estimateRowHeight: () => 92 },
data: repeatToLength(exampleData, 1_000),
},
} satisfies Story;