Major Changes
-
#746
4173087
Thanks @clauderic! - Accessibility related changes.Regrouping accessibility-related props
Accessibility-related props have been regrouped under the
accessibility
prop of<DndContext>
:<DndContext - announcements={customAnnouncements} - screenReaderInstructions={customScreenReaderInstructions} + accessibility={{ + announcements: customAnnouncements, + screenReaderInstructions: customScreenReaderInstructions, + }}
This is a breaking change that will allow easier addition of new accessibility-related features without overloading the props namespace of
<DndContext>
.Arguments object for announcements
The arguments passed to announcement callbacks have changed. They now receive an object that contains the
active
andover
properties that match the signature of those passed to the DragEvent handlers (onDragStart
,onDragMove
, etc.). This change allows consumers to read thedata
property of theactive
andover
node to customize the announcements based on the data.Example migration steps:
export const announcements: Announcements = { - onDragStart(id) { + onDragStart({active}) { - return `Picked up draggable item ${id}.`; + return `Picked up draggable item ${active.id}.`; }, - onDragOver(id, overId) { + onDragOver({active, over}) { - if (overId) { + if (over) { - return `Draggable item ${id} was moved over droppable area ${overId}.`; + return `Draggable item ${active.id} was moved over droppable area ${over.id}.`; } - return `Draggable item ${id} is no longer over a droppable area.`; + return `Draggable item ${active.id} is no longer over a droppable area.`; }, };
Accessibility-related DOM nodes are no longer portaled by default
The DOM nodes for the screen reader instructions and announcements are no longer portaled into the
document.body
element by default.This change is motivated by the fact that screen readers do not always announce ARIA live regions that are rendered on the
document.body
. Common examples of this include when rendering a<DndContext>
within a<dialog>
element or an element that hasrole="dialog"
, only ARIA live regions rendered within the dialog will be announced.Consumers can now opt to render announcements in the portal container of their choice using the
container
property of theaccessibility
prop:<DndContext + accessibility={{ + container: document.body, + }}
-
#733
035021a
Thanks @clauderic! - The<DragOverlay>
component's drop animation has been refactored, which fixes a number of bugs with the existing implementation and introduces new functionality.What's new?
Scrolling the draggable node into view if needed
The drop animation now ensures that the the draggable node that we are animating to is in the viewport before performing the drop animation and scrolls it into view if needed.
Changes to the
dropAnimation
propThe
dropAnimation
prop of<DragOverlay>
now accepts either a configuration object or a custom drop animation function.The configuration object adheres to the following shape:
interface DropAnimationOptions { duration?: number; easing?: string; keyframes?: DropAnimationKeyframeResolver; sideEffects?: DropAnimationSideEffects; }
The default drop animation options are:
const defaultDropAnimationConfiguration: DropAnimationOptions = { duration: 250, easing: 'ease', keyframes: defaultDropAnimationKeyframes, sideEffects: defaultDropAnimationSideEffects({ styles: { active: { opacity: '0', }, }, }), };
The
keyframes
option allows consumers to override the keyframes of the drop animation. For example, here is how you would add a fade out transition to the drop animation using keyframes:import {CSS} from '@dnd-kit/utilities'; const customDropAnimation = { keyframes({transform}) { return [ {opacity: 1, transform: CSS.Transform.toString(transform.initial)}, {opacity: 0, transform: CSS.Transform.toString(transform.final)}, ]; }, };
The
dragSourceOpacity
option has been deprecated in favour of letting consumers define arbitrary side effects that should run before the animation starts. Side effects may return a cleanup function that should run when the drop animation has completed.type CleanupFunction = () => void; export type DropAnimationSideEffects = ( parameters: DropAnimationSideEffectsParameters ) => CleanupFunction | void;
Drop animation side effects are a powerful abstraction that provide a lot of flexibility. The
defaultDropAnimationSideEffects
function is exported by@dnd-kit/core
and aims to facilitate the types of side-effects we anticipate most consumers will want to use out of the box:interface DefaultDropAnimationSideEffectsOptions { // Apply a className on the active draggable or drag overlay node during the drop animation className?: { active?: string; dragOverlay?: string; }; // Apply temporary styles to the active draggable node or drag overlay during the drop animation styles?: { active?: Styles; dragOverlay?: Styles; }; }
For advanced side-effects, consumers may define a custom
sideEffects
function that may optionally return a cleanup function that will be executed when the drop animation completes:const customDropAnimation = { sideEffects({active}) { active.node.classList.add('dropAnimationInProgress'); active.node.animate([{opacity: 0}, {opacity: 1}], { easing: 'ease-in', duration: 250, }); return () => { // Clean up when the drop animation is complete active.node.classList.remove('dropAnimationInProgress'); }; }, };
For even more advanced use-cases, consumers may also provide a function to the
dropAnimation
prop, which adheres to the following shape:interface DropAnimationFunctionArguments { active: { id: UniqueIdentifier; data: DataRef; node: HTMLElement; rect: ClientRect; }; draggableNodes: DraggableNodes; dragOverlay: { node: HTMLElement; rect: ClientRect; }; droppableContainers: DroppableContainers; measuringConfiguration: DeepRequired<MeasuringConfiguration>; transform: Transform; } type DropAnimationFunction = ( args: DropAnimationFunctionArguments ) => Promise<void> | void;
Bug fixes
- The
<DragOverlay>
now respects themeasuringConfiguration
specified for thedragOverlay
anddraggable
properties when measuring the rects to animate to and from. - The
<DragOverlay>
component now supports rendering children while performing the drop animation. Previously, the drag overlay would be in a broken state when trying to pick up an item while a drop animation was in progress.
Migration steps
For consumers that were relying on the
dragSourceOpacity
property in theirdropAnimation
configuration:+ import {defaultDropAnimationSideEffects} from '@dnd-kit/core'; const dropAnimation = { - dragSourceOpacity: 0.5, + sideEffects: defaultDropAnimationSideEffects({ + styles : { + active: { + opacity: '0.5', + }, + }, + ), };
- The
-
#745
5f3c700
Thanks @clauderic! - The keyboard sensor now keeps track of the initial coordinates of the collision rect to provide a translate delta when move events are dispatched.This is a breaking change that may affect consumers that had created custom keyboard coordinate getters.
Previously the keyboard sensor would measure the initial rect of the active node and store its top and left properties as its initial coordinates it would then compare all subsequent move coordinates to calculate the delta.
This approach suffered from the following issues:
- It didn't respect the measuring configuration defined on the
<DndContext>
for the draggable node - Some consumers re-render the active node after dragging begins, which would lead to stale measurements
- An error had to be thrown if there was no active node during the activation phase of the keyboard sensor. This shouldn't be a concern of the keyboard sensor.
- The
currentCoordinates
passed to the coordinate getter were often stale and not an accurate representation of the current position of the collision rect, which can be affected by a number of different variables, such as modifiers.
- It didn't respect the measuring configuration defined on the
-
#755
33e6dd2
Thanks @clauderic! - TheUniqueIdentifier
type has been updated to now accept eitherstring
ornumber
identifiers. As a result, theid
property ofuseDraggable
,useDroppable
anduseSortable
and theitems
prop of<SortableContext>
now all accept eitherstring
ornumber
identifiers.Migration steps
For consumers that are using TypeScript, import the
UniqueIdentifier
type to have strongly typed local state:+ import type {UniqueIdentifier} from '@dnd-kit/core'; function MyComponent() { - const [items, setItems] = useState(['A', 'B', 'C']); + const [items, setItems] = useState<UniqueIdentifier>(['A', 'B', 'C']); }
Alternatively, consumers can cast or convert the
id
property to astring
when reading theid
property of interfaces such asActive
,Over
,DroppableContainer
andDraggableNode
.The
draggableNodes
object has also been converted to a map. Consumers that were reading from thedraggableNodes
property that is available on the public context of<DndContext>
should follow these migration steps:- draggableNodes[someId]; + draggableNodes.get(someId);
Minor Changes
-
#748
59ca82b
Thanks @clauderic! - Automatic focus management and activator node refs.Introducing activator node refs
Introducing the concept of activator node refs for
useDraggable
anduseSortable
. This allows @dnd-kit to handle common use-cases such as restoring focus on the activator node after dragging via the keyboard or only allowing the activator node to instantiate the keyboard sensor.Consumers of
useDraggable
anduseSortable
may now optionally set the activator node ref on the element that receives listeners:import {useDraggable} from '@dnd-kit/core'; function Draggable(props) { const { listeners, setNodeRef, + setActivatorNodeRef, } = useDraggable({id: props.id}); return ( <div ref={setNodeRef}> Draggable element <button {...listeners} + ref={setActivatorNodeRef} > :: Drag Handle </button> </div> ) }
It's common for the activator element (the element that receives the sensor listeners) to differ from the draggable node. When this happens, @dnd-kit has no reliable way to get a reference to the activator node after dragging ends, as the original
event.target
that instantiated the sensor may no longer be mounted in the DOM or associated with the draggable node that was previously active.Automatically restoring focus
Focus management is now automatically handled by @dnd-kit. When the activator event is a Keyboard event, @dnd-kit will now attempt to automatically restore focus back to the first focusable node of the activator node or draggable node.
If no activator node is specified via the
setActivatorNodeRef
setter function ofuseDraggble
anduseSortable
, @dnd-kit will automatically restore focus on the first focusable node of the draggable node set via thesetNodeRef
setter function ofuseDraggable
anduseSortable
.If you were previously managing focus manually and would like to opt-out of automatic focus management, use the newly introduced
restoreFocus
property of theaccessibility
prop of<DndContext>
:<DndContext accessibility={{ + restoreFocus: false }}
-
#751
a52fba1
Thanks @clauderic! - Added thearia-disabled
attribute to theattribtues
object returned byuseDraggable
anduseSortable
. The value of thearia-disabled
attribute is populated based on whether or not thedisabled
argument is passed touseDraggble
oruseSortable
. -
#741
40707ce
Thanks @clauderic! - The auto scroller now keeps track of the drag direction to infer scroll intent. By default, auto-scrolling will now be disabled for a given direction if dragging in that direction hasn't occurred yet. This prevents accidental auto-scrolling when picking up a draggable item that is near the scroll boundary threshold. -
#660
a41e5b8
Thanks @clauderic! - Fixed a bug with thedelta
property returned inonDragMove
,onDragOver
,onDragEnd
andonDragCancel
. Thedelta
property represents thetransform
delta since dragging was initiated, along with the scroll delta. However, due to an oversight, thedelta
property was actually returning thetransform
delta and the current scroll offsets rather than the scroll delta.This same change has been made to the
scrollAdjustedTranslate
property that is exposed to sensors. -
#750
bf30718
Thanks @clauderic! - TheuseDndMonitor()
hook has been refactored to be synchronously invoked at the same time as the events dispatched by<DndContext>
(such asonDragStart
,onDragOver
,onDragEnd
).The new refactor uses the subscribe/notify pattern and no longer causes re-renders in consuming components of
useDndMonitor()
when events are dispatched. -
#660
a41e5b8
Thanks @clauderic! - TheactiveNodeRect
andcontainerNodeRect
are now observed by aResizeObserver
in case they resize while dragging. -
#660
a41e5b8
Thanks @clauderic! - ImproveduseDraggable
usage without<DragOverlay>
:- The active draggable now scrolls with the page even if there is no
<DragOverlay>
used. - Fixed issues when re-ordering the active draggable node in the DOM while dragging.
- The active draggable now scrolls with the page even if there is no
-
#660
77e3d44
Thanks @clauderic! - Fixed an issue withuseDroppable
hook needlessly dispatchingSetDroppableDisabled
actions even if thedisabled
property had not changed since registering the droppable. -
#749
188a450
Thanks @clauderic! - TheonDragStart
,onDragMove
,onDragOver
,onDragEnd
andonDragCancel
events of<DndContext>
anduseDndMonitor
now expose theactivatorEvent
event that instantiated the activated sensor. -
#733
035021a
Thanks @clauderic! - TheKeyboardSensor
now scrolls the focused activator draggable node into view if it is not within the viewport. -
#733
035021a
Thanks @clauderic! - By default, @dnd-kit now attempts to compensate for layout shifts that happen right after theonDragStart
event is dispatched by scrolling the first scrollable ancestor of the active draggable node.The
autoScroll
prop of<DndContext>
now optionally accepts alayoutShiftCompensation
property to control this new behavior:interface AutoScrollOptions { acceleration?: number; activator?: AutoScrollActivator; canScroll?: CanScroll; enabled?: boolean; interval?: number; + layoutShiftCompensation?: boolean | {x: boolean, y: boolean}; order?: TraversalOrder; threshold?: { x: number; y: number; }; }
To enable/disable layout shift scroll compensation for a single scroll axis, pass in the following autoscroll configuration to
<DndContext>
:<DndContext autoScroll={{layoutShiftCompensation: {x: false, y: true}}} >
To completely disable layout shift scroll compensation, pass in the following autoscroll configuration to
<DndContext>
:<DndContext autoScroll={{layoutShiftCompensation: false}} >
-
#672
10f6836
Thanks @clauderic! - ThemeasureDroppableContainers
method now properly respects the MeasuringStrategy defined on<DndContext />
and will not measure containers while measuring is disabled. -
#656
c1b3b5a
Thanks @clauderic! - Fixed an issue with collision detection using stale rects. ThedroppableRects
property has been added to theCollisionDetection
interface.All built-in collision detection algorithms have been updated to get the rect for a given droppable container from
droppableRects
rather than from therect.current
ref:- const rect = droppableContainers.get(id).rect.current; + const rect = droppableRects.get(id);
The
rect.current
ref stored on DroppableContainers can be stale if measuring is scheduled but has not completed yet. Collision detection algorithms should use thedroppableRects
map instead to get the latest, most up-to-date measurement of a droppable container in order to avoid computing collisions against stale rects.This is not a breaking change. However, if you've forked any of the built-in collision detection algorithms or you've authored custom ones, we highly recommend you update your use-cases to avoid possibly computing collisions against stale rects.
Patch Changes
-
#742
7161f70
Thanks @clauderic! - Fallback to initial rect measured for the active draggable node if it unmounts during initialization (afteronDragStart
is dispatched). -
#749
5811986
Thanks @clauderic! - TheData
andDataRef
types are now exported by@dnd-kit/core
. -
#699
e302bd4
Thanks @JuAn-Kang! - ExportDragOverlayProps
for consumers. -
750d726
Thanks @clauderic! - Fixed a bug in theKeyboardSensor
where it would not move the draggable on the horizontal axis if it could fully scroll to the new vertical coordinates, and would not move the draggable on the vertical axis if it could fully scroll to the new horizontal coordinates. -
#660
e6e242c
Thanks @clauderic! - TheKeyboardSensor
was updated to usescrollTo
instead ofscrollBy
when it is able to fully scroll to the new coordinates returned by the coordinate getter function. This resolves issues that can happen withscrollBy
when called in rapid succession. -
Updated dependencies [
59ca82b
,035021a
]:- @dnd-kit/[email protected]