I am trying to make a lightweight table in React.js that has a lot of features (row selection, drag&drop, sorting, searching, pagination) for hundreds of rows of data. I am focusing on the drag and drop feature right now, but my current implementation below does not work:
https://codesandbox.io/p/sandbox/youthful-framework-353773
// https://tanstack.com/table/v8/docs/framework/react/examples/row-selection
import React from "react";
import {
ColumnDef,
getCoreRowModel,
useReactTable,
flexRender,
} from "@tanstack/react-table";
import { DndContext, closestCenter } from "@dnd-kit/core";
import {
arrayMove,
SortableContext,
verticalListSortingStrategy,
} from "@dnd-kit/sortable";
import { useSortable } from "@dnd-kit/sortable";
import { CSS } from "@dnd-kit/utilities";
import styles from "./Table.module.css";
// Drag handle for rows
function DragHandle({ rowId }) {
const { attributes, listeners } = useSortable({ id: rowId });
return (
<button
{...attributes}
{...listeners}
className={styles.dragHandle}
title="Drag to reorder"
>
🟰
</button>
);
}
// Row Component
function Row({ row }) {
const { attributes, listeners, setNodeRef, transform, transition } =
useSortable({
id: row.id,
});
const style = {
transform: CSS.Transform.toString(transform),
transition,
};
return (
<tr
ref={setNodeRef}
style={style}
{...attributes}
{...listeners}
className={styles.row}
>
{row.getVisibleCells().map((cell, index) => (
<td key={cell.id} className={styles.cell}>
{index === 0 ? <DragHandle rowId={row.id} /> : null}
{flexRender(cell.column.columnDef.cell, cell.getContext())}
</td>
))}
</tr>
);
}
// Table Component
function Table({ data, setData, columns }) {
const tableColumns = React.useMemo(() => [...columns], [columns]);
const table = useReactTable({
data,
columns: tableColumns,
getCoreRowModel: getCoreRowModel(),
});
const handleDragEnd = (event) => {
const { active, over } = event;
if (!active?.id || !over?.id || active.id === over.id) {
return;
}
setData((oldData) => {
const oldIndex = oldData.findIndex((row) => row.id === active.id);
const newIndex = oldData.findIndex((row) => row.id === over.id);
if (oldIndex !== -1 && newIndex !== -1) {
return arrayMove(oldData, oldIndex, newIndex);
}
return oldData;
});
};
return (
<DndContext collisionDetection={closestCenter} onDragEnd={handleDragEnd}>
<SortableContext
items={data.map((row) => row.id)}
strategy={verticalListSortingStrategy}
>
<table className={styles.table}>
<thead>
{table.getHeaderGroups().map((headerGroup) => (
<tr key={headerGroup.id} className={styles.headerRow}>
{headerGroup.headers.map((header) => (
<th key={header.id} className={styles.headerCell}>
{flexRender(
header.column.columnDef.header,
header.getContext()
)}
</th>
))}
</tr>
))}
</thead>
<tbody>
{table.getRowModel().rows.map((row) => (
<Row key={row.id} row={row} />
))}
</tbody>
</table>
</SortableContext>
</DndContext>
);
}
export default Table;
Even though there is a working example they provide which I am trying to replicate:
https://tanstack.com/table/v8/docs/framework/react/examples/row-dnd
import React, { CSSProperties } from 'react'
import ReactDOM from 'react-dom/client'
import './index.css'
import {
ColumnDef,
Row,
flexRender,
getCoreRowModel,
useReactTable,
} from '@tanstack/react-table'
import { makeData, Person } from './makeData'
// needed for table body level scope DnD setup
import {
DndContext,
KeyboardSensor,
MouseSensor,
TouchSensor,
closestCenter,
type DragEndEvent,
type UniqueIdentifier,
useSensor,
useSensors,
} from '@dnd-kit/core'
import { restrictToVerticalAxis } from '@dnd-kit/modifiers'
import {
arrayMove,
SortableContext,
verticalListSortingStrategy,
} from '@dnd-kit/sortable'
// needed for row & cell level scope DnD setup
import { useSortable } from '@dnd-kit/sortable'
import { CSS } from '@dnd-kit/utilities'
// Cell Component
const RowDragHandleCell = ({ rowId }: { rowId: string }) => {
const { attributes, listeners } = useSortable({
id: rowId,
})
return (
// Alternatively, you could set these attributes on the rows themselves
<button {...attributes} {...listeners}>
🟰
</button>
)
}
// Row Component
const DraggableRow = ({ row }: { row: Row<Person> }) => {
const { transform, transition, setNodeRef, isDragging } = useSortable({
id: row.original.userId,
})
const style: CSSProperties = {
transform: CSS.Transform.toString(transform), //let dnd-kit do its thing
transition: transition,
opacity: isDragging ? 0.8 : 1,
zIndex: isDragging ? 1 : 0,
position: 'relative',
}
return (
// connect row ref to dnd-kit, apply important styles
<tr ref={setNodeRef} style={style}>
{row.getVisibleCells().map(cell => (
<td key={cell.id} style={{ width: cell.column.getSize() }}>
{flexRender(cell.column.columnDef.cell, cell.getContext())}
</td>
))}
</tr>
)
}
// Table Component
function App() {
const columns = React.useMemo<ColumnDef<Person>[]>(
() => [
// Create a dedicated drag handle column. Alternatively, you could just set up dnd events on the rows themselves.
{
id: 'drag-handle',
header: 'Move',
cell: ({ row }) => <RowDragHandleCell rowId={row.id} />,
size: 60,
},
{
accessorKey: 'firstName',
cell: info => info.getValue(),
},
{
accessorFn: row => row.lastName,
id: 'lastName',
cell: info => info.getValue(),
header: () => <span>Last Name</span>,
},
{
accessorKey: 'age',
header: () => 'Age',
},
{
accessorKey: 'visits',
header: () => <span>Visits</span>,
},
{
accessorKey: 'status',
header: 'Status',
},
{
accessorKey: 'progress',
header: 'Profile Progress',
},
],
[]
)
const [data, setData] = React.useState(() => makeData(20))
const dataIds = React.useMemo<UniqueIdentifier[]>(
() => data?.map(({ userId }) => userId),
[data]
)
const rerender = () => setData(() => makeData(20))
const table = useReactTable({
data,
columns,
getCoreRowModel: getCoreRowModel(),
getRowId: row => row.userId, //required because row indexes will change
debugTable: true,
debugHeaders: true,
debugColumns: true,
})
// reorder rows after drag & drop
function handleDragEnd(event: DragEndEvent) {
const { active, over } = event
if (active && over && active.id !== over.id) {
setData(data => {
const oldIndex = dataIds.indexOf(active.id)
const newIndex = dataIds.indexOf(over.id)
return arrayMove(data, oldIndex, newIndex) //this is just a splice util
})
}
}
const sensors = useSensors(
useSensor(MouseSensor, {}),
useSensor(TouchSensor, {}),
useSensor(KeyboardSensor, {})
)
return (
// NOTE: This provider creates div elements, so don't nest inside of <table> elements
<DndContext
collisionDetection={closestCenter}
modifiers={[restrictToVerticalAxis]}
onDragEnd={handleDragEnd}
sensors={sensors}
>
<div className="p-2">
<div className="h-4" />
<div className="flex flex-wrap gap-2">
<button onClick={() => rerender()} className="border p-1">
Regenerate
</button>
</div>
<div className="h-4" />
<table>
<thead>
{table.getHeaderGroups().map(headerGroup => (
<tr key={headerGroup.id}>
{headerGroup.headers.map(header => (
<th key={header.id} colSpan={header.colSpan}>
{header.isPlaceholder
? null
: flexRender(
header.column.columnDef.header,
header.getContext()
)}
</th>
))}
</tr>
))}
</thead>
<tbody>
<SortableContext
items={dataIds}
strategy={verticalListSortingStrategy}
>
{table.getRowModel().rows.map(row => (
<DraggableRow key={row.id} row={row} />
))}
</SortableContext>
</tbody>
</table>
<pre>{JSON.stringify(data, null, 2)}</pre>
</div>
</DndContext>
)
}
const rootElement = document.getElementById('root')
if (!rootElement) throw new Error('Failed to find the root element')
ReactDOM.createRoot(rootElement).render(
<React.StrictMode>
<App />
</React.StrictMode>
)
The drag and drop in my codesandbox does not currently work, is there a setup option I’m missing? I’ve tried to style it after the example they gave to the best I can.
2
Answers
Here’s a fork of your sandbox with the drag and drop functionality working:
https://codesandbox.io/p/sandbox/table-test-forked-wkkm3v
I changed a few things:
Stored the testData in state, and made the setData function actually update this data instead of being an empty function. Also changed the IDs of the testData a bit.
Changed the id in the
useSortable
hook of theRow
to use the original id.Basically, the issue is that your
setData
function does absolutely nothing.In your
App.js
file, make these 2 changes:setTestData
function to thesetData
prop:Now,
setData
is a function that will update the value, i.e, state oftestData
.Please drop a comment if there is anything you still want to understand.