Shadcn Table
componentdata-grid-sort-menusource: ok · hit
Data Grid Sort Menu
A sort menu component for the data grid with drag-and-drop reordering
npx shadcn add "https://tablecn.com/r/data-grid-sort-menu.json"free
Interaction
dragdropdown
Tags auto-generated by rules on 9/24/2026 — empty means no evidence, not lack of support.
Dependencies
Bundle weight · lighticonslucide-react
ui-primitives@base-ui/react
Registry dependencies
badgebuttoncommandpopoverselect
Files7 · source cached 10/9/2026, 4:37:56 PM
src/registry/bases/base/components/data-grid/data-grid-sort-menu.tsx
"use client";
import type { ColumnSort, RowData, Table } from "@tanstack/react-table";
import { cn } from "cn";
import * as React from "react";
import type { DataGridFeatures } from "@/lib/data-grid-features";
import { Badge } from "@/registry/bases/base/ui/badge";
import { Button } from "@/registry/bases/base/ui/button";
import { useDirection } from "@/registry/bases/base/ui/direction";
import {
Faceted,
FacetedContent,
FacetedEmpty,
FacetedGroup,
FacetedInput,
FacetedItem,
FacetedItemIndicator,
FacetedList,
FacetedTrigger,
} from "@/registry/bases/base/ui/faceted";
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 = new Set(["backspace", "delete"]);
const SORT_ORDERS = [
{ label: "Asc", value: "asc" },
{ label: "Desc", value: "desc" },
];
interface DataGridSortMenuProps<
TData extends RowData,
> extends React.ComponentProps<typeof PopoverContent> {
table: Table<DataGridFeatures, TData>;
disabled?: boolean;
}
export function DataGridSortMenu<TData extends RowData>({
table,
disabled,
className,
...props
}: DataGridSortMenuProps<TData>) {
const dir = useDirection();
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 sorting = table.store.state.sorting;
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.has(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
dir={dir}
variant="outline"
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] px-[5.12px] font-mono text-[10.4px]"
>
{sorting.length}
</Badge>
)}
</PopoverTrigger>
<PopoverContent
aria-labelledby={labelId}
aria-describedby={descriptionId}
dir={dir}
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}`}
dir={dir}
columns={columns}
columnLabels={columnLabels}
onSortUpdate={onSortUpdate}
onSortRemove={onSortRemove}
/>
))}
</SortableContent>
)}
<div className="flex w-full items-center gap-2">
<Button
ref={addButtonRef}
onClick={onSortAdd}
disabled={columns.length === 0}
>
Add sort
</Button>
{sorting.length > 0 && (
<Button variant="outline" onClick={onSortingReset}>
Reset sorting
</Button>
)}
</div>
</PopoverContent>
</Popover>
<SortableOverlay>
<div dir={dir} className="flex items-center gap-2">
<div className="h-8 w-44 rounded-lg bg-primary/10" />
<div className="h-8 w-24 rounded-lg bg-primary/10" />
<div className="size-8 shrink-0 rounded-lg bg-primary/10" />
<div className="size-8 shrink-0 rounded-lg bg-primary/10" />
</div>
</SortableOverlay>
</Sortable>
);
}
interface DataTableSortItemProps {
sort: ColumnSort;
sortItemId: string;
dir: "ltr" | "rtl";
columns: { id: string; label: string }[];
columnLabels: Map<string, string>;
onSortUpdate: (sortId: string, updates: Partial<ColumnSort>) => void;
onSortRemove: (sortId: string) => void;
}
function DataTableSortItem({
sort,
sortItemId,
dir,
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.has(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}
/>
}
>
<Faceted
open={showFieldSelector}
onOpenChange={setShowFieldSelector}
onValueChange={(columnId) => {
if (!columnId) return;
onSortUpdate(sort.id, { id: columnId });
}}
>
<FacetedTrigger
render={
<Button
id={fieldTriggerId}
aria-controls={fieldListboxId}
variant="outline"
className="w-44"
/>
}
>
<span className="truncate">{columnLabels.get(sort.id)}</span>
<IconPlaceholder
lucide="ChevronsUpDown"
tabler="IconSelector"
hugeicons="UnfoldMoreIcon"
phosphor="CaretUpDownIcon"
remixicon="RiArrowUpDownLine"
className="opacity-50"
/>
</FacetedTrigger>
<FacetedContent
id={fieldListboxId}
dir={dir}
className="w-(--anchor-width)"
>
<FacetedInput placeholder="Search fields..." />
<FacetedList>
<FacetedEmpty>No fields found.</FacetedEmpty>
<FacetedGroup>
{columns.map((column) => (
<FacetedItem
key={column.id}
value={column.id}
keywords={[column.label]}
>
<span className="truncate">{column.label}</span>
<FacetedItemIndicator />
</FacetedItem>
))}
</FacetedGroup>
</FacetedList>
</FacetedContent>
</Faceted>
<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">
<SelectValue />
</SelectTrigger>
<SelectContent
id={directionListboxId}
className="min-w-(--anchor-width)"
>
<SelectGroup>
{SORT_ORDERS.map((order) => (
<SelectItem key={order.value} value={order.value}>
{order.label}
</SelectItem>
))}
</SelectGroup>
</SelectContent>
</Select>
<Button
aria-controls={sortItemId}
variant="outline"
size="icon"
className="shrink-0"
onClick={() => onSortRemove(sort.id)}
>
<IconPlaceholder
lucide="Trash2"
tabler="IconTrash"
hugeicons="Delete02Icon"
phosphor="TrashIcon"
remixicon="RiDeleteBinLine"
/>
</Button>
<SortableItemHandle
render={<Button variant="outline" size="icon" className="shrink-0" />}
>
<IconPlaceholder
lucide="GripVertical"
tabler="IconGripVertical"
hugeicons="DragDropVerticalIcon"
phosphor="DotsSixVerticalIcon"
remixicon="RiDraggable"
/>
</SortableItemHandle>
</SortableItem>
);
}
src/registry/bases/base/ui/direction.tsx
"use client";
export {
DirectionProvider,
useDirection,
} from "@base-ui/react/direction-provider";
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/registry/bases/base/ui/faceted.tsx
"use client";
import { mergeProps } from "@base-ui/react/merge-props";
import { useRender } from "@base-ui/react/use-render";
import { Command as CommandPrimitive } from "cmdk";
import { cn } from "cn";
import * as React from "react";
import {
Command,
CommandEmpty,
CommandGroup,
CommandInput,
CommandList,
CommandSeparator,
} from "@/registry/bases/base/ui/command";
import {
Popover,
PopoverContent,
PopoverTrigger,
} from "@/registry/bases/base/ui/popover";
import { IconPlaceholder } from "@/registry/icons/icon-placeholder";
type FacetedSelectedValue<Multiple extends boolean> = Multiple extends true
? string[]
: string;
interface FacetedOption {
value: string;
label: string;
}
const NO_ITEMS: FacetedOption[] = [];
interface FacetedState {
value: string | string[] | undefined;
open: boolean;
}
interface FacetedStore {
subscribe: (callback: () => void) => () => void;
getState: () => FacetedState;
getProps: () => FacetedController;
notify: () => void;
setOpen: (open: boolean) => void;
selectItem: (value: string) => void;
clear: () => void;
}
interface FacetedController {
open?: boolean;
onOpenChange?: (open: boolean) => void;
value?: string | string[];
onValueChange?: (value: string | string[] | undefined) => void;
isControlled: boolean;
multiple: boolean;
items: FacetedOption[];
}
function getSelection(
state: FacetedState,
props: FacetedController,
): string | string[] | undefined {
return props.isControlled ? props.value : state.value;
}
function getHasSelection(value: string | string[] | undefined) {
if (Array.isArray(value)) return value.length > 0;
return !!value;
}
function getIsValueSelected(
value: string | string[] | undefined,
multiple: boolean,
itemValue: string,
) {
if (multiple) return Array.isArray(value) && value.includes(itemValue);
return value === itemValue;
}
function getSelectedItems(
value: string | string[] | undefined,
items: FacetedOption[],
) {
const values = Array.isArray(value) ? value : value ? [value] : [];
return values.map((itemValue) => ({
value: itemValue,
label: items.find((item) => item.value === itemValue)?.label ?? itemValue,
}));
}
function getIsFacetedSelectedValue<Multiple extends boolean>(
value: string | string[] | undefined,
multiple: Multiple,
): value is FacetedSelectedValue<Multiple> | undefined {
if (value === undefined) return true;
return multiple ? Array.isArray(value) : typeof value === "string";
}
function createFacetedStore(
propsRef: React.RefObject<FacetedController>,
state: FacetedState,
): FacetedStore {
const listeners = new Set<() => void>();
function commitValue(nextValue: string | string[] | undefined) {
const props = propsRef.current;
if (!props.isControlled && !Object.is(state.value, nextValue)) {
state.value = nextValue;
store.notify();
}
props.onValueChange?.(nextValue);
}
const store: FacetedStore = {
subscribe: (callback) => {
listeners.add(callback);
return () => listeners.delete(callback);
},
getState: () => state,
getProps: () => propsRef.current,
notify: () => {
for (const callback of listeners) {
callback();
}
},
setOpen: (open) => {
const { open: openProp, onOpenChange } = propsRef.current;
if (openProp === undefined && state.open !== open) {
state.open = open;
store.notify();
}
onOpenChange?.(open);
},
selectItem: (selectedValue) => {
const props = propsRef.current;
const currentValue = getSelection(state, props);
if (props.multiple) {
const selected = Array.isArray(currentValue) ? currentValue : [];
commitValue(
selected.includes(selectedValue)
? selected.filter((item) => item !== selectedValue)
: [...selected, selectedValue],
);
return;
}
commitValue(currentValue === selectedValue ? undefined : selectedValue);
store.setOpen(false);
},
clear: () => {
commitValue(propsRef.current.multiple ? [] : undefined);
},
};
return store;
}
function useFacetedStoreSelector<T>(
store: FacetedStore,
selector: (state: FacetedState) => T,
): T {
const getSnapshot = () => selector(store.getState());
return React.useSyncExternalStore(store.subscribe, getSnapshot, getSnapshot);
}
const FacetedStoreContext = React.createContext<FacetedStore | null>(null);
function useFacetedStore(name: string) {
const store = React.useContext(FacetedStoreContext);
if (!store) {
throw new Error(`\`${name}\` must be used within \`Faceted\`.`);
}
return store;
}
interface FacetedProps<Multiple extends boolean = false> extends Omit<
React.ComponentProps<typeof Popover>,
"onOpenChange"
> {
value?: FacetedSelectedValue<Multiple>;
defaultValue?: FacetedSelectedValue<Multiple>;
onValueChange?: (value: FacetedSelectedValue<Multiple> | undefined) => void;
onOpenChange?: (open: boolean) => void;
items?: FacetedOption[];
multiple?: Multiple;
}
function Faceted<Multiple extends boolean = false>(
props: FacetedProps<Multiple>,
) {
const {
open: openProp,
defaultOpen = false,
onOpenChange,
value,
defaultValue,
onValueChange,
items = NO_ITEMS,
multiple = false as Multiple,
...popoverProps
} = props;
const controller: FacetedController = {
open: openProp,
onOpenChange,
value,
onValueChange(nextValue) {
if (!getIsFacetedSelectedValue(nextValue, multiple)) return;
onValueChange?.(nextValue);
},
isControlled: "value" in props,
multiple,
items,
};
const propsRef = React.useRef(controller);
propsRef.current = controller;
const storeRef = React.useRef<FacetedStore | null>(null);
storeRef.current ??= createFacetedStore(propsRef, {
value: defaultValue,
open: defaultOpen,
});
const store = storeRef.current;
const open = useFacetedStoreSelector(store, (state) => state.open);
return (
<FacetedStoreContext.Provider value={store}>
<Popover
data-slot="faceted"
open={openProp ?? open}
onOpenChange={store.setOpen}
{...popoverProps}
/>
</FacetedStoreContext.Provider>
);
}
function FacetedTrigger({
className,
...props
}: React.ComponentProps<typeof PopoverTrigger>) {
return (
<PopoverTrigger
data-slot="faceted-trigger"
className={cn("justify-between text-left", className)}
{...props}
/>
);
}
interface FacetedValueProps {
placeholder?: React.ReactNode;
children?: React.ReactNode | ((selected: FacetedOption[]) => React.ReactNode);
}
function FacetedValue({
placeholder = "Select options...",
children,
}: FacetedValueProps) {
const store = useFacetedStore("FacetedValue");
const value = useFacetedStoreSelector(store, (state) =>
getSelection(state, store.getProps()),
);
const selected = getSelectedItems(value, store.getProps().items);
if (typeof children === "function") return children(selected);
if (children != null) return children;
if (selected.length === 0) {
return (
<span
data-slot="faceted-value"
className="flex w-full items-center gap-1 text-muted-foreground"
>
{placeholder}
<IconPlaceholder
lucide="ChevronDown"
tabler="IconChevronDown"
hugeicons="ArrowDown01Icon"
phosphor="CaretDownIcon"
remixicon="RiArrowDownSLine"
className="ml-auto size-4 shrink-0 text-muted-foreground"
/>
</span>
);
}
if (selected.length > 2) {
return (
<FacetedBadgeList>
<FacetedBadge>{selected.length} selected</FacetedBadge>
</FacetedBadgeList>
);
}
return (
<FacetedBadgeList>
{selected.map((item) => (
<FacetedBadge key={item.value}>
<span className="truncate">{item.label}</span>
</FacetedBadge>
))}
</FacetedBadgeList>
);
}
function FacetedBadgeList({
className,
...props
}: React.ComponentProps<"div">) {
return (
<div
data-slot="faceted-badge-list"
className={cn(
"flex w-max max-w-full flex-wrap items-center gap-1",
className,
)}
{...props}
/>
);
}
function FacetedBadge({
className,
render,
...props
}: useRender.ComponentProps<"span">) {
return useRender({
defaultTagName: "span",
render,
state: {
slot: "faceted-badge",
},
props: mergeProps<"span">(
{
className: cn(
"flex h-[calc(--spacing(5.25))] w-fit max-w-full min-w-0 items-center justify-center gap-1 rounded-sm bg-input/60 px-1.5 text-xs font-medium whitespace-nowrap text-foreground [&_svg]:pointer-events-none [&_svg]:size-3 [&_svg]:shrink-0",
className,
),
},
props,
),
});
}
function FacetedContent({
className,
children,
...props
}: React.ComponentProps<typeof PopoverContent>) {
return (
<PopoverContent
data-slot="faceted-content"
align="start"
className={cn("w-50 origin-(--transform-origin) p-0", className)}
{...props}
>
<Command className="p-0.5">{children}</Command>
</PopoverContent>
);
}
function FacetedInput({
ref,
...props
}: React.ComponentProps<typeof CommandInput>) {
return <CommandInput data-slot="faceted-input" ref={ref} {...props} />;
}
function FacetedList(props: React.ComponentProps<typeof CommandList>) {
return <CommandList data-slot="faceted-list" {...props} />;
}
function FacetedEmpty(props: React.ComponentProps<typeof CommandEmpty>) {
return <CommandEmpty data-slot="faceted-empty" {...props} />;
}
function FacetedGroup(props: React.ComponentProps<typeof CommandGroup>) {
return <CommandGroup data-slot="faceted-group" {...props} />;
}
function FacetedCommandItem({
className,
onPointerDownCapture,
onMouseDown,
onSelect,
...props
}: React.ComponentProps<typeof CommandPrimitive.Item>) {
return (
<CommandPrimitive.Item
className={cn(
"group/command-item relative flex cursor-default items-center gap-2 rounded-sm px-2 py-1.5 text-sm outline-hidden select-none data-[disabled=true]:pointer-events-none data-[disabled=true]:opacity-50 data-selected:bg-muted data-selected:text-foreground [&_svg]:pointer-events-none [&_svg]:shrink-0 [&_svg:not([class*='size-'])]:size-4 data-selected:*:[svg]:text-foreground",
className,
)}
{...mergeProps<"div">(
{
onPointerDownCapture(event) {
// A focusable item steals the input on pointerdown.
event.preventDefault();
},
onMouseDown(event) {
// iOS Safari can emit a synthetic mousedown without a pointerdown.
event.preventDefault();
},
},
{ onPointerDownCapture, onMouseDown },
)}
onSelect={onSelect}
{...props}
/>
);
}
interface FacetedItemProps extends React.ComponentProps<
typeof CommandPrimitive.Item
> {
value: string;
}
function FacetedItem({ value, onSelect, ...props }: FacetedItemProps) {
const store = useFacetedStore("FacetedItem");
const isSelected = useFacetedStoreSelector(store, (state) => {
const props = store.getProps();
return getIsValueSelected(
getSelection(state, props),
props.multiple,
value,
);
});
return (
<FacetedCommandItem
data-slot="faceted-item"
data-checked={isSelected || undefined}
aria-checked={isSelected}
onSelect={() => {
if (onSelect) {
onSelect(value);
return;
}
store.selectItem(value);
}}
{...props}
/>
);
}
function FacetedItemIndicator({
className,
children,
...props
}: React.ComponentProps<"span">) {
return (
<span
data-slot="faceted-item-indicator"
className={cn(
"ml-auto grid place-items-center *:col-start-1 *:row-start-1",
className,
)}
{...props}
>
{children != null && (
<span className="font-mono text-xs group-data-checked/command-item:invisible">
{children}
</span>
)}
<IconPlaceholder
lucide="Check"
tabler="IconCheck"
hugeicons="Tick02Icon"
phosphor="CheckIcon"
remixicon="RiCheckLine"
className="invisible group-data-checked/command-item:visible"
/>
</span>
);
}
function FacetedClear({
className,
children = "Clear",
onSelect,
...props
}: React.ComponentProps<typeof CommandPrimitive.Item>) {
const store = useFacetedStore("FacetedClear");
const hasSelection = useFacetedStoreSelector(store, (state) =>
getHasSelection(getSelection(state, store.getProps())),
);
if (!hasSelection) return null;
return (
<FacetedCommandItem
data-slot="faceted-clear"
className={cn("justify-center text-center", className)}
onSelect={(value) => {
onSelect?.(value);
store.clear();
}}
{...props}
>
{children}
</FacetedCommandItem>
);
}
function FacetedSeparator(
props: React.ComponentProps<typeof CommandSeparator>,
) {
return (
<CommandSeparator
data-slot="faceted-separator"
className="mx-0 my-0.5 w-full"
{...props}
/>
);
}
export {
Faceted,
FacetedBadge,
FacetedBadgeList,
FacetedClear,
FacetedContent,
FacetedEmpty,
FacetedGroup,
FacetedInput,
FacetedItem,
FacetedItemIndicator,
FacetedList,
FacetedSeparator,
FacetedTrigger,
FacetedValue,
};
src/lib/data-grid-features.ts
import {
assignPrototypeAPIs,
assignTableAPIs,
type CellData,
columnFilteringFeature,
columnOrderingFeature,
columnPinningFeature,
columnResizingFeature,
columnSizingFeature,
columnVisibilityFeature,
createFilteredRowModel,
createSortedRowModel,
functionalUpdate,
makeStateUpdater,
metaHelper,
type OnChangeFn,
type RowData,
rowSelectionFeature,
rowSortingFeature,
type Table,
type TableFeature,
type TableFeatures,
tableFeatures,
type Updater,
} from "@tanstack/react-table";
import type {
CellPosition,
DataGridColumnMeta,
DataGridTableMeta,
RowHeightValue,
} from "@/lib/data-grid-types";
import { getLineCount, getRowHeightValue } from "@/lib/data-grid-utils";
const DEFAULT_ROW_HEIGHT: RowHeightValue = "short";
interface TableState_DataGridRowHeight {
rowHeight: RowHeightValue;
}
interface TableOptions_DataGridRowHeight {
onRowHeightChange?: OnChangeFn<RowHeightValue>;
}
interface Table_DataGridRowHeight {
getRowHeight: () => RowHeightValue;
getRowSize: () => number;
getRowLineCount: () => number;
setRowHeight: (updater: Updater<RowHeightValue>) => void;
resetRowHeight: (defaultState?: boolean) => void;
}
interface TableState_DataGridCellEditing {
editingCell: CellPosition | null;
}
interface TableOptions_DataGridCellEditing {
enableCellEditing?: boolean;
onEditingCellChange?: OnChangeFn<CellPosition | null>;
}
interface ColumnDef_DataGridCellEditing {
enableCellEditing?: boolean;
}
interface Table_DataGridCellEditing {
getEditingCell: () => CellPosition | null;
setEditingCell: (updater: Updater<CellPosition | null>) => void;
resetEditingCell: (defaultState?: boolean) => void;
}
interface Column_DataGridCellEditing {
getCanEdit: () => boolean;
}
interface Cell_DataGridCellEditing {
getCanEdit: () => boolean;
getIsEditing: () => boolean;
}
declare module "@tanstack/react-table" {
interface Plugins {
dataGridRowHeightFeature: TableFeature;
dataGridCellEditingFeature: TableFeature;
}
interface TableState_FeatureMap {
dataGridRowHeightFeature: TableState_DataGridRowHeight;
dataGridCellEditingFeature: TableState_DataGridCellEditing;
}
interface TableOptions_FeatureMap<
in out TFeatures extends TableFeatures,
in out TData extends RowData,
> {
dataGridRowHeightFeature: TableOptions_DataGridRowHeight;
dataGridCellEditingFeature: TableOptions_DataGridCellEditing;
}
interface ColumnDef_FeatureMap<
in out TFeatures extends TableFeatures,
in out TData extends RowData,
TValue extends CellData,
> {
dataGridCellEditingFeature: ColumnDef_DataGridCellEditing;
}
interface Table_FeatureMap<
in out TFeatures extends TableFeatures,
in out TData extends RowData,
> {
dataGridRowHeightFeature: Table_DataGridRowHeight;
dataGridCellEditingFeature: Table_DataGridCellEditing;
}
interface Column_FeatureMap<
in out TFeatures extends TableFeatures,
in out TData extends RowData,
> {
dataGridCellEditingFeature: Column_DataGridCellEditing;
}
interface Cell_FeatureMap {
dataGridCellEditingFeature: Cell_DataGridCellEditing;
}
}
type DataGridInstance = Table<DataGridFeatures, RowData>;
function asDataGrid(table: object) {
return table as DataGridInstance;
}
const dataGridRowHeightFeature: TableFeature = {
getInitialState: (initialState) => ({
rowHeight: DEFAULT_ROW_HEIGHT,
...initialState,
}),
getDefaultTableOptions: (table) => {
const options: TableOptions_DataGridRowHeight = {
onRowHeightChange: makeStateUpdater("rowHeight", table),
};
return options;
},
constructTableAPIs: (table) => {
const instance = asDataGrid(table);
const setRowHeight = (updater: Updater<RowHeightValue>) =>
instance.options.onRowHeightChange?.((old) =>
functionalUpdate(updater, old),
);
assignTableAPIs("dataGridRowHeightFeature", table, {
table_getRowHeight: {
fn: () => instance.atoms.rowHeight.get(),
},
table_getRowSize: {
fn: () => getRowHeightValue(instance.atoms.rowHeight.get()),
},
table_getRowLineCount: {
fn: () => getLineCount(instance.atoms.rowHeight.get()),
},
table_setRowHeight: { fn: setRowHeight },
table_resetRowHeight: {
fn: (defaultState?: boolean) =>
setRowHeight(
defaultState
? DEFAULT_ROW_HEIGHT
: (instance.initialState.rowHeight ?? DEFAULT_ROW_HEIGHT),
),
},
});
},
};
function getCanEditColumn(column: {
table: object;
columnDef: ColumnDef_DataGridCellEditing;
}) {
return (
asDataGrid(column.table).options.enableCellEditing !== false &&
column.columnDef.enableCellEditing !== false
);
}
const dataGridCellEditingFeature: TableFeature = {
getInitialState: (initialState) => ({
editingCell: null,
...initialState,
}),
getDefaultTableOptions: (table) => {
const options: TableOptions_DataGridCellEditing = {
onEditingCellChange: makeStateUpdater("editingCell", table),
};
return options;
},
constructTableAPIs: (table) => {
const instance = asDataGrid(table);
const setEditingCell = (updater: Updater<CellPosition | null>) =>
instance.options.onEditingCellChange?.((old) =>
functionalUpdate(updater, old),
);
assignTableAPIs("dataGridCellEditingFeature", table, {
table_getEditingCell: {
fn: () => instance.atoms.editingCell.get(),
},
table_setEditingCell: { fn: setEditingCell },
table_resetEditingCell: {
fn: (defaultState?: boolean) =>
setEditingCell(
defaultState ? null : (instance.initialState.editingCell ?? null),
),
},
});
},
assignColumnPrototype: (prototype, table) => {
assignPrototypeAPIs("dataGridCellEditingFeature", prototype, table, {
column_getCanEdit: { fn: getCanEditColumn },
});
},
assignCellPrototype: (prototype, table) => {
assignPrototypeAPIs("dataGridCellEditingFeature", prototype, table, {
cell_getCanEdit: {
fn: (cell: { column: Parameters<typeof getCanEditColumn>[0] }) =>
getCanEditColumn(cell.column),
},
cell_getIsEditing: {
fn: (cell: {
table: object;
row: { id: string };
column: { id: string };
}) => {
const editingCell = asDataGrid(cell.table).atoms.editingCell.get();
return (
editingCell?.rowId === cell.row.id &&
editingCell.columnId === cell.column.id
);
},
},
});
},
};
export const dataGridFeatures = tableFeatures({
columnFilteringFeature,
columnOrderingFeature,
columnPinningFeature,
columnResizingFeature,
columnSizingFeature,
columnVisibilityFeature,
rowSelectionFeature,
rowSortingFeature,
dataGridRowHeightFeature,
dataGridCellEditingFeature,
filteredRowModel: createFilteredRowModel(),
sortedRowModel: createSortedRowModel(),
tableMeta: metaHelper<DataGridTableMeta>(),
columnMeta: metaHelper<DataGridColumnMeta>(),
});
export type DataGridFeatures = typeof dataGridFeatures;
src/lib/data-grid-types.ts
import type { Cell, RowData } from "@tanstack/react-table";
import type { DataGridFeatures } from "@/lib/data-grid-features";
export type Direction = "ltr" | "rtl";
export type RowHeightValue = "short" | "medium" | "tall" | "extra-tall";
export interface CellSelectOption {
label: string;
value: string;
icon?: React.ComponentType<React.ComponentProps<"svg">>;
count?: number;
}
export type CellOpts =
| {
variant: "short-text";
}
| {
variant: "long-text";
}
| {
variant: "number";
min?: number;
max?: number;
step?: number;
}
| {
variant: "select";
options: CellSelectOption[];
}
| {
variant: "multi-select";
options: CellSelectOption[];
}
| {
variant: "checkbox";
}
| {
variant: "date";
}
| {
variant: "url";
}
| {
variant: "file";
maxFileSize?: number;
maxFiles?: number;
accept?: string;
multiple?: boolean;
};
export interface CellUpdate {
rowId: string;
columnId: string;
value: unknown;
}
export interface DataGridColumnMeta {
label?: string;
cell?: CellOpts;
}
export interface DataGridTableMeta {
dataGridRef?: React.RefObject<HTMLElement | null>;
cellMapRef?: React.RefObject<Map<string, HTMLDivElement>>;
focusedCell?: CellPosition | null;
editingCell?: CellPosition | null;
selectionState?: SelectionState;
searchOpen?: boolean;
getIsCellSelected?: (rowId: string, columnId: string) => boolean;
getIsSearchMatch?: (rowId: string, columnId: string) => boolean;
getIsActiveSearchMatch?: (rowId: string, columnId: string) => boolean;
scrollToCell?: (
rowId: string,
columnId: string,
align?: "auto" | "start" | "center" | "end",
) => void;
onRowSelect?: (rowId: string, checked: boolean, shiftKey: boolean) => void;
onDataUpdate?: (params: CellUpdate | Array<CellUpdate>) => void;
onRowsDelete?: (rowIds: string[]) => void | Promise<void>;
onColumnClick?: (columnId: string) => void;
onCellClick?: (
rowId: string,
columnId: string,
event?: React.MouseEvent,
) => void;
onCellDoubleClick?: (rowId: string, columnId: string) => void;
onCellMouseDown?: (
rowId: string,
columnId: string,
event: React.MouseEvent,
) => void;
onCellMouseEnter?: (rowId: string, columnId: string) => void;
onCellMouseUp?: () => void;
onCellContextMenu?: (
rowId: string,
columnId: string,
event: React.MouseEvent,
) => void;
onCellEditingStart?: (rowId: string, columnId: string) => void;
onCellEditingStop?: (opts?: {
direction?: NavigationDirection;
moveToNextRow?: boolean;
}) => void;
onCellsCopy?: () => void;
onCellsCut?: () => void;
onCellsPaste?: (expand?: boolean) => void;
onSelectionClear?: () => void;
onFilesUpload?: (params: {
files: File[];
rowId: string;
columnId: string;
}) => Promise<FileCellData[]>;
onFilesDelete?: (params: {
fileIds: string[];
rowId: string;
columnId: string;
}) => void | Promise<void>;
contextMenu?: ContextMenuState;
onContextMenuOpenChange?: (open: boolean) => void;
pasteDialog?: PasteDialogState;
onPasteDialogOpenChange?: (open: boolean) => void;
readOnly?: boolean;
}
export interface CellPosition {
rowId: string;
columnId: string;
}
export interface CellRange {
start: CellPosition;
end: CellPosition;
}
export interface SelectionState {
selectedCells: Set<string>;
selectionRange: CellRange | null;
isSelecting: boolean;
}
export interface ContextMenuState {
open: boolean;
x: number;
y: number;
}
export interface PasteDialogState {
open: boolean;
rowsNeeded: number;
clipboardText: string;
}
export type NavigationDirection =
| "up"
| "down"
| "left"
| "right"
| "home"
| "end"
| "ctrl+up"
| "ctrl+down"
| "ctrl+home"
| "ctrl+end"
| "pageup"
| "pagedown"
| "pageleft"
| "pageright"
| "tab"
| "shift+tab";
export interface SearchState {
searchMatches: CellPosition[];
matchIndex: number;
searchOpen: boolean;
onSearchOpenChange: (open: boolean) => void;
searchQuery: string;
onSearchQueryChange: (query: string) => void;
onSearch: (query: string) => void;
onNavigateToNextMatch: () => void;
onNavigateToPrevMatch: () => void;
}
export interface DataGridCellProps<TData extends RowData> {
cell: Cell<DataGridFeatures, TData>;
tableMeta: DataGridTableMeta;
rowId: string;
columnId: string;
rowHeight: RowHeightValue;
isEditing: boolean;
isFocused: boolean;
isSelected: boolean;
isSearchMatch: boolean;
isActiveSearchMatch: boolean;
readOnly: boolean;
}
export interface FileCellData {
id: string;
name: string;
size: number;
type: string;
url?: string;
}
export type TextFilterOperator =
| "contains"
| "notContains"
| "equals"
| "notEquals"
| "startsWith"
| "endsWith"
| "isEmpty"
| "isNotEmpty";
export type NumberFilterOperator =
| "equals"
| "notEquals"
| "lessThan"
| "lessThanOrEqual"
| "greaterThan"
| "greaterThanOrEqual"
| "isBetween"
| "isEmpty"
| "isNotEmpty";
export type DateFilterOperator =
| "equals"
| "notEquals"
| "before"
| "after"
| "onOrBefore"
| "onOrAfter"
| "isBetween"
| "isEmpty"
| "isNotEmpty";
export type SelectFilterOperator =
| "is"
| "isNot"
| "isAnyOf"
| "isNoneOf"
| "isEmpty"
| "isNotEmpty";
export type BooleanFilterOperator = "isTrue" | "isFalse";
export type FilterOperator =
| TextFilterOperator
| NumberFilterOperator
| DateFilterOperator
| SelectFilterOperator
| BooleanFilterOperator;
export interface FilterValue {
operator: FilterOperator;
value?: string | number | string[];
endValue?: string | number;
}
src/hooks/use-isomorphic-layout-effect.ts
import * as React from "react";
const useIsomorphicLayoutEffect =
typeof window !== "undefined" ? React.useLayoutEffect : React.useEffect;
export { useIsomorphicLayoutEffect };