feat: add DataTableWrapper (#18503)

* feat: data table wrapper

* feat: add DataTableWrapper

---------

Co-authored-by: Udit Takkar <53316345+Udit-takkar@users.noreply.github.com>
This commit is contained in:
Eunjae LeeandUdit Takkar authored and GitHub committed 2025-01-08 09:12:55 +00:00
1 parent 15156c2225
commit 1ab9622416
6 files changed
+153 -112

No files matched your search

@@ -0,0 +1,73 @@
"use client";
import type { Table as ReactTableType } from "@tanstack/react-table";
import { useRef } from "react";
import {
DataTable,
DataTableToolbar,
DataTablePagination,
useFetchMoreOnBottomReached,
} from "@calcom/features/data-table";
export type DataTableWrapperProps<TData, TValue> = {
testId?: string;
table: ReactTableType<TData>;
isPending: boolean;
hasNextPage: boolean;
fetchNextPage: () => void;
isFetching: boolean;
totalDBRowCount?: number;
ToolbarLeft?: React.ReactNode;
ToolbarRight?: React.ReactNode;
children: React.ReactNode;
};
export function DataTableWrapper<TData, TValue>({
testId,
table,
isPending,
hasNextPage,
fetchNextPage,
isFetching,
totalDBRowCount,
ToolbarLeft,
ToolbarRight,
children,
}: DataTableWrapperProps<TData, TValue>) {
const tableContainerRef = useRef<HTMLDivElement>(null);
const fetchMoreOnBottomReached = useFetchMoreOnBottomReached({
tableContainerRef,
hasNextPage,
fetchNextPage,
isFetching,
});
return (
<DataTable
data-testid={testId}
table={table}
tableContainerRef={tableContainerRef}
isPending={isPending}
enableColumnResizing={true}
onScroll={(e) => fetchMoreOnBottomReached(e.target as HTMLDivElement)}>
<DataTableToolbar.Root>
<div className="flex w-full flex-col gap-2 sm:flex-row">
<div className="flex w-full flex-wrap items-center justify-between gap-2">
<div className="flex justify-start gap-2">{ToolbarLeft}</div>
<div className="grow" />
<div className="flex justify-end gap-2">{ToolbarRight}</div>
</div>
</div>
{children}
</DataTableToolbar.Root>
{totalDBRowCount && (
<div style={{ gridArea: "footer", marginTop: "1rem" }}>
<DataTablePagination table={table} totalDbDataCount={totalDBRowCount} />
</div>
)}
</DataTable>
);
}
@@ -122,19 +122,18 @@ const ColumnVisibilityButton = forwardRef(ColumnVisibilityButtonComponent) as <T
// Filters
interface AddFilterButtonProps<TData> {
table: Table<TData>;
omit?: string[];
externalFilters?: ExternalFilter[];
}
function AddFilterButtonComponent<TData>(
{ table, omit, externalFilters }: AddFilterButtonProps<TData>,
{ table, externalFilters }: AddFilterButtonProps<TData>,
ref: React.Ref<HTMLButtonElement>
) {
const { t } = useLocale();
const { activeFilters, setActiveFilters, displayedExternalFilters, setDisplayedExternalFilters } =
useDataTable();
const filterableColumns = useFilterableColumns(table, omit);
const filterableColumns = useFilterableColumns(table);
const handleAddFilter = useCallback(
(columnId: string) => {
@@ -188,14 +187,10 @@ function AddFilterButtonComponent<TData>(
);
}
function useFilterableColumns<TData>(table: Table<TData>, omit?: string[]) {
function useFilterableColumns<TData>(table: Table<TData>) {
const columns = useMemo(
() =>
table
.getAllColumns()
.filter((column) => column.getCanFilter())
.filter((column) => !omit?.includes(column.id)),
[table.getAllColumns(), omit]
() => table.getAllColumns().filter((column) => column.getCanFilter()),
[table.getAllColumns()]
);
const filterableColumns = useMemo<FilterableColumn[]>(
@@ -228,7 +223,7 @@ function useFilterableColumns<TData>(table: Table<TData>, omit?: string[]) {
}
const AddFilterButton = forwardRef(AddFilterButtonComponent) as <TData>(
props: AddFilterButtonProps<TData> & { ref?: React.Ref<HTMLButtonElement>; omit?: string[] }
props: AddFilterButtonProps<TData> & { ref?: React.Ref<HTMLButtonElement> }
) => ReturnType<typeof AddFilterButtonComponent>;
// Add the new ActiveFilters component
@@ -4,4 +4,5 @@ export { DataTablePagination } from "./DataTablePagination";
export { DataTableFilters } from "./filters";
export { DataTable } from "./DataTable";
export { DataTableSkeleton } from "./DataTableSkeleton";
export { DataTableWrapper } from "./DataTableWrapper";
export type { DataTableProps } from "./DataTable";
+2 -1
View File
@@ -52,7 +52,8 @@ export function DataTableProvider({ children }: { children: React.ReactNode }) {
const clearAll = useCallback(() => {
setActiveFilters([]);
}, [setActiveFilters]);
setDisplayedExternalFilters([]);
}, [setActiveFilters, setDisplayedExternalFilters]);
const updateFilter = useCallback(
(columnId: string, value: FilterValue) => {
@@ -11,17 +11,16 @@ import {
// eslint-disable-next-line no-restricted-imports
import startCase from "lodash/startCase";
import Link from "next/link";
import { useRef, useMemo, useId } from "react";
import { useMemo, useId } from "react";
import { z } from "zod";
import dayjs from "@calcom/dayjs";
import type { ExternalFilter } from "@calcom/features/data-table";
import {
DataTableProvider,
DataTable,
DataTableSkeleton,
DataTableWrapper,
DataTableFilters,
useFetchMoreOnBottomReached,
DataTableProvider,
DataTableSkeleton,
useColumnFilters,
multiSelectFilter,
textFilter,
@@ -260,14 +259,9 @@ export function RoutingFormResponsesTable() {
);
}
export function RoutingFormResponsesTableContent({
children,
}: {
children?: React.ReactNode | ((table: RoutingFormTableType) => React.ReactNode);
}) {
export function RoutingFormResponsesTableContent() {
const { t } = useLocale();
const { filter } = useFilterContext();
const tableContainerRef = useRef<HTMLDivElement>(null);
const { copyToClipboard } = useCopy();
const {
@@ -534,13 +528,6 @@ export function RoutingFormResponsesTableContent({
},
});
const fetchMoreOnBottomReached = useFetchMoreOnBottomReached({
tableContainerRef,
hasNextPage,
fetchNextPage,
isFetching,
});
const externalFilters = useMemo<ExternalFilter[]>(
() => [
{
@@ -563,24 +550,23 @@ export function RoutingFormResponsesTableContent({
return (
<div className="flex-1">
<DataTable
<DataTableWrapper
table={table}
tableContainerRef={tableContainerRef}
onScroll={(e) => {
if (hasNextPage) {
fetchMoreOnBottomReached(e.target as HTMLDivElement);
}
}}
enableColumnResizing={true}
isPending={isFetching && !data}>
<div className="header mb-4">
<div className="flex flex-wrap items-start gap-2">
isPending={isFetching && !data}
hasNextPage={hasNextPage}
fetchNextPage={fetchNextPage}
isFetching={isFetching}
ToolbarLeft={
<>
<TeamAndSelfList omitOrg={true} className="mb-0" />
<DataTableFilters.AddFilterButton table={table} externalFilters={externalFilters} />
<RoutingFormFilterList showOnlyWhenSelectedInContext={false} />
<DataTableFilters.ActiveFilters table={table} externalFilters={externalFilters} />
<ClearFilters />
<div className="grow" />
</>
}
ToolbarRight={
<>
<DateSelect />
<RoutingFormResponsesDownload
startDate={startDate}
@@ -594,10 +580,10 @@ export function RoutingFormResponsesTableContent({
sorting={sorting}
/>
<DataTableFilters.ColumnVisibilityButton table={table} />
</div>
<RoutingKPICards />
</div>
</DataTable>
</>
}>
<RoutingKPICards />
</DataTableWrapper>
</div>
);
}
@@ -4,17 +4,15 @@ import { keepPreviousData } from "@tanstack/react-query";
import { getCoreRowModel, getSortedRowModel, useReactTable, type ColumnDef } from "@tanstack/react-table";
import { useSession } from "next-auth/react";
import { useQueryState, parseAsBoolean } from "nuqs";
import { useMemo, useReducer, useRef, useState } from "react";
import { useMemo, useReducer, useState } from "react";
import {
DataTableWrapper,
DataTableProvider,
DataTable,
DataTableToolbar,
DataTableFilters,
DataTableSelectionBar,
DataTablePagination,
DataTableFilters,
useColumnFilters,
useFetchMoreOnBottomReached,
textFilter,
isTextFilterValue,
isSingleSelectFilterValue,
@@ -122,7 +120,6 @@ function UserListTableContent() {
const { data: teams } = trpc.viewer.organizations.getTeams.useQuery();
const { data: facetedTeamValues } = trpc.viewer.organizations.getFacetedValues.useQuery();
const tableContainerRef = useRef<HTMLDivElement>(null);
const [state, dispatch] = useReducer(reducer, initialState);
const [debouncedSearchTerm, setDebouncedSearchTerm] = useState("");
const [isDownloading, setIsDownloading] = useState(false);
@@ -294,6 +291,7 @@ function UserListTableContent() {
id: "member",
accessorFn: (data) => data.email,
enableHiding: false,
enableColumnFilter: false,
size: 200,
header: () => {
return `Members`;
@@ -485,13 +483,6 @@ function UserListTableContent() {
},
});
const fetchMoreOnBottomReached = useFetchMoreOnBottomReached({
tableContainerRef,
hasNextPage,
fetchNextPage,
isFetching,
});
const numberOfSelectedRows = table.getSelectedRowModel().rows.length;
const handleDownload = async () => {
@@ -549,63 +540,56 @@ function UserListTableContent() {
return (
<>
<DataTable
data-testid="user-list-data-table"
// className="lg:max-w-screen-lg"
<DataTableWrapper
testId="user-list-data-table"
table={table}
tableContainerRef={tableContainerRef}
isPending={isPending}
enableColumnResizing={true}
onScroll={(e) => fetchMoreOnBottomReached(e.target as HTMLDivElement)}>
<DataTableToolbar.Root>
<div className="flex w-full flex-col gap-2 sm:flex-row">
<div className="w-full sm:w-auto sm:min-w-[200px] sm:flex-1">
<DataTableToolbar.SearchBar
table={table}
onSearch={(value) => setDebouncedSearchTerm(value)}
className="sm:max-w-64 max-w-full"
/>
</div>
<div className="flex flex-wrap items-center justify-between gap-2">
hasNextPage={hasNextPage}
fetchNextPage={fetchNextPage}
isFetching={isFetching}
totalDBRowCount={totalDBRowCount}
ToolbarLeft={
<DataTableToolbar.SearchBar
table={table}
onSearch={(value) => setDebouncedSearchTerm(value)}
className="sm:max-w-64 max-w-full"
/>
}
ToolbarRight={
<>
<DataTableToolbar.CTA
type="button"
color="secondary"
StartIcon="file-down"
loading={isDownloading}
onClick={() => handleDownload()}
data-testid="export-members-button">
{t("download")}
</DataTableToolbar.CTA>
<DataTableFilters.AddFilterButton table={table} />
<DataTableFilters.ColumnVisibilityButton table={table} />
{adminOrOwner && (
<DataTableToolbar.CTA
type="button"
color="secondary"
StartIcon="file-down"
loading={isDownloading}
onClick={() => handleDownload()}
data-testid="export-members-button">
{t("download")}
color="primary"
StartIcon="plus"
className="rounded-md"
onClick={() =>
dispatch({
type: "INVITE_MEMBER",
payload: {
showModal: true,
},
})
}
data-testid="new-organization-member-button">
{t("add")}
</DataTableToolbar.CTA>
{/* We have to omit member because we don't want the filter to show but we can't disable filtering as we need that for the search bar */}
<DataTableFilters.AddFilterButton table={table} omit={["member"]} />
<DataTableFilters.ColumnVisibilityButton table={table} />
{adminOrOwner && (
<DataTableToolbar.CTA
type="button"
color="primary"
StartIcon="plus"
className="rounded-md"
onClick={() =>
dispatch({
type: "INVITE_MEMBER",
payload: {
showModal: true,
},
})
}
data-testid="new-organization-member-button">
{t("add")}
</DataTableToolbar.CTA>
)}
</div>
</div>
<div className="flex gap-2 justify-self-start">
<DataTableFilters.ActiveFilters table={table} />
</div>
</DataTableToolbar.Root>
<div style={{ gridArea: "footer", marginTop: "1rem" }}>
<DataTablePagination table={table} totalDbDataCount={totalDBRowCount} />
)}
</>
}>
<div className="flex gap-2 justify-self-start">
<DataTableFilters.ActiveFilters table={table} />
</div>
{numberOfSelectedRows >= 2 && dynamicLinkVisible && (
@@ -638,7 +622,8 @@ function UserListTableContent() {
/>
</DataTableSelectionBar.Root>
)}
</DataTable>
</DataTableWrapper>
{state.deleteMember.showModal && <DeleteMemberModal state={state} dispatch={dispatch} />}
{state.inviteMember.showModal && <InviteMemberModal dispatch={dispatch} />}
{state.impersonateMember.showModal && <ImpersonationMemberModal dispatch={dispatch} state={state} />}