diff --git a/.changeset/accessibility-related-props.md b/.changeset/accessibility-related-props.md deleted file mode 100644 index 622fa0e88..000000000 --- a/.changeset/accessibility-related-props.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -'@dnd-kit/core': major ---- - -Accessibility related changes. - -#### Regrouping accessibility-related props - -Accessibility-related props have been regrouped under the `accessibility` prop of ``: - -```diff -`. - -#### 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 `` within a `` element or an element that has `role="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 the `accessibility` prop: - -```diff - - Draggable element - - - ) -} -``` - -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 of `useDraggble` and `useSortable`, @dnd-kit will automatically restore focus on the first focusable node of the draggable node set via the `setNodeRef` setter function of `useDraggable` and `useSortable`. - -If you were previously managing focus manually and would like to opt-out of automatic focus management, use the newly introduced `restoreFocus` property of the `accessibility` prop of ``: - -```diff -`: - -- The active draggable now scrolls with the page even if there is no `` used. -- Fixed issues when re-ordering the active draggable node in the DOM while dragging. diff --git a/.changeset/drop-animation-refactor.md b/.changeset/drop-animation-refactor.md deleted file mode 100644 index 4681188e1..000000000 --- a/.changeset/drop-animation-refactor.md +++ /dev/null @@ -1,153 +0,0 @@ ---- -'@dnd-kit/core': major ---- - -The `` 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` prop - -The `dropAnimation` prop of `` now accepts either a configuration object or a custom drop animation function. - -The configuration object adheres to the following shape: - -```ts -interface DropAnimationOptions { - duration?: number; - easing?: string; - keyframes?: DropAnimationKeyframeResolver; - sideEffects?: DropAnimationSideEffects; -} -``` - -The default drop animation options are: - -```ts -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: - -```ts -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. - -```ts -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: - -```ts -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: - -```ts -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: - -```ts -interface DropAnimationFunctionArguments { - active: { - id: string; - data: DataRef; - node: HTMLElement; - rect: ClientRect; - }; - draggableNodes: DraggableNodes; - dragOverlay: { - node: HTMLElement; - rect: ClientRect; - }; - droppableContainers: DroppableContainers; - measuringConfiguration: DeepRequired; - transform: Transform; -} - -type DropAnimationFunction = ( - args: DropAnimationFunctionArguments -) => Promise | void; -``` - -### Bug fixes - -- The `` now respects the `measuringConfiguration` specified for the `dragOverlay` and `draggable` properties when measuring the rects to animate to and from. -- The `` 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 their `dropAnimation` configuration: - -```diff -+ import {defaultDropAnimationSideEffects} from '@dnd-kit/core'; - -const dropAnimation = { -- dragSourceOpacity: 0.5, -+ sideEffects: defaultDropAnimationSideEffects({ -+ styles : { -+ active: { -+ opacity: '0.5', -+ }, -+ }, -+ ), -}; -``` diff --git a/.changeset/droppable-disabled-dispatch.md b/.changeset/droppable-disabled-dispatch.md deleted file mode 100644 index e0d9b145f..000000000 --- a/.changeset/droppable-disabled-dispatch.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@dnd-kit/core': minor ---- - -Fixed an issue with `useDroppable` hook needlessly dispatching `SetDroppableDisabled` actions even if the `disabled` property had not changed since registering the droppable. diff --git a/.changeset/export-data-types.md b/.changeset/export-data-types.md deleted file mode 100644 index 2bf87ba8c..000000000 --- a/.changeset/export-data-types.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@dnd-kit/core': patch ---- - -The `Data` and `DataRef` types are now exported by `@dnd-kit/core`. diff --git a/.changeset/export-dragoverlayprops-type.md b/.changeset/export-dragoverlayprops-type.md deleted file mode 100644 index 8876e6273..000000000 --- a/.changeset/export-dragoverlayprops-type.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"@dnd-kit/core": patch ---- - -Export `DragOverlayProps` for consumers. diff --git a/.changeset/expose-activator-event.md b/.changeset/expose-activator-event.md deleted file mode 100644 index 495f857c3..000000000 --- a/.changeset/expose-activator-event.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@dnd-kit/core': minor ---- - -The `onDragStart`, `onDragMove`, `onDragOver`, `onDragEnd` and `onDragCancel` events of `` and `useDndMonitor` now expose the `activatorEvent` event that instantiated the activated sensor. diff --git a/.changeset/first-focusable-node.md b/.changeset/first-focusable-node.md deleted file mode 100644 index 502a282b8..000000000 --- a/.changeset/first-focusable-node.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@dnd-kit/utilities': minor ---- - -Introduced the `findFirstFocusableNode` utility function that returns the first focusable node within a given HTMLElement, or the element itself if it is focusable. diff --git a/.changeset/keyboard-sensor-raceconditions.md b/.changeset/keyboard-sensor-raceconditions.md deleted file mode 100644 index 3b50a2531..000000000 --- a/.changeset/keyboard-sensor-raceconditions.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -'@dnd-kit/core': major ---- - -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 `` 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. diff --git a/.changeset/keyboard-sensor-scrollintoview.md b/.changeset/keyboard-sensor-scrollintoview.md deleted file mode 100644 index c6db8598f..000000000 --- a/.changeset/keyboard-sensor-scrollintoview.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@dnd-kit/core': minor ---- - -The `KeyboardSensor` now scrolls the focused activator draggable node into view if it is not within the viewport. diff --git a/.changeset/keyboard-sensor-scrollto.md b/.changeset/keyboard-sensor-scrollto.md deleted file mode 100644 index 03b48950d..000000000 --- a/.changeset/keyboard-sensor-scrollto.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@dnd-kit/core': patch ---- - -The `KeyboardSensor` was updated to use `scrollTo` instead of `scrollBy` when it is able to fully scroll to the new coordinates returned by the coordinate getter function. This resolves issues that can happen with `scrollBy` when called in rapid succession. diff --git a/.changeset/layout-shift-compensation.md b/.changeset/layout-shift-compensation.md deleted file mode 100644 index ff0400232..000000000 --- a/.changeset/layout-shift-compensation.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -'@dnd-kit/core': minor ---- - -By default, @dnd-kit now attempts to compensate for layout shifts that happen right after the `onDragStart` event is dispatched by scrolling the first scrollable ancestor of the active draggable node. - -The `autoScroll` prop of `` now optionally accepts a `layoutShiftCompensation` property to control this new behavior: - -```diff -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 ``: - -```ts - -``` - -To completely disable layout shift scroll compensation, pass in the following autoscroll configuration to ``: - -```ts - -``` diff --git a/.changeset/respect-measuring-config.md b/.changeset/respect-measuring-config.md deleted file mode 100644 index 8082de0bb..000000000 --- a/.changeset/respect-measuring-config.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@dnd-kit/core': minor ---- - -The `measureDroppableContainers` method now properly respects the MeasuringStrategy defined on `` and will not measure containers while measuring is disabled. diff --git a/.changeset/safer-equal-implementation.md b/.changeset/safer-equal-implementation.md deleted file mode 100644 index 7a01d07f1..000000000 --- a/.changeset/safer-equal-implementation.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"@dnd-kit/sortable": patch ---- - -Faster (and safer) equal implementation. diff --git a/.changeset/sortable-keyboard-coordinates.md b/.changeset/sortable-keyboard-coordinates.md deleted file mode 100644 index 655f0c845..000000000 --- a/.changeset/sortable-keyboard-coordinates.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -'@dnd-kit/sortable': major ---- - -Changes to the default `sortableKeyboardCoordinates` KeyboardSensor coordinate getter. - -#### Better handling of variable sizes - -The default `sortableKeyboardCoordinates` function now has better handling of lists that have items of variable sizes. We recommend that consumers re-order lists `onDragOver` instead of `onDragEnd` when sorting lists of variable sizes via the keyboard for optimal compatibility. - -#### Better handling of overlapping droppables - -The default `sortableKeyboardCoordinates` function that is exported from the `@dnd-kit/sortable` package has been updated to better handle cases where the collision rectangle is overlapping droppable rectangles. For example, for `down` arrow key, the default function had logic that would only consider collisions against droppables that were below the `bottom` edge of the collision rect. This was problematic when the collision rect was overlapping droppable rects, because it meant that it's bottom edge was below the top edge of the droppable, and that resulted in that droppable being skipped. - -```diff -- collisionRect.bottom > droppableRect.top -+ collisionRect.top > droppableRect.top -``` - -This change should be backwards compatible for most consumers, but may introduce regressions in some use-cases, especially for consumers that may have copied the multiple containers examples. There is now a custom sortable keyboard coordinate getter [optimized for multiple containers that you can refer to](https://github.com/clauderic/dnd-kit/tree/master/stories/2%20-%20Presets/Sortable/multipleContainersKeyboardCoordinates.ts). diff --git a/.changeset/stale-collision-rects.md b/.changeset/stale-collision-rects.md deleted file mode 100644 index ae3594573..000000000 --- a/.changeset/stale-collision-rects.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -'@dnd-kit/core': minor ---- - -Fixed an issue with collision detection using stale rects. The `droppableRects` property has been added to the `CollisionDetection` interface. - -All built-in collision detection algorithms have been updated to get the rect for a given droppable container from `droppableRects` rather than from the `rect.current` ref: - -```diff -- 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 the `droppableRects` 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. diff --git a/.changeset/use-event-hook.md b/.changeset/use-event-hook.md deleted file mode 100644 index a98403abd..000000000 --- a/.changeset/use-event-hook.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@dnd-kit/utilities': minor ---- - -Introduced the `useEvent` hook based on [implementation breakdown in the RFC](https://github.com/reactjs/rfcs/blob/useevent/text/0000-useevent.md#internal-implementation). In the future, this hook will be used as a polyfill if the native React hook is unavailble. diff --git a/packages/core/CHANGELOG.md b/packages/core/CHANGELOG.md index 8697a6b39..ae4d13426 100644 --- a/packages/core/CHANGELOG.md +++ b/packages/core/CHANGELOG.md @@ -1,5 +1,337 @@ # @dnd-kit/core +## 6.0.0 + +### Major Changes + +- [#746](https://github.com/clauderic/dnd-kit/pull/746) [`4173087`](https://github.com/clauderic/dnd-kit/commit/417308704454c50f88ab305ab450a99bde5034b0) Thanks [@clauderic](https://github.com/clauderic)! - Accessibility related changes. + + #### Regrouping accessibility-related props + + Accessibility-related props have been regrouped under the `accessibility` prop of ``: + + ```diff + `. + + #### 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 `` within a `` element or an element that has `role="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 the `accessibility` prop: + + ```diff + ` 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` prop + + The `dropAnimation` prop of `` now accepts either a configuration object or a custom drop animation function. + + The configuration object adheres to the following shape: + + ```ts + interface DropAnimationOptions { + duration?: number; + easing?: string; + keyframes?: DropAnimationKeyframeResolver; + sideEffects?: DropAnimationSideEffects; + } + ``` + + The default drop animation options are: + + ```ts + 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: + + ```ts + 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. + + ```ts + 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: + + ```ts + 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: + + ```ts + 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: + + ```ts + interface DropAnimationFunctionArguments { + active: { + id: string; + data: DataRef; + node: HTMLElement; + rect: ClientRect; + }; + draggableNodes: DraggableNodes; + dragOverlay: { + node: HTMLElement; + rect: ClientRect; + }; + droppableContainers: DroppableContainers; + measuringConfiguration: DeepRequired; + transform: Transform; + } + + type DropAnimationFunction = ( + args: DropAnimationFunctionArguments + ) => Promise | void; + ``` + + ### Bug fixes + + - The `` now respects the `measuringConfiguration` specified for the `dragOverlay` and `draggable` properties when measuring the rects to animate to and from. + - The `` 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 their `dropAnimation` configuration: + + ```diff + + import {defaultDropAnimationSideEffects} from '@dnd-kit/core'; + + const dropAnimation = { + - dragSourceOpacity: 0.5, + + sideEffects: defaultDropAnimationSideEffects({ + + styles : { + + active: { + + opacity: '0.5', + + }, + + }, + + ), + }; + ``` + +- [#745](https://github.com/clauderic/dnd-kit/pull/745) [`5f3c700`](https://github.com/clauderic/dnd-kit/commit/5f3c7009698d15936fd20f30f11ad3b23cd7886f) Thanks [@clauderic](https://github.com/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 `` 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. + +### Minor Changes + +- [#748](https://github.com/clauderic/dnd-kit/pull/748) [`59ca82b`](https://github.com/clauderic/dnd-kit/commit/59ca82b9f228f34c7731ece87aef5d9633608b57) Thanks [@clauderic](https://github.com/clauderic)! - #### Introducing activator node refs + + Introducing the concept of activator node refs for `useDraggable` and `useSortable`. 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` and `useSortable` may now optionally set the activator node ref on the element that receives listeners: + + ```diff + import {useDraggable} from '@dnd-kit/core'; + + function Draggable(props) { + const { + listeners, + setNodeRef, + + setActivatorNodeRef, + } = useDraggable({id: props.id}); + + return ( +
+ Draggable element + +
+ ) + } + ``` + + 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 of `useDraggble` and `useSortable`, @dnd-kit will automatically restore focus on the first focusable node of the draggable node set via the `setNodeRef` setter function of `useDraggable` and `useSortable`. + + If you were previously managing focus manually and would like to opt-out of automatic focus management, use the newly introduced `restoreFocus` property of the `accessibility` prop of ``: + + ```diff + `: + + - The active draggable now scrolls with the page even if there is no `` used. + - Fixed issues when re-ordering the active draggable node in the DOM while dragging. + +- [#660](https://github.com/clauderic/dnd-kit/pull/660) [`77e3d44`](https://github.com/clauderic/dnd-kit/commit/77e3d44502383d2f9a9f9af014b053619b3e37b3) Thanks [@clauderic](https://github.com/clauderic)! - Fixed an issue with `useDroppable` hook needlessly dispatching `SetDroppableDisabled` actions even if the `disabled` property had not changed since registering the droppable. + +- [#749](https://github.com/clauderic/dnd-kit/pull/749) [`188a450`](https://github.com/clauderic/dnd-kit/commit/188a4507b99d8e8fdaa50bd26deb826c86608e18) Thanks [@clauderic](https://github.com/clauderic)! - The `onDragStart`, `onDragMove`, `onDragOver`, `onDragEnd` and `onDragCancel` events of `` and `useDndMonitor` now expose the `activatorEvent` event that instantiated the activated sensor. + +- [#733](https://github.com/clauderic/dnd-kit/pull/733) [`035021a`](https://github.com/clauderic/dnd-kit/commit/035021aac51161e2bf9715f087a6dd1b46647bfc) Thanks [@clauderic](https://github.com/clauderic)! - The `KeyboardSensor` now scrolls the focused activator draggable node into view if it is not within the viewport. + +- [#733](https://github.com/clauderic/dnd-kit/pull/733) [`035021a`](https://github.com/clauderic/dnd-kit/commit/035021aac51161e2bf9715f087a6dd1b46647bfc) Thanks [@clauderic](https://github.com/clauderic)! - By default, @dnd-kit now attempts to compensate for layout shifts that happen right after the `onDragStart` event is dispatched by scrolling the first scrollable ancestor of the active draggable node. + + The `autoScroll` prop of `` now optionally accepts a `layoutShiftCompensation` property to control this new behavior: + + ```diff + 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 ``: + + ```ts + + ``` + + To completely disable layout shift scroll compensation, pass in the following autoscroll configuration to ``: + + ```ts + + ``` + +- [#672](https://github.com/clauderic/dnd-kit/pull/672) [`10f6836`](https://github.com/clauderic/dnd-kit/commit/10f683631103b1d919f2fbca1177141b9369d2cf) Thanks [@clauderic](https://github.com/clauderic)! - The `measureDroppableContainers` method now properly respects the MeasuringStrategy defined on `` and will not measure containers while measuring is disabled. + +- [#656](https://github.com/clauderic/dnd-kit/pull/656) [`c1b3b5a`](https://github.com/clauderic/dnd-kit/commit/c1b3b5a0be5759b707e22c4e1b1236aaa82773a2) Thanks [@clauderic](https://github.com/clauderic)! - Fixed an issue with collision detection using stale rects. The `droppableRects` property has been added to the `CollisionDetection` interface. + + All built-in collision detection algorithms have been updated to get the rect for a given droppable container from `droppableRects` rather than from the `rect.current` ref: + + ```diff + - 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 the `droppableRects` 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](https://github.com/clauderic/dnd-kit/pull/742) [`7161f70`](https://github.com/clauderic/dnd-kit/commit/7161f702c9fe06f8dafa6449d48b918070ca46fb) Thanks [@clauderic](https://github.com/clauderic)! - Fallback to initial rect measured for the active draggable node if it unmounts during initialization (after `onDragStart` is dispatched). + +- [#749](https://github.com/clauderic/dnd-kit/pull/749) [`5811986`](https://github.com/clauderic/dnd-kit/commit/5811986e7544a5e80039870a015e38df805eaad1) Thanks [@clauderic](https://github.com/clauderic)! - The `Data` and `DataRef` types are now exported by `@dnd-kit/core`. + +- [#699](https://github.com/clauderic/dnd-kit/pull/699) [`e302bd4`](https://github.com/clauderic/dnd-kit/commit/e302bd4488bdfb6735c97ac42c1f4a0b1e8bfdf9) Thanks [@JuAn-Kang](https://github.com/JuAn-Kang)! - Export `DragOverlayProps` for consumers. + +- [#660](https://github.com/clauderic/dnd-kit/pull/660) [`e6e242c`](https://github.com/clauderic/dnd-kit/commit/e6e242cbc718ed687a26f5c622eeed4dbd6c2425) Thanks [@clauderic](https://github.com/clauderic)! - The `KeyboardSensor` was updated to use `scrollTo` instead of `scrollBy` when it is able to fully scroll to the new coordinates returned by the coordinate getter function. This resolves issues that can happen with `scrollBy` when called in rapid succession. + +- Updated dependencies [[`59ca82b`](https://github.com/clauderic/dnd-kit/commit/59ca82b9f228f34c7731ece87aef5d9633608b57), [`035021a`](https://github.com/clauderic/dnd-kit/commit/035021aac51161e2bf9715f087a6dd1b46647bfc)]: + - @dnd-kit/utilities@3.2.0 + ## 5.0.3 ### Patch Changes diff --git a/packages/core/package.json b/packages/core/package.json index 499153562..648aaecf8 100644 --- a/packages/core/package.json +++ b/packages/core/package.json @@ -1,6 +1,6 @@ { "name": "@dnd-kit/core", - "version": "5.0.3", + "version": "6.0.0", "description": "dnd kit – a lightweight React library for building performant and accessible drag and drop experiences", "author": "Claudéric Demers", "license": "MIT", @@ -32,7 +32,7 @@ "dependencies": { "tslib": "^2.0.0", "@dnd-kit/accessibility": "^3.0.0", - "@dnd-kit/utilities": "^3.1.0" + "@dnd-kit/utilities": "^3.2.0" }, "publishConfig": { "access": "public" diff --git a/packages/modifiers/CHANGELOG.md b/packages/modifiers/CHANGELOG.md index e7b4323cb..b46a114bd 100644 --- a/packages/modifiers/CHANGELOG.md +++ b/packages/modifiers/CHANGELOG.md @@ -1,5 +1,13 @@ # @dnd-kit/modifiers +## 6.0.0 + +### Patch Changes + +- Updated dependencies [[`4173087`](https://github.com/clauderic/dnd-kit/commit/417308704454c50f88ab305ab450a99bde5034b0), [`59ca82b`](https://github.com/clauderic/dnd-kit/commit/59ca82b9f228f34c7731ece87aef5d9633608b57), [`7161f70`](https://github.com/clauderic/dnd-kit/commit/7161f702c9fe06f8dafa6449d48b918070ca46fb), [`40707ce`](https://github.com/clauderic/dnd-kit/commit/40707ce6f388957203d6df4ccbeef460450ffd7d), [`a41e5b8`](https://github.com/clauderic/dnd-kit/commit/a41e5b8eff84f0528ffc8b3455b94b95ab60a4a9), [`a41e5b8`](https://github.com/clauderic/dnd-kit/commit/a41e5b8eff84f0528ffc8b3455b94b95ab60a4a9), [`a41e5b8`](https://github.com/clauderic/dnd-kit/commit/a41e5b8eff84f0528ffc8b3455b94b95ab60a4a9), [`035021a`](https://github.com/clauderic/dnd-kit/commit/035021aac51161e2bf9715f087a6dd1b46647bfc), [`77e3d44`](https://github.com/clauderic/dnd-kit/commit/77e3d44502383d2f9a9f9af014b053619b3e37b3), [`5811986`](https://github.com/clauderic/dnd-kit/commit/5811986e7544a5e80039870a015e38df805eaad1), [`e302bd4`](https://github.com/clauderic/dnd-kit/commit/e302bd4488bdfb6735c97ac42c1f4a0b1e8bfdf9), [`188a450`](https://github.com/clauderic/dnd-kit/commit/188a4507b99d8e8fdaa50bd26deb826c86608e18), [`59ca82b`](https://github.com/clauderic/dnd-kit/commit/59ca82b9f228f34c7731ece87aef5d9633608b57), [`5f3c700`](https://github.com/clauderic/dnd-kit/commit/5f3c7009698d15936fd20f30f11ad3b23cd7886f), [`035021a`](https://github.com/clauderic/dnd-kit/commit/035021aac51161e2bf9715f087a6dd1b46647bfc), [`e6e242c`](https://github.com/clauderic/dnd-kit/commit/e6e242cbc718ed687a26f5c622eeed4dbd6c2425), [`035021a`](https://github.com/clauderic/dnd-kit/commit/035021aac51161e2bf9715f087a6dd1b46647bfc), [`10f6836`](https://github.com/clauderic/dnd-kit/commit/10f683631103b1d919f2fbca1177141b9369d2cf), [`c1b3b5a`](https://github.com/clauderic/dnd-kit/commit/c1b3b5a0be5759b707e22c4e1b1236aaa82773a2), [`035021a`](https://github.com/clauderic/dnd-kit/commit/035021aac51161e2bf9715f087a6dd1b46647bfc)]: + - @dnd-kit/core@6.0.0 + - @dnd-kit/utilities@3.2.0 + ## 5.0.0 ### Minor Changes diff --git a/packages/modifiers/package.json b/packages/modifiers/package.json index d6cb7a877..7924eaff6 100644 --- a/packages/modifiers/package.json +++ b/packages/modifiers/package.json @@ -1,6 +1,6 @@ { "name": "@dnd-kit/modifiers", - "version": "5.0.0", + "version": "6.0.0", "description": "Translate modifier presets for use with `@dnd-kit` packages.", "author": "Claudéric Demers", "license": "MIT", @@ -26,14 +26,14 @@ "dist" ], "dependencies": { - "@dnd-kit/utilities": "^3.1.0", + "@dnd-kit/utilities": "^3.2.0", "tslib": "^2.0.0" }, "peerDependencies": { - "@dnd-kit/core": "^5.0.0" + "@dnd-kit/core": "^6.0.0" }, "devDependencies": { - "@dnd-kit/core": "^5.0.0" + "@dnd-kit/core": "^6.0.0" }, "publishConfig": { "access": "public" diff --git a/packages/sortable/CHANGELOG.md b/packages/sortable/CHANGELOG.md index c99840cf3..1943a4e72 100644 --- a/packages/sortable/CHANGELOG.md +++ b/packages/sortable/CHANGELOG.md @@ -1,5 +1,85 @@ # @dnd-kit/sortable +## 7.0.0 + +### Major Changes + +- [#660](https://github.com/clauderic/dnd-kit/pull/660) [`30bbd12`](https://github.com/clauderic/dnd-kit/commit/30bbd12f9606c2e99523cb9ece465041cb37e916) Thanks [@clauderic](https://github.com/clauderic)! - Changes to the default `sortableKeyboardCoordinates` KeyboardSensor coordinate getter. + + #### Better handling of variable sizes + + The default `sortableKeyboardCoordinates` function now has better handling of lists that have items of variable sizes. We recommend that consumers re-order lists `onDragOver` instead of `onDragEnd` when sorting lists of variable sizes via the keyboard for optimal compatibility. + + #### Better handling of overlapping droppables + + The default `sortableKeyboardCoordinates` function that is exported from the `@dnd-kit/sortable` package has been updated to better handle cases where the collision rectangle is overlapping droppable rectangles. For example, for `down` arrow key, the default function had logic that would only consider collisions against droppables that were below the `bottom` edge of the collision rect. This was problematic when the collision rect was overlapping droppable rects, because it meant that it's bottom edge was below the top edge of the droppable, and that resulted in that droppable being skipped. + + ```diff + - collisionRect.bottom > droppableRect.top + + collisionRect.top > droppableRect.top + ``` + + This change should be backwards compatible for most consumers, but may introduce regressions in some use-cases, especially for consumers that may have copied the multiple containers examples. There is now a custom sortable keyboard coordinate getter [optimized for multiple containers that you can refer to](https://github.com/clauderic/dnd-kit/tree/master/stories/2%20-%20Presets/Sortable/multipleContainersKeyboardCoordinates.ts). + +### Minor Changes + +- [#748](https://github.com/clauderic/dnd-kit/pull/748) [`59ca82b`](https://github.com/clauderic/dnd-kit/commit/59ca82b9f228f34c7731ece87aef5d9633608b57) Thanks [@clauderic](https://github.com/clauderic)! - #### Introducing activator node refs + + Introducing the concept of activator node refs for `useDraggable` and `useSortable`. 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` and `useSortable` may now optionally set the activator node ref on the element that receives listeners: + + ```diff + import {useDraggable} from '@dnd-kit/core'; + + function Draggable(props) { + const { + listeners, + setNodeRef, + + setActivatorNodeRef, + } = useDraggable({id: props.id}); + + return ( +
+ Draggable element + +
+ ) + } + ``` + + 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 of `useDraggble` and `useSortable`, @dnd-kit will automatically restore focus on the first focusable node of the draggable node set via the `setNodeRef` setter function of `useDraggable` and `useSortable`. + + If you were previously managing focus manually and would like to opt-out of automatic focus management, use the newly introduced `restoreFocus` property of the `accessibility` prop of ``: + + ```diff + =16.8.0", - "@dnd-kit/core": "^5.0.2" + "@dnd-kit/core": "^6.0.0" }, "devDependencies": { - "@dnd-kit/core": "^5.0.2" + "@dnd-kit/core": "^6.0.0" }, "publishConfig": { "access": "public" diff --git a/packages/utilities/CHANGELOG.md b/packages/utilities/CHANGELOG.md index 6a8a1f6f9..01d38bf30 100644 --- a/packages/utilities/CHANGELOG.md +++ b/packages/utilities/CHANGELOG.md @@ -1,5 +1,13 @@ # @dnd-kit/utilities +## 3.2.0 + +### Minor Changes + +- [#748](https://github.com/clauderic/dnd-kit/pull/748) [`59ca82b`](https://github.com/clauderic/dnd-kit/commit/59ca82b9f228f34c7731ece87aef5d9633608b57) Thanks [@clauderic](https://github.com/clauderic)! - Introduced the `findFirstFocusableNode` utility function that returns the first focusable node within a given HTMLElement, or the element itself if it is focusable. + +- [#733](https://github.com/clauderic/dnd-kit/pull/733) [`035021a`](https://github.com/clauderic/dnd-kit/commit/035021aac51161e2bf9715f087a6dd1b46647bfc) Thanks [@clauderic](https://github.com/clauderic)! - Introduced the `useEvent` hook based on [implementation breakdown in the RFC](https://github.com/reactjs/rfcs/blob/useevent/text/0000-useevent.md#internal-implementation). In the future, this hook will be used as a polyfill if the native React hook is unavailble. + ## 3.1.0 ### Minor Changes diff --git a/packages/utilities/package.json b/packages/utilities/package.json index cff7c823a..ac26f063b 100644 --- a/packages/utilities/package.json +++ b/packages/utilities/package.json @@ -1,6 +1,6 @@ { "name": "@dnd-kit/utilities", - "version": "3.1.0", + "version": "3.2.0", "description": "Internal utilities to bee shared between `@dnd-kit` packages", "author": "Claudéric Demers", "license": "MIT",