Shadcn Table
componentdata-table-sort-listsource: stale · stale
Data Table Sort List
A sort list component for the data table
npx shadcn add "https://tablecn.com/r/data-table-sort-list.json"free
This source snapshot is older than our freshness window and couldn't be re-verified just now — it may be outdated.
Where it goes
data-table
Use cases
dashboard
Tags auto-generated by rules on 9/24/2026 — empty means no evidence, not lack of support.
Dependencies
Bundle weight · lighticonslucide-react
formszod
ui-primitives@base-ui/react
Registry dependencies
badgebuttoncommandpopoverselect
Files7 · source cached 9/28/2026, 6:05:24 PM
src/registry/bases/base/components/data-table/data-table-sort-list.tsx
"use client";
import {
type ColumnSort,
type RowData,
type SortingState,
Subscribe,
type Table,
} from "@tanstack/react-table";
import { cn } from "cn";
import * as React from "react";
import type { DataTableFeatures } from "@/lib/data-table-features";
import { dataTableConfig } from "@/lib/data-table-utils";
import { Badge } from "@/registry/bases/base/ui/badge";
import { Button } from "@/registry/bases/base/ui/button";
import {
Command,
CommandEmpty,
CommandGroup,
CommandInput,
CommandItem,
CommandList,
} from "@/registry/bases/base/ui/command";
import {
Popover,
PopoverContent,
PopoverTrigger,
} from "@/registry/bases/base/ui/popover";
import {
Select,
SelectContent,
SelectGroup,
SelectItem,
SelectTrigger,
SelectValue,
} from "@/registry/bases/base/ui/select";
import {
Sortable,
SortableContent,
SortableItem,
SortableItemHandle,
SortableOverlay,
} from "@/registry/bases/base/ui/sortable";
import { IconPlaceholder } from "@/registry/icons/icon-placeholder";
const SORT_SHORTCUT_KEY = "s";
const REMOVE_SORT_SHORTCUTS = ["backspace", "delete"];
interface DataTableSortListProps<
TData extends RowData,
> extends React.ComponentProps<typeof PopoverContent> {
table: Table<DataTableFeatures, TData>;
disabled?: boolean;
}
export function DataTableSortList<TData extends RowData>(
props: DataTableSortListProps<TData>,
) {
return (
<Subscribe source={props.table.atoms.sorting}>
{(sorting) => <DataTableSortListContent {...props} sorting={sorting} />}
</Subscribe>
);
}
function DataTableSortListContent<TData extends RowData>({
table,
disabled,
className,
sorting,
...props
}: DataTableSortListProps<TData> & {
sorting: SortingState;
}) {
const id = React.useId();
const labelId = React.useId();
const descriptionId = React.useId();
const [open, setOpen] = React.useState(false);
const addButtonRef = React.useRef<HTMLButtonElement>(null);
const onSortingChange = table.setSorting;
const { columnLabels, columns } = React.useMemo(() => {
const labels = new Map<string, string>();
const sortingIds = new Set(sorting.map((s) => s.id));
const availableColumns: { id: string; label: string }[] = [];
for (const column of table.getAllColumns()) {
if (!column.getCanSort()) continue;
const label = column.columnDef.meta?.label ?? column.id;
labels.set(column.id, label);
if (!sortingIds.has(column.id)) {
availableColumns.push({ id: column.id, label });
}
}
return {
columnLabels: labels,
columns: availableColumns,
};
}, [sorting, table]);
const onSortAdd = React.useCallback(() => {
const firstColumn = columns[0];
if (!firstColumn) return;
onSortingChange((prevSorting) => [
...prevSorting,
{ id: firstColumn.id, desc: false },
]);
}, [columns, onSortingChange]);
const onSortUpdate = React.useCallback(
(sortId: string, updates: Partial<ColumnSort>) => {
onSortingChange((prevSorting) => {
if (!prevSorting) return prevSorting;
return prevSorting.map((sort) =>
sort.id === sortId ? { ...sort, ...updates } : sort,
);
});
},
[onSortingChange],
);
const onSortRemove = React.useCallback(
(sortId: string) => {
onSortingChange((prevSorting) =>
prevSorting.filter((item) => item.id !== sortId),
);
},
[onSortingChange],
);
const onSortingReset = React.useCallback(
() => onSortingChange(table.initialState.sorting),
[onSortingChange, table.initialState.sorting],
);
React.useEffect(() => {
function onKeyDown(event: KeyboardEvent) {
if (
event.target instanceof HTMLInputElement ||
event.target instanceof HTMLTextAreaElement ||
(event.target instanceof HTMLElement &&
event.target.contentEditable === "true")
) {
return;
}
if (
event.key.toLowerCase() === SORT_SHORTCUT_KEY &&
(event.ctrlKey || event.metaKey) &&
event.shiftKey
) {
event.preventDefault();
setOpen((prev) => !prev);
}
}
window.addEventListener("keydown", onKeyDown);
return () => window.removeEventListener("keydown", onKeyDown);
}, []);
const onTriggerKeyDown = React.useCallback(
(event: React.KeyboardEvent<HTMLButtonElement>) => {
if (
REMOVE_SORT_SHORTCUTS.includes(event.key.toLowerCase()) &&
sorting.length > 0
) {
event.preventDefault();
onSortingReset();
}
},
[sorting.length, onSortingReset],
);
return (
<Sortable
value={sorting}
onValueChange={onSortingChange}
getItemValue={(item) => item.id}
>
<Popover open={open} onOpenChange={setOpen}>
<PopoverTrigger
render={
<Button
variant="outline"
className="font-normal"
onKeyDown={onTriggerKeyDown}
disabled={disabled}
/>
}
>
<IconPlaceholder
lucide="ArrowDownUp"
tabler="IconArrowsLeftRight"
hugeicons="ArrowDataTransferHorizontalIcon"
phosphor="ArrowsVerticalIcon"
remixicon="RiArrowUpDownLine"
className="text-muted-foreground"
/>
Sort
{sorting.length > 0 && (
<Badge
variant="secondary"
className="h-[18.24px] rounded-md px-[5.12px] font-mono text-[10.4px] font-normal"
>
{sorting.length}
</Badge>
)}
</PopoverTrigger>
<PopoverContent
aria-labelledby={labelId}
aria-describedby={descriptionId}
className={cn(
"flex w-full max-w-(--available-width) flex-col gap-3.5 p-4 sm:min-w-95",
className,
)}
{...props}
>
<div className="flex flex-col gap-1">
<h4 id={labelId} className="leading-none font-medium">
{sorting.length > 0 ? "Sort by" : "No sorting applied"}
</h4>
<p
id={descriptionId}
className={cn(
"text-sm text-muted-foreground",
sorting.length > 0 && "sr-only",
)}
>
{sorting.length > 0
? "Modify sorting to organize your rows."
: "Add sorting to organize your rows."}
</p>
</div>
{sorting.length > 0 && (
<SortableContent
render={
<div
role="list"
className="flex max-h-75 flex-col gap-2 overflow-y-auto p-1"
/>
}
>
{sorting.map((sort) => (
<DataTableSortItem
key={sort.id}
sort={sort}
sortItemId={`${id}-sort-${sort.id}`}
columns={columns}
columnLabels={columnLabels}
onSortUpdate={onSortUpdate}
onSortRemove={onSortRemove}
/>
))}
</SortableContent>
)}
<div className="flex w-full items-center gap-2">
<Button
className="rounded"
ref={addButtonRef}
onClick={onSortAdd}
disabled={columns.length === 0}
>
Add sort
</Button>
{sorting.length > 0 && (
<Button
variant="outline"
className="rounded"
onClick={onSortingReset}
>
Reset sorting
</Button>
)}
</div>
</PopoverContent>
</Popover>
<SortableOverlay>
<div className="flex items-center gap-2">
<div className="h-8 w-45 rounded-sm bg-primary/10" />
<div className="h-8 w-24 rounded-sm bg-primary/10" />
<div className="size-8 shrink-0 rounded-sm bg-primary/10" />
<div className="size-8 shrink-0 rounded-sm bg-primary/10" />
</div>
</SortableOverlay>
</Sortable>
);
}
interface DataTableSortItemProps {
sort: ColumnSort;
sortItemId: string;
columns: { id: string; label: string }[];
columnLabels: Map<string, string>;
onSortUpdate: (sortId: string, updates: Partial<ColumnSort>) => void;
onSortRemove: (sortId: string) => void;
}
function DataTableSortItem({
sort,
sortItemId,
columns,
columnLabels,
onSortUpdate,
onSortRemove,
}: DataTableSortItemProps) {
const fieldListboxId = `${sortItemId}-field-listbox`;
const fieldTriggerId = `${sortItemId}-field-trigger`;
const directionListboxId = `${sortItemId}-direction-listbox`;
const [showFieldSelector, setShowFieldSelector] = React.useState(false);
const [showDirectionSelector, setShowDirectionSelector] =
React.useState(false);
const onItemKeyDown = React.useCallback(
(event: React.KeyboardEvent<HTMLDivElement>) => {
if (
event.target instanceof HTMLInputElement ||
event.target instanceof HTMLTextAreaElement
) {
return;
}
if (showFieldSelector || showDirectionSelector) {
return;
}
if (REMOVE_SORT_SHORTCUTS.includes(event.key.toLowerCase())) {
event.preventDefault();
onSortRemove(sort.id);
}
},
[sort.id, showFieldSelector, showDirectionSelector, onSortRemove],
);
return (
<SortableItem
value={sort.id}
render={
<div
role="listitem"
id={sortItemId}
tabIndex={-1}
className="flex items-center gap-2"
onKeyDown={onItemKeyDown}
/>
}
>
<Popover open={showFieldSelector} onOpenChange={setShowFieldSelector}>
<PopoverTrigger
render={
<Button
id={fieldTriggerId}
aria-controls={fieldListboxId}
variant="outline"
className="w-44 justify-between rounded font-normal"
/>
}
>
<span className="truncate">{columnLabels.get(sort.id)}</span>
<IconPlaceholder
lucide="ChevronsUpDown"
tabler="IconSelector"
hugeicons="UnfoldMoreIcon"
phosphor="CaretUpDownIcon"
remixicon="RiArrowUpDownLine"
className="opacity-50"
/>
</PopoverTrigger>
<PopoverContent id={fieldListboxId} className="w-(--anchor-width) p-0">
<Command>
<CommandInput placeholder="Search fields..." />
<CommandList>
<CommandEmpty>No fields found.</CommandEmpty>
<CommandGroup>
{columns.map((column) => (
<CommandItem
key={column.id}
value={column.id}
onSelect={(value) => onSortUpdate(sort.id, { id: value })}
>
<span className="truncate">{column.label}</span>
</CommandItem>
))}
</CommandGroup>
</CommandList>
</Command>
</PopoverContent>
</Popover>
<Select
open={showDirectionSelector}
onOpenChange={setShowDirectionSelector}
value={sort.desc ? "desc" : "asc"}
onValueChange={(value) => {
if (value == null) return;
onSortUpdate(sort.id, { desc: value === "desc" });
}}
>
<SelectTrigger
aria-controls={directionListboxId}
className="w-24 rounded"
>
<SelectValue />
</SelectTrigger>
<SelectContent
id={directionListboxId}
className="min-w-(--anchor-width)"
>
<SelectGroup>
{dataTableConfig.sortOrders.map((order) => (
<SelectItem key={order.value} value={order.value}>
{order.label}
</SelectItem>
))}
</SelectGroup>
</SelectContent>
</Select>
<Button
aria-controls={sortItemId}
variant="outline"
size="icon"
className="size-8 shrink-0 rounded"
onClick={() => onSortRemove(sort.id)}
>
<IconPlaceholder
lucide="Trash2"
tabler="IconTrash"
hugeicons="Delete02Icon"
phosphor="TrashIcon"
remixicon="RiDeleteBinLine"
/>
</Button>
<SortableItemHandle
render={
<Button
variant="outline"
size="icon"
className="size-8 shrink-0 rounded"
/>
}
>
<IconPlaceholder
lucide="GripVertical"
tabler="IconGripVertical"
hugeicons="DragDropVerticalIcon"
phosphor="DotsSixVerticalIcon"
remixicon="RiDraggable"
/>
</SortableItemHandle>
</SortableItem>
);
}
src/registry/bases/base/ui/sortable.tsx
"use client";
import { mergeProps } from "@base-ui/react/merge-props";
import { useRender } from "@base-ui/react/use-render";
import {
type Announcements,
closestCenter,
closestCorners,
defaultDropAnimationSideEffects,
DndContext,
type DndContextProps,
type DragEndEvent,
type DraggableAttributes,
type DraggableSyntheticListeners,
DragOverlay,
type DragStartEvent,
type DropAnimation,
KeyboardSensor,
MouseSensor,
type ScreenReaderInstructions,
TouchSensor,
type UniqueIdentifier,
useSensor,
useSensors,
} from "@dnd-kit/core";
import {
restrictToHorizontalAxis,
restrictToParentElement,
restrictToVerticalAxis,
} from "@dnd-kit/modifiers";
import {
arrayMove,
horizontalListSortingStrategy,
SortableContext,
type SortableContextProps,
sortableKeyboardCoordinates,
useSortable,
verticalListSortingStrategy,
} from "@dnd-kit/sortable";
import { CSS } from "@dnd-kit/utilities";
import { cn } from "cn";
import * as React from "react";
import * as ReactDOM from "react-dom";
import { useIsomorphicLayoutEffect } from "@/hooks/use-isomorphic-layout-effect";
const orientationConfig = {
vertical: {
modifiers: [restrictToVerticalAxis, restrictToParentElement],
strategy: verticalListSortingStrategy,
collisionDetection: closestCenter,
},
horizontal: {
modifiers: [restrictToHorizontalAxis, restrictToParentElement],
strategy: horizontalListSortingStrategy,
collisionDetection: closestCenter,
},
mixed: {
modifiers: [restrictToParentElement],
strategy: undefined,
collisionDetection: closestCorners,
},
};
const ROOT_NAME = "Sortable";
const CONTENT_NAME = "SortableContent";
const ITEM_NAME = "SortableItem";
const ITEM_HANDLE_NAME = "SortableItemHandle";
const OVERLAY_NAME = "SortableOverlay";
interface SortableRootContextValue<T> {
id: string;
items: UniqueIdentifier[];
modifiers: DndContextProps["modifiers"];
strategy: SortableContextProps["strategy"];
activeId: UniqueIdentifier | null;
setActiveId: (id: UniqueIdentifier | null) => void;
getItemValue: (item: T) => UniqueIdentifier;
flatCursor: boolean;
}
const SortableRootContext =
React.createContext<SortableRootContextValue<unknown> | null>(null);
function useSortableContext(consumerName: string) {
const context = React.useContext(SortableRootContext);
if (!context) {
throw new Error(`\`${consumerName}\` must be used within \`${ROOT_NAME}\``);
}
return context;
}
interface GetItemValue<T> {
/**
* Callback that returns a unique identifier for each sortable item. Required for array of objects.
* @example getItemValue={(item) => item.id}
*/
getItemValue: (item: T) => UniqueIdentifier;
}
type SortableProps<T> = DndContextProps &
(T extends object ? GetItemValue<T> : Partial<GetItemValue<T>>) & {
value: T[];
onValueChange?: (items: T[]) => void;
onMove?: (
event: DragEndEvent & { activeIndex: number; overIndex: number },
) => void;
strategy?: SortableContextProps["strategy"];
orientation?: "vertical" | "horizontal" | "mixed";
flatCursor?: boolean;
};
function Sortable<T>(props: SortableProps<T>) {
const {
value,
onValueChange,
collisionDetection,
modifiers,
strategy,
onMove,
orientation = "vertical",
flatCursor = false,
getItemValue: getItemValueProp,
accessibility,
...sortableProps
} = props;
const id = React.useId();
const [activeId, setActiveId] = React.useState<UniqueIdentifier | null>(null);
const sensors = useSensors(
useSensor(MouseSensor),
useSensor(TouchSensor),
useSensor(KeyboardSensor, {
coordinateGetter: sortableKeyboardCoordinates,
}),
);
const config = React.useMemo(
() => orientationConfig[orientation],
[orientation],
);
const getItemValue = React.useCallback(
(item: T): UniqueIdentifier => {
if (typeof item === "object" && !getItemValueProp) {
throw new Error(
"`getItemValue` is required when using array of objects",
);
}
return getItemValueProp
? getItemValueProp(item)
: (item as UniqueIdentifier);
},
[getItemValueProp],
);
const items = React.useMemo(() => {
return value.map((item) => getItemValue(item));
}, [value, getItemValue]);
const onDragStart = React.useCallback(
(event: DragStartEvent) => {
sortableProps.onDragStart?.(event);
if (event.activatorEvent.defaultPrevented) return;
setActiveId(event.active.id);
},
[sortableProps.onDragStart],
);
const onDragEnd = React.useCallback(
(event: DragEndEvent) => {
sortableProps.onDragEnd?.(event);
if (event.activatorEvent.defaultPrevented) return;
const { active, over } = event;
if (over && active.id !== over?.id) {
const activeIndex = value.findIndex(
(item) => getItemValue(item) === active.id,
);
const overIndex = value.findIndex(
(item) => getItemValue(item) === over.id,
);
if (onMove) {
onMove({ ...event, activeIndex, overIndex });
} else {
onValueChange?.(arrayMove(value, activeIndex, overIndex));
}
}
setActiveId(null);
},
[value, onValueChange, onMove, getItemValue, sortableProps.onDragEnd],
);
const onDragCancel = React.useCallback(
(event: DragEndEvent) => {
sortableProps.onDragCancel?.(event);
if (event.activatorEvent.defaultPrevented) return;
setActiveId(null);
},
[sortableProps.onDragCancel],
);
const announcements: Announcements = React.useMemo(
() => ({
onDragStart({ active }) {
const activeValue = active.id.toString();
return `Grabbed sortable item "${activeValue}". Current position is ${active.data.current?.sortable.index + 1} of ${value.length}. Use arrow keys to move, space to drop.`;
},
onDragOver({ active, over }) {
if (over) {
const overIndex = over.data.current?.sortable.index ?? 0;
const activeIndex = active.data.current?.sortable.index ?? 0;
const moveDirection = overIndex > activeIndex ? "down" : "up";
const activeValue = active.id.toString();
return `Sortable item "${activeValue}" moved ${moveDirection} to position ${overIndex + 1} of ${value.length}.`;
}
return "Sortable item is no longer over a droppable area. Press escape to cancel.";
},
onDragEnd({ active, over }) {
const activeValue = active.id.toString();
if (over) {
const overIndex = over.data.current?.sortable.index ?? 0;
return `Sortable item "${activeValue}" dropped at position ${overIndex + 1} of ${value.length}.`;
}
return `Sortable item "${activeValue}" dropped. No changes were made.`;
},
onDragCancel({ active }) {
const activeIndex = active.data.current?.sortable.index ?? 0;
const activeValue = active.id.toString();
return `Sorting cancelled. Sortable item "${activeValue}" returned to position ${activeIndex + 1} of ${value.length}.`;
},
onDragMove({ active, over }) {
if (over) {
const overIndex = over.data.current?.sortable.index ?? 0;
const activeIndex = active.data.current?.sortable.index ?? 0;
const moveDirection = overIndex > activeIndex ? "down" : "up";
const activeValue = active.id.toString();
return `Sortable item "${activeValue}" is moving ${moveDirection} to position ${overIndex + 1} of ${value.length}.`;
}
return "Sortable item is no longer over a droppable area. Press escape to cancel.";
},
}),
[value],
);
const screenReaderInstructions: ScreenReaderInstructions = React.useMemo(
() => ({
draggable: `
To pick up a sortable item, press space or enter.
While dragging, use the ${orientation === "vertical" ? "up and down" : orientation === "horizontal" ? "left and right" : "arrow"} keys to move the item.
Press space or enter again to drop the item in its new position, or press escape to cancel.
`,
}),
[orientation],
);
const contextValue = React.useMemo(
() => ({
id,
items,
modifiers: modifiers ?? config.modifiers,
strategy: strategy ?? config.strategy,
activeId,
setActiveId,
getItemValue,
flatCursor,
}),
[
id,
items,
modifiers,
strategy,
config.modifiers,
config.strategy,
activeId,
getItemValue,
flatCursor,
],
);
return (
<SortableRootContext.Provider
value={contextValue as SortableRootContextValue<unknown>}
>
<DndContext
collisionDetection={collisionDetection ?? config.collisionDetection}
modifiers={modifiers ?? config.modifiers}
sensors={sensors}
{...sortableProps}
id={id}
onDragStart={onDragStart}
onDragEnd={onDragEnd}
onDragCancel={onDragCancel}
accessibility={{
announcements,
screenReaderInstructions,
...accessibility,
}}
/>
</SortableRootContext.Provider>
);
}
const SortableContentContext = React.createContext<boolean>(false);
interface SortableContentProps
extends React.ComponentProps<"div">, useRender.ComponentProps<"div"> {
strategy?: SortableContextProps["strategy"];
children: React.ReactNode;
withoutSlot?: boolean;
}
function SortableContent(props: SortableContentProps) {
const {
strategy: strategyProp,
withoutSlot,
children,
className,
render,
ref,
...contentProps
} = props;
const context = useSortableContext(CONTENT_NAME);
const element = useRender({
defaultTagName: "div",
props: mergeProps<"div">(
{
ref,
className,
children,
},
contentProps,
),
render,
state: {
slot: "sortable-content",
},
enabled: !withoutSlot,
});
return (
<SortableContentContext.Provider value={true}>
<SortableContext
items={context.items}
strategy={strategyProp ?? context.strategy}
>
{withoutSlot ? children : element}
</SortableContext>
</SortableContentContext.Provider>
);
}
interface SortableItemContextValue {
id: string;
attributes: DraggableAttributes;
listeners: DraggableSyntheticListeners | undefined;
setActivatorNodeRef: (node: HTMLElement | null) => void;
isDragging?: boolean;
disabled?: boolean;
}
const SortableItemContext =
React.createContext<SortableItemContextValue | null>(null);
function useSortableItemContext(consumerName: string) {
const context = React.useContext(SortableItemContext);
if (!context) {
throw new Error(`\`${consumerName}\` must be used within \`${ITEM_NAME}\``);
}
return context;
}
interface SortableItemProps
extends React.ComponentProps<"div">, useRender.ComponentProps<"div"> {
value: UniqueIdentifier;
asHandle?: boolean;
disabled?: boolean;
}
function SortableItem(props: SortableItemProps) {
const {
value,
style,
asHandle,
disabled,
className,
render,
ref,
...itemProps
} = props;
const inSortableContent = React.useContext(SortableContentContext);
const inSortableOverlay = React.useContext(SortableOverlayContext);
if (!inSortableContent && !inSortableOverlay) {
throw new Error(
`\`${ITEM_NAME}\` must be used within \`${CONTENT_NAME}\` or \`${OVERLAY_NAME}\``,
);
}
if (value === "") {
throw new Error(`\`${ITEM_NAME}\` value cannot be an empty string`);
}
const context = useSortableContext(ITEM_NAME);
const id = React.useId();
const {
attributes,
listeners,
setNodeRef,
setActivatorNodeRef,
transform,
transition,
isDragging,
} = useSortable({ id: value, disabled });
const onNodeRefChange = React.useCallback(
(node: HTMLElement | null) => {
if (disabled) return;
setNodeRef(node);
if (asHandle) setActivatorNodeRef(node);
},
[disabled, asHandle, setNodeRef, setActivatorNodeRef],
);
const composedStyle = React.useMemo<React.CSSProperties>(() => {
return {
transform: CSS.Translate.toString(transform),
transition,
...style,
};
}, [transform, transition, style]);
const itemContext = React.useMemo<SortableItemContextValue>(
() => ({
id,
attributes,
listeners,
setActivatorNodeRef,
isDragging,
disabled,
}),
[id, attributes, listeners, setActivatorNodeRef, isDragging, disabled],
);
const handleProps =
asHandle && !disabled ? { ...attributes, ...listeners } : undefined;
const element = useRender({
defaultTagName: "div",
ref: [ref ?? null, onNodeRefChange],
props: mergeProps<"div">(
{
id,
style: composedStyle,
className: cn(
"focus-visible:ring-1 focus-visible:ring-ring focus-visible:ring-offset-1 focus-visible:outline-hidden",
{
"touch-none select-none": asHandle,
"cursor-default": context.flatCursor,
"data-dragging:cursor-grabbing": !context.flatCursor,
"cursor-grab": !isDragging && asHandle && !context.flatCursor,
"opacity-50": isDragging,
"pointer-events-none opacity-50": disabled,
},
className,
),
},
itemProps,
handleProps,
),
render,
state: {
slot: "sortable-item",
...(disabled && { disabled: "" }),
...(isDragging && { dragging: "" }),
},
});
return (
<SortableItemContext.Provider value={itemContext}>
{element}
</SortableItemContext.Provider>
);
}
interface SortableItemHandleProps
extends React.ComponentProps<"button">, useRender.ComponentProps<"button"> {}
function SortableItemHandle(props: SortableItemHandleProps) {
const { disabled, className, render, ref, ...itemHandleProps } = props;
const context = useSortableContext(ITEM_HANDLE_NAME);
const itemContext = useSortableItemContext(ITEM_HANDLE_NAME);
const isDisabled = disabled ?? itemContext.disabled;
const { setActivatorNodeRef } = itemContext;
const onActivatorNodeRef = React.useCallback(
(node: HTMLElement | null) => {
if (isDisabled) return;
setActivatorNodeRef(node);
},
[isDisabled, setActivatorNodeRef],
);
const handleProps = isDisabled
? undefined
: { ...itemContext.attributes, ...itemContext.listeners };
return useRender({
defaultTagName: "button",
ref: [ref ?? null, onActivatorNodeRef],
props: mergeProps<"button">(
{
type: "button",
"aria-controls": itemContext.id,
disabled: isDisabled,
className: cn(
"select-none disabled:pointer-events-none disabled:opacity-50",
context.flatCursor
? "cursor-default"
: "cursor-grab data-dragging:cursor-grabbing",
className,
),
},
itemHandleProps,
handleProps,
),
render,
state: {
slot: "sortable-item-handle",
...(isDisabled && { disabled: "" }),
...(itemContext.isDragging && { dragging: "" }),
},
});
}
const SortableOverlayContext = React.createContext(false);
const dropAnimation: DropAnimation = {
sideEffects: defaultDropAnimationSideEffects({
styles: {
active: {
opacity: "0.4",
},
},
}),
};
interface SortableOverlayProps extends Omit<
React.ComponentProps<typeof DragOverlay>,
"children"
> {
container?: Element | DocumentFragment | null;
children?:
| ((params: { value: UniqueIdentifier }) => React.ReactNode)
| React.ReactNode;
}
function SortableOverlay(props: SortableOverlayProps) {
const { container: containerProp, children, ...overlayProps } = props;
const context = useSortableContext(OVERLAY_NAME);
const [mounted, setMounted] = React.useState(false);
useIsomorphicLayoutEffect(() => setMounted(true), []);
const container =
containerProp ?? (mounted ? globalThis.document?.body : null);
if (!container) return null;
return ReactDOM.createPortal(
<DragOverlay
dropAnimation={dropAnimation}
modifiers={context.modifiers}
className={cn(!context.flatCursor && "cursor-grabbing")}
{...overlayProps}
>
<SortableOverlayContext.Provider value={true}>
{context.activeId
? typeof children === "function"
? children({ value: context.activeId })
: children
: null}
</SortableOverlayContext.Provider>
</DragOverlay>,
container,
);
}
export {
Sortable,
SortableContent,
SortableItem,
SortableItemHandle,
SortableOverlay,
type SortableProps,
};
src/lib/data-table-utils.ts
import type { Column, RowData } from "@tanstack/react-table";
import type { DataTableFeatures } from "@/lib/data-table-features";
import type {
ExtendedColumnFilter,
FilterOperator,
FilterVariant,
} from "@/lib/data-table-types";
export type DataTableConfig = typeof dataTableConfig;
export const dataTableConfig = {
textOperators: [
{ label: "Contains", value: "iLike" as const },
{ label: "Does not contain", value: "notILike" as const },
{ label: "Is", value: "eq" as const },
{ label: "Is not", value: "ne" as const },
{ label: "Is empty", value: "isEmpty" as const },
{ label: "Is not empty", value: "isNotEmpty" as const },
],
numericOperators: [
{ label: "Is", value: "eq" as const },
{ label: "Is not", value: "ne" as const },
{ label: "Is less than", value: "lt" as const },
{ label: "Is less than or equal to", value: "lte" as const },
{ label: "Is greater than", value: "gt" as const },
{ label: "Is greater than or equal to", value: "gte" as const },
{ label: "Is between", value: "isBetween" as const },
{ label: "Is empty", value: "isEmpty" as const },
{ label: "Is not empty", value: "isNotEmpty" as const },
],
dateOperators: [
{ label: "Is", value: "eq" as const },
{ label: "Is not", value: "ne" as const },
{ label: "Is before", value: "lt" as const },
{ label: "Is after", value: "gt" as const },
{ label: "Is on or before", value: "lte" as const },
{ label: "Is on or after", value: "gte" as const },
{ label: "Is between", value: "isBetween" as const },
{ label: "Is relative to today", value: "isRelativeToToday" as const },
{ label: "Is empty", value: "isEmpty" as const },
{ label: "Is not empty", value: "isNotEmpty" as const },
],
selectOperators: [
{ label: "Is", value: "eq" as const },
{ label: "Is not", value: "ne" as const },
{ label: "Is empty", value: "isEmpty" as const },
{ label: "Is not empty", value: "isNotEmpty" as const },
],
multiSelectOperators: [
{ label: "Has any of", value: "inArray" as const },
{ label: "Has none of", value: "notInArray" as const },
{ label: "Is empty", value: "isEmpty" as const },
{ label: "Is not empty", value: "isNotEmpty" as const },
],
booleanOperators: [
{ label: "Is", value: "eq" as const },
{ label: "Is not", value: "ne" as const },
],
sortOrders: [
{ label: "Asc", value: "asc" as const },
{ label: "Desc", value: "desc" as const },
],
filterVariants: [
"text",
"number",
"range",
"date",
"dateRange",
"boolean",
"select",
"multiSelect",
] as const,
operators: [
"iLike",
"notILike",
"eq",
"ne",
"inArray",
"notInArray",
"isEmpty",
"isNotEmpty",
"lt",
"lte",
"gt",
"gte",
"isBetween",
"isRelativeToToday",
] as const,
joinOperators: ["and", "or"] as const,
};
export function getColumnPinningStyle<TData extends RowData>({
column,
withBorder = false,
}: {
column: Column<DataTableFeatures, TData>;
withBorder?: boolean;
}): React.CSSProperties {
const isPinned = column.getIsPinned();
const isLastLeftPinnedColumn =
isPinned === "start" && column.getIsLastColumn("start");
const isFirstRightPinnedColumn =
isPinned === "end" && column.getIsFirstColumn("end");
return {
boxShadow: withBorder
? isLastLeftPinnedColumn
? "-4px 0 4px -4px var(--border) inset"
: isFirstRightPinnedColumn
? "4px 0 4px -4px var(--border) inset"
: undefined
: undefined,
left: isPinned === "start" ? `${column.getStart("start")}px` : undefined,
right: isPinned === "end" ? `${column.getAfter("end")}px` : undefined,
opacity: isPinned ? 0.97 : 1,
position: isPinned ? "sticky" : "relative",
background: isPinned ? "var(--background)" : "var(--background)",
width: column.getSize(),
zIndex: isPinned ? 1 : undefined,
};
}
export function getFilterOperators(filterVariant: FilterVariant) {
const operatorMap: Record<
FilterVariant,
{ label: string; value: FilterOperator }[]
> = {
text: dataTableConfig.textOperators,
number: dataTableConfig.numericOperators,
range: dataTableConfig.numericOperators,
date: dataTableConfig.dateOperators,
dateRange: dataTableConfig.dateOperators,
boolean: dataTableConfig.booleanOperators,
select: dataTableConfig.selectOperators,
multiSelect: dataTableConfig.multiSelectOperators,
};
return operatorMap[filterVariant] ?? dataTableConfig.textOperators;
}
export function getDefaultFilterOperator(filterVariant: FilterVariant) {
const operators = getFilterOperators(filterVariant);
return operators[0]?.value ?? (filterVariant === "text" ? "iLike" : "eq");
}
export function getValidFilters<TData>(
filters: ExtendedColumnFilter<TData>[],
): ExtendedColumnFilter<TData>[] {
return filters.filter(
(filter) =>
filter.operator === "isEmpty" ||
filter.operator === "isNotEmpty" ||
(Array.isArray(filter.value)
? filter.value.length > 0
: filter.value !== "" &&
filter.value !== null &&
filter.value !== undefined),
);
}
src/lib/data-table-types.ts
import type { ColumnSort, Row, RowData } from "@tanstack/react-table";
import type { DataTableFeatures } from "@/lib/data-table-features";
import type { DataTableConfig } from "@/lib/data-table-utils";
import type { FilterItemSchema } from "@/lib/parsers";
export interface DataTableMeta {
queryKeys?: QueryKeys;
}
export interface DataTableColumnMeta {
label?: string;
placeholder?: string;
variant?: FilterVariant;
options?: Option[];
range?: [number, number];
unit?: string;
icon?: React.ComponentType<React.ComponentProps<"svg">>;
}
export interface QueryKeys {
page: string;
perPage: string;
sort: string;
filters: string;
joinOperator: string;
}
export interface Option {
label: string;
value: string;
count?: number;
icon?: React.ComponentType<React.ComponentProps<"svg">>;
}
export type FilterOperator = DataTableConfig["operators"][number];
export type FilterVariant = DataTableConfig["filterVariants"][number];
export type JoinOperator = DataTableConfig["joinOperators"][number];
export interface ExtendedColumnSort<TData> extends Omit<ColumnSort, "id"> {
id: Extract<keyof TData, string>;
}
export interface ExtendedColumnFilter<TData> extends FilterItemSchema {
id: Extract<keyof TData, string>;
}
export interface DataTableRowAction<TData extends RowData> {
row: Row<DataTableFeatures, TData>;
variant: "update" | "delete";
}
src/lib/data-table-features.ts
import {
columnFacetingFeature,
columnFilteringFeature,
columnOrderingFeature,
columnPinningFeature,
columnSizingFeature,
columnVisibilityFeature,
createFacetedMinMaxValues,
createFacetedRowModel,
createFacetedUniqueValues,
createFilteredRowModel,
createPaginatedRowModel,
createSortedRowModel,
metaHelper,
rowPaginationFeature,
rowSelectionFeature,
rowSortingFeature,
tableFeatures,
} from "@tanstack/react-table";
import type {
DataTableColumnMeta,
DataTableMeta,
} from "@/lib/data-table-types";
export const dataTableFeatures = tableFeatures({
columnFilteringFeature,
columnFacetingFeature,
columnOrderingFeature,
columnPinningFeature,
columnSizingFeature,
columnVisibilityFeature,
rowPaginationFeature,
rowSelectionFeature,
rowSortingFeature,
filteredRowModel: createFilteredRowModel(),
facetedRowModel: createFacetedRowModel(),
facetedUniqueValues: createFacetedUniqueValues(),
facetedMinMaxValues: createFacetedMinMaxValues(),
paginatedRowModel: createPaginatedRowModel(),
sortedRowModel: createSortedRowModel(),
tableMeta: metaHelper<DataTableMeta>(),
columnMeta: metaHelper<DataTableColumnMeta>(),
});
export type DataTableFeatures = typeof dataTableFeatures;
src/lib/parsers.ts
import { createParser } from "nuqs/server";
import { z } from "zod";
import type {
ExtendedColumnFilter,
ExtendedColumnSort,
} from "@/lib/data-table-types";
import { dataTableConfig } from "@/lib/data-table-utils";
const sortingItemSchema = z.object({
id: z.string(),
desc: z.boolean(),
});
export const getSortingStateParser = <TData>(
columnIds?: string[] | Set<string>,
) => {
const validKeys = columnIds
? columnIds instanceof Set
? columnIds
: new Set(columnIds)
: null;
return createParser({
parse: (value) => {
try {
const parsed = JSON.parse(value);
const result = z.array(sortingItemSchema).safeParse(parsed);
if (!result.success) return null;
if (validKeys && result.data.some((item) => !validKeys.has(item.id))) {
return null;
}
return result.data as ExtendedColumnSort<TData>[];
} catch {
return null;
}
},
serialize: (value) => JSON.stringify(value),
eq: (a, b) =>
a.length === b.length &&
a.every(
(item, index) =>
item.id === b[index]?.id && item.desc === b[index]?.desc,
),
});
};
const filterItemSchema = z.object({
id: z.string(),
value: z.union([z.string(), z.array(z.string())]),
variant: z.enum(dataTableConfig.filterVariants),
operator: z.enum(dataTableConfig.operators),
filterId: z.string(),
});
export type FilterItemSchema = z.infer<typeof filterItemSchema>;
export const getFiltersStateParser = <TData>(
columnIds?: string[] | Set<string>,
) => {
const validKeys = columnIds
? columnIds instanceof Set
? columnIds
: new Set(columnIds)
: null;
return createParser({
parse: (value) => {
try {
const parsed = JSON.parse(value);
const result = z.array(filterItemSchema).safeParse(parsed);
if (!result.success) return null;
if (validKeys && result.data.some((item) => !validKeys.has(item.id))) {
return null;
}
return result.data as ExtendedColumnFilter<TData>[];
} catch {
return null;
}
},
serialize: (value) => JSON.stringify(value),
eq: (a, b) =>
a.length === b.length &&
a.every(
(filter, index) =>
filter.id === b[index]?.id &&
filter.value === b[index]?.value &&
filter.variant === b[index]?.variant &&
filter.operator === b[index]?.operator,
),
});
};
src/hooks/use-isomorphic-layout-effect.ts
import * as React from "react";
const useIsomorphicLayoutEffect =
typeof window !== "undefined" ? React.useLayoutEffect : React.useEffect;
export { useIsomorphicLayoutEffect };