"use client"; import { type Announcements, type CollisionDetection, DndContext, type DndContextProps, type DragCancelEvent, type DragEndEvent, type DragOverEvent, DragOverlay, type DragStartEvent, type DraggableAttributes, type DraggableSyntheticListeners, type DropAnimation, type DroppableContainer, KeyboardCode, type KeyboardCoordinateGetter, KeyboardSensor, MeasuringStrategy, MouseSensor, TouchSensor, type UniqueIdentifier, closestCenter, closestCorners, defaultDropAnimationSideEffects, getFirstCollision, pointerWithin, rectIntersection, useSensor, useSensors } from "@dnd-kit/core"; import { type AnimateLayoutChanges, SortableContext, type SortableContextProps, arrayMove, defaultAnimateLayoutChanges, horizontalListSortingStrategy, useSortable, verticalListSortingStrategy } from "@dnd-kit/sortable"; import { CSS } from "@dnd-kit/utilities"; import { Slot } from "@radix-ui/react-slot"; import * as React from "react"; import * as ReactDOM from "react-dom"; import { useComposedRefs } from "../lib/compose-refs"; import { cn } from "@/lib/utils"; const directions: string[] = [ KeyboardCode.Down, KeyboardCode.Right, KeyboardCode.Up, KeyboardCode.Left ]; const coordinateGetter: KeyboardCoordinateGetter = (event, { context }) => { const { active, droppableRects, droppableContainers, collisionRect } = context; if (directions.includes(event.code)) { event.preventDefault(); if (!active || !collisionRect) return; const filteredContainers: DroppableContainer[] = []; for (const entry of droppableContainers.getEnabled()) { if (!entry || entry?.disabled) return; const rect = droppableRects.get(entry.id); if (!rect) return; const data = entry.data.current; if (data) { const { type, children } = data; if (type === "container" && children?.length > 0) { if (active.data.current?.type !== "container") { return; } } } switch (event.code) { case KeyboardCode.Down: if (collisionRect.top < rect.top) { filteredContainers.push(entry); } break; case KeyboardCode.Up: if (collisionRect.top > rect.top) { filteredContainers.push(entry); } break; case KeyboardCode.Left: if (collisionRect.left >= rect.left + rect.width) { filteredContainers.push(entry); } break; case KeyboardCode.Right: if (collisionRect.left + collisionRect.width <= rect.left) { filteredContainers.push(entry); } break; } } const collisions = closestCorners({ active, collisionRect: collisionRect, droppableRects, droppableContainers: filteredContainers, pointerCoordinates: null }); const closestId = getFirstCollision(collisions, "id"); if (closestId != null) { const newDroppable = droppableContainers.get(closestId); const newNode = newDroppable?.node.current; const newRect = newDroppable?.rect.current; if (newNode && newRect) { if (newDroppable.id === "placeholder") { return { x: newRect.left + (newRect.width - collisionRect.width) / 2, y: newRect.top + (newRect.height - collisionRect.height) / 2 }; } if (newDroppable.data.current?.type === "container") { return { x: newRect.left + 20, y: newRect.top + 74 }; } return { x: newRect.left, y: newRect.top }; } } } return undefined; }; const ROOT_NAME = "Kanban"; const BOARD_NAME = "KanbanBoard"; const COLUMN_NAME = "KanbanColumn"; const COLUMN_HANDLE_NAME = "KanbanColumnHandle"; const ITEM_NAME = "KanbanItem"; const ITEM_HANDLE_NAME = "KanbanItemHandle"; const OVERLAY_NAME = "KanbanOverlay"; interface KanbanContextValue { id: string; items: Record; modifiers: DndContextProps["modifiers"]; strategy: SortableContextProps["strategy"]; orientation: "horizontal" | "vertical"; activeId: UniqueIdentifier | null; setActiveId: (id: UniqueIdentifier | null) => void; getItemValue: (item: T) => UniqueIdentifier; flatCursor: boolean; } const KanbanContext = React.createContext | null>(null); KanbanContext.displayName = ROOT_NAME; function useKanbanContext(consumerName: string) { const context = React.useContext(KanbanContext); if (!context) { throw new Error(`\`${consumerName}\` must be used within \`${ROOT_NAME}\``); } return context; } interface GetItemValue { /** * Callback that returns a unique identifier for each kanban item. Required for array of objects. * @example getItemValue={(item) => item.id} */ getItemValue: (item: T) => UniqueIdentifier; } type KanbanRootProps = Omit & GetItemValue & { value: Record; onValueChange?: (columns: Record) => void; onMove?: (event: DragEndEvent & { activeIndex: number; overIndex: number }) => void; strategy?: SortableContextProps["strategy"]; orientation?: "horizontal" | "vertical"; flatCursor?: boolean; } & (T extends object ? GetItemValue : Partial>); function KanbanRoot(props: KanbanRootProps) { const { value, onValueChange, modifiers, strategy = verticalListSortingStrategy, orientation = "horizontal", onMove, getItemValue: getItemValueProp, accessibility, flatCursor = false, ...kanbanProps } = props; const id = React.useId(); const [activeId, setActiveId] = React.useState(null); const lastOverIdRef = React.useRef(null); const hasMovedRef = React.useRef(false); const sensors = useSensors( useSensor(MouseSensor), useSensor(TouchSensor), useSensor(KeyboardSensor, { coordinateGetter }) ); 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 getColumn = React.useCallback( (id: UniqueIdentifier) => { if (id in value) return id; for (const [columnId, items] of Object.entries(value)) { if (items.some((item) => getItemValue(item) === id)) { return columnId; } } return null; }, [value, getItemValue] ); const collisionDetection: CollisionDetection = React.useCallback( (args) => { if (activeId && activeId in value) { return closestCenter({ ...args, droppableContainers: args.droppableContainers.filter((container) => container.id in value) }); } const pointerIntersections = pointerWithin(args); const intersections = pointerIntersections.length > 0 ? pointerIntersections : rectIntersection(args); let overId = getFirstCollision(intersections, "id"); if (!overId) { if (hasMovedRef.current) { lastOverIdRef.current = activeId; } return lastOverIdRef.current ? [{ id: lastOverIdRef.current }] : []; } if (overId in value) { const containerItems = value[overId]; if (containerItems && containerItems.length > 0) { const closestItem = closestCenter({ ...args, droppableContainers: args.droppableContainers.filter( (container) => container.id !== overId && containerItems.some((item) => getItemValue(item) === container.id) ) }); if (closestItem.length > 0) { overId = closestItem[0]?.id ?? overId; } } } lastOverIdRef.current = overId; return [{ id: overId }]; }, [activeId, value, getItemValue] ); const onDragStart = React.useCallback( (event: DragStartEvent) => { kanbanProps.onDragStart?.(event); if (event.activatorEvent.defaultPrevented) return; setActiveId(event.active.id); }, [kanbanProps.onDragStart] ); const onDragOver = React.useCallback( (event: DragOverEvent) => { kanbanProps.onDragOver?.(event); if (event.activatorEvent.defaultPrevented) return; const { active, over } = event; if (!over) return; const activeColumn = getColumn(active.id); const overColumn = getColumn(over.id); if (!activeColumn || !overColumn) return; if (activeColumn === overColumn) { const items = value[activeColumn]; if (!items) return; const activeIndex = items.findIndex((item) => getItemValue(item) === active.id); const overIndex = items.findIndex((item) => getItemValue(item) === over.id); if (activeIndex !== overIndex) { const newColumns = { ...value }; newColumns[activeColumn] = arrayMove(items, activeIndex, overIndex); onValueChange?.(newColumns); } } else { const activeItems = value[activeColumn]; const overItems = value[overColumn]; if (!activeItems || !overItems) return; const activeIndex = activeItems.findIndex((item) => getItemValue(item) === active.id); if (activeIndex === -1) return; const activeItem = activeItems[activeIndex]; if (!activeItem) return; const updatedItems = { ...value, [activeColumn]: activeItems.filter((item) => getItemValue(item) !== active.id), [overColumn]: [...overItems, activeItem] }; onValueChange?.(updatedItems); hasMovedRef.current = true; } }, [value, getColumn, getItemValue, onValueChange, kanbanProps.onDragOver] ); const onDragEnd = React.useCallback( (event: DragEndEvent) => { kanbanProps.onDragEnd?.(event); if (event.activatorEvent.defaultPrevented) return; const { active, over } = event; if (!over) { setActiveId(null); return; } if (active.id in value && over.id in value) { const activeIndex = Object.keys(value).indexOf(active.id as string); const overIndex = Object.keys(value).indexOf(over.id as string); if (activeIndex !== overIndex) { const orderedColumns = Object.keys(value); const newOrder = arrayMove(orderedColumns, activeIndex, overIndex); const newColumns: Record = {}; for (const key of newOrder) { const items = value[key]; if (items) { newColumns[key] = items; } } if (onMove) { onMove({ ...event, activeIndex, overIndex }); } else { onValueChange?.(newColumns); } } } else { const activeColumn = getColumn(active.id); const overColumn = getColumn(over.id); if (!activeColumn || !overColumn) { setActiveId(null); return; } if (activeColumn === overColumn) { const items = value[activeColumn]; if (!items) { setActiveId(null); return; } const activeIndex = items.findIndex((item) => getItemValue(item) === active.id); const overIndex = items.findIndex((item) => getItemValue(item) === over.id); if (activeIndex !== overIndex) { const newColumns = { ...value }; newColumns[activeColumn] = arrayMove(items, activeIndex, overIndex); if (onMove) { onMove({ ...event, activeIndex, overIndex }); } else { onValueChange?.(newColumns); } } } } setActiveId(null); hasMovedRef.current = false; }, [value, getColumn, getItemValue, onValueChange, onMove, kanbanProps.onDragEnd] ); const onDragCancel = React.useCallback( (event: DragCancelEvent) => { kanbanProps.onDragCancel?.(event); if (event.activatorEvent.defaultPrevented) return; setActiveId(null); hasMovedRef.current = false; }, [kanbanProps.onDragCancel] ); const announcements: Announcements = React.useMemo( () => ({ onDragStart({ active }) { const isColumn = active.id in value; const itemType = isColumn ? "column" : "item"; const position = isColumn ? Object.keys(value).indexOf(active.id as string) + 1 : (() => { const column = getColumn(active.id); if (!column || !value[column]) return 1; return value[column].findIndex((item) => getItemValue(item) === active.id) + 1; })(); const total = isColumn ? Object.keys(value).length : (() => { const column = getColumn(active.id); return column ? (value[column]?.length ?? 0) : 0; })(); return `Picked up ${itemType} at position ${position} of ${total}`; }, onDragOver({ active, over }) { if (!over) return; const isColumn = active.id in value; const itemType = isColumn ? "column" : "item"; const position = isColumn ? Object.keys(value).indexOf(over.id as string) + 1 : (() => { const column = getColumn(over.id); if (!column || !value[column]) return 1; return value[column].findIndex((item) => getItemValue(item) === over.id) + 1; })(); const total = isColumn ? Object.keys(value).length : (() => { const column = getColumn(over.id); return column ? (value[column]?.length ?? 0) : 0; })(); const overColumn = getColumn(over.id); const activeColumn = getColumn(active.id); if (isColumn) { return `${itemType} is now at position ${position} of ${total}`; } if (activeColumn !== overColumn) { return `${itemType} is now at position ${position} of ${total} in ${overColumn}`; } return `${itemType} is now at position ${position} of ${total}`; }, onDragEnd({ active, over }) { if (!over) return; const isColumn = active.id in value; const itemType = isColumn ? "column" : "item"; const position = isColumn ? Object.keys(value).indexOf(over.id as string) + 1 : (() => { const column = getColumn(over.id); if (!column || !value[column]) return 1; return value[column].findIndex((item) => getItemValue(item) === over.id) + 1; })(); const total = isColumn ? Object.keys(value).length : (() => { const column = getColumn(over.id); return column ? (value[column]?.length ?? 0) : 0; })(); const overColumn = getColumn(over.id); const activeColumn = getColumn(active.id); if (isColumn) { return `${itemType} was dropped at position ${position} of ${total}`; } if (activeColumn !== overColumn) { return `${itemType} was dropped at position ${position} of ${total} in ${overColumn}`; } return `${itemType} was dropped at position ${position} of ${total}`; }, onDragCancel({ active }) { const isColumn = active.id in value; const itemType = isColumn ? "column" : "item"; return `Dragging was cancelled. ${itemType} was dropped.`; } }), [value, getColumn, getItemValue] ); const contextValue = React.useMemo>( () => ({ id, items: value, modifiers, strategy, orientation, activeId, setActiveId, getItemValue, flatCursor }), [id, value, activeId, modifiers, strategy, orientation, getItemValue, flatCursor] ); return ( }> ); } const KanbanBoardContext = React.createContext(false); KanbanBoardContext.displayName = BOARD_NAME; interface KanbanBoardProps extends React.ComponentPropsWithoutRef<"div"> { children: React.ReactNode; asChild?: boolean; } const KanbanBoard = React.forwardRef((props, forwardedRef) => { const { asChild, className, ...boardProps } = props; const context = useKanbanContext(BOARD_NAME); const columns = React.useMemo(() => { return Object.keys(context.items); }, [context.items]); const BoardPrimitive = asChild ? Slot : "div"; return ( ); }); KanbanBoard.displayName = BOARD_NAME; interface KanbanColumnContextValue { id: string; attributes: DraggableAttributes; listeners: DraggableSyntheticListeners | undefined; setActivatorNodeRef: (node: HTMLElement | null) => void; isDragging?: boolean; disabled?: boolean; } const KanbanColumnContext = React.createContext(null); KanbanColumnContext.displayName = COLUMN_NAME; function useKanbanColumnContext(consumerName: string) { const context = React.useContext(KanbanColumnContext); if (!context) { throw new Error(`\`${consumerName}\` must be used within \`${COLUMN_NAME}\``); } return context; } const animateLayoutChanges: AnimateLayoutChanges = (args) => defaultAnimateLayoutChanges({ ...args, wasDragging: true }); interface KanbanColumnProps extends React.ComponentPropsWithoutRef<"div"> { value: UniqueIdentifier; children: React.ReactNode; asChild?: boolean; asHandle?: boolean; disabled?: boolean; } const KanbanColumn = React.forwardRef((props, forwardedRef) => { const { value, asChild, asHandle, disabled, className, style, ...columnProps } = props; const id = React.useId(); const context = useKanbanContext(COLUMN_NAME); const inBoard = React.useContext(KanbanBoardContext); const inOverlay = React.useContext(KanbanOverlayContext); if (!inBoard && !inOverlay) { throw new Error( `\`${COLUMN_NAME}\` must be used within \`${BOARD_NAME}\` or \`${OVERLAY_NAME}\`` ); } if (value === "") { throw new Error(`\`${COLUMN_NAME}\` value cannot be an empty string`); } const { attributes, listeners, setNodeRef, setActivatorNodeRef, transform, transition, isDragging } = useSortable({ id: value, disabled, animateLayoutChanges }); const composedRef = useComposedRefs(forwardedRef, (node) => { if (disabled) return; setNodeRef(node); }); const composedStyle = React.useMemo(() => { return { transform: CSS.Transform.toString(transform), transition, ...style }; }, [transform, transition, style]); const items = React.useMemo(() => { const items = context.items[value] ?? []; return items.map((item) => context.getItemValue(item)); }, [context.items, value, context.getItemValue]); const columnContext = React.useMemo( () => ({ id, attributes, listeners, setActivatorNodeRef, isDragging, disabled }), [id, attributes, listeners, setActivatorNodeRef, isDragging, disabled] ); const ColumnPrimitive = asChild ? Slot : "div"; return ( ); }); KanbanColumn.displayName = COLUMN_NAME; interface KanbanColumnHandleProps extends React.ComponentPropsWithoutRef<"button"> { asChild?: boolean; } const KanbanColumnHandle = React.forwardRef( (props, forwardedRef) => { const { asChild, disabled, className, ...columnHandleProps } = props; const context = useKanbanContext(COLUMN_NAME); const columnContext = useKanbanColumnContext(COLUMN_HANDLE_NAME); const isDisabled = disabled ?? columnContext.disabled; const composedRef = useComposedRefs(forwardedRef, (node) => { if (isDisabled) return; columnContext.setActivatorNodeRef(node); }); const HandlePrimitive = asChild ? Slot : "button"; return ( ); } ); KanbanColumnHandle.displayName = COLUMN_HANDLE_NAME; interface KanbanItemContextValue { id: string; attributes: DraggableAttributes; listeners: DraggableSyntheticListeners | undefined; setActivatorNodeRef: (node: HTMLElement | null) => void; isDragging?: boolean; disabled?: boolean; } const KanbanItemContext = React.createContext(null); KanbanItemContext.displayName = ITEM_NAME; function useKanbanItemContext(consumerName: string) { const context = React.useContext(KanbanItemContext); if (!context) { throw new Error(`\`${consumerName}\` must be used within \`${ITEM_NAME}\``); } return context; } interface KanbanItemProps extends React.ComponentPropsWithoutRef<"div"> { value: UniqueIdentifier; asHandle?: boolean; asChild?: boolean; disabled?: boolean; } const KanbanItem = React.forwardRef((props, forwardedRef) => { const { value, style, asHandle, asChild, disabled, className, ...itemProps } = props; const id = React.useId(); const context = useKanbanContext(ITEM_NAME); const inBoard = React.useContext(KanbanBoardContext); const inOverlay = React.useContext(KanbanOverlayContext); if (!inBoard && !inOverlay) { throw new Error(`\`${ITEM_NAME}\` must be used within \`${BOARD_NAME}\``); } const { attributes, listeners, setNodeRef, setActivatorNodeRef, transform, transition, isDragging } = useSortable({ id: value, disabled }); if (value === "") { throw new Error(`\`${ITEM_NAME}\` value cannot be an empty string`); } const composedRef = useComposedRefs(forwardedRef, (node) => { if (disabled) return; setNodeRef(node); }); const composedStyle = React.useMemo(() => { return { transform: CSS.Transform.toString(transform), transition, ...style }; }, [transform, transition, style]); const itemContext = React.useMemo( () => ({ id, attributes, listeners, setActivatorNodeRef, isDragging, disabled }), [id, attributes, listeners, setActivatorNodeRef, isDragging, disabled] ); const ItemPrimitive = asChild ? Slot : "div"; return ( ); }); KanbanItem.displayName = ITEM_NAME; interface KanbanItemHandleProps extends React.ComponentPropsWithoutRef<"button"> { asChild?: boolean; } const KanbanItemHandle = React.forwardRef( (props, forwardedRef) => { const { asChild, disabled, className, ...itemHandleProps } = props; const context = useKanbanContext(ITEM_HANDLE_NAME); const itemContext = useKanbanItemContext(ITEM_HANDLE_NAME); const isDisabled = disabled ?? itemContext.disabled; const composedRef = useComposedRefs(forwardedRef, (node) => { if (isDisabled) return; itemContext.setActivatorNodeRef(node); }); const HandlePrimitive = asChild ? Slot : "button"; return ( ); } ); KanbanItemHandle.displayName = ITEM_HANDLE_NAME; const KanbanOverlayContext = React.createContext(false); KanbanOverlayContext.displayName = OVERLAY_NAME; const dropAnimation: DropAnimation = { sideEffects: defaultDropAnimationSideEffects({ styles: { active: { opacity: "0.4" } } }) }; interface KanbanOverlayProps extends Omit, "children"> { container?: Element | DocumentFragment | null; children?: | ((params: { value: UniqueIdentifier; variant: "column" | "item" }) => React.ReactNode) | React.ReactNode; } function KanbanOverlay(props: KanbanOverlayProps) { const { container: containerProp, children, ...overlayProps } = props; const context = useKanbanContext(OVERLAY_NAME); const [mounted, setMounted] = React.useState(false); React.useLayoutEffect(() => setMounted(true), []); const container = containerProp ?? (mounted ? globalThis.document?.body : null); if (!container) return null; const variant = context.activeId && context.activeId in context.items ? "column" : "item"; return ReactDOM.createPortal( {context.activeId && children ? typeof children === "function" ? children({ value: context.activeId, variant }) : children : null} , container ); } export { KanbanRoot as Kanban, KanbanBoard, KanbanColumn, KanbanColumnHandle, KanbanItem, KanbanItemHandle, KanbanOverlay, // KanbanRoot as Root, KanbanBoard as Board, KanbanColumn as Column, KanbanColumnHandle as ColumnHandle, KanbanItem as Item, KanbanItemHandle as ItemHandle, KanbanOverlay as Overlay };