• All packages now have verified ESM support
• Packages expose CJS/ESM surface are via pkg.exports

This release uses output from swc using the 'es2017' target instead of using output from 'tsc' using the 'ESNext' target.

This release fixes issues with the ESM-only structure of v15.0.0. All packages are now in their prior CommonJS/ESM format.

Major Changes

• The react-dnd packages are now published as ESM-only with type: module. See this FAQ by sindresorhus: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c

• The Decorators API has been removed and fully replaced by the Hooks API. The Decorators API was difficult to develop & type correctly, and this improves its maintainability.

• The builds no longer use babel & preset-env. The library is transpiled using SWC into the "es2017" target, which assumes async/await is available. This should reduce bundle sizes by removing polyfills and support-code which may be unnecessary in your target.

Bugfixes

• Improve data-transfer acquisition from File inputs (#3262)
• Don't set the 'draggable' attribute unless canDrag is true (#3187)
• Improve typings of DropTargetMonitor, DragLayerMonitor (#3300, #3341)

Updated

react-dnd: 14.0.3 react-dnd-html5-backend: 14.0.1 react-dnd-touch-backend: 14.1.0

Patch Updates

• Fix drop operations in iframes & child windows (#3181) (thanks @eramdam!)
• Refactor TouchBackend OptionsReader (#3291)
• Cleanup connected DOM elements from react-dnd internals when hook-based components unmount (#3290)
• Fix issue where custom drag-sources where triggering native drops in Firefox (#3272) (thanks @istateside)

Patch

This PR will throw a developer exception if a user specifies a useDrag::spec.begin method.

Patch

Update internal hook useDragType() to align with updated typings. Check 14.0.0 release for API changes

This release addresses a handful of nagging liveness and ergonomic issues with the hooks API.

The liveness issues affect all hooks, and were discovered on deeper inspection of certain stress tests in the documentation. The internal useCollector() hook is used to collect props from the DnD system when things change. Prior to this update, we subscribed to updates from the DnD monitor to trigger prop collection. However, state on the react side was only accounted for on the first render. This release improves that liveness by collecting props whenever react state changes.

The ergonomics of the useDrag have been refactored. In short:

• spec.type is required
• spec.item can be a function or static object.
• The function version of spec.item replaces spec.begin

Since the release of the hooks API, we packed type under spec.item. However, this led to nonintuitive situations where an item field was required to be specified even though items are created in the begin method.

Additionally, in the original React-DnD design, beginDrag() was optional and the type of the draggables had to be defined. If no explicit DragObject was created, an implicit object was created by the system..

The change we've made here decouples type from item, and collapses begin into item.

// Pre-v14
useDrag({
   // item defined here to get a type
   item: { type: BOX } },
   // ...but the actual item is created here
   begin: () => ({ id })
})

// v14
useDrag({
   type: BOX,
   item: () => ({id})
})

e.g. useDrag({ item: { type: BOX }}) => useDrag({ type: 'BOX' })

We've also added the ability to cancel drag operations in the hooks API by returning null from begin.

// new API
useDrag({
  type: BOX,
  item: () => shouldNotDrag ? null : {id},
})

react-dnd

Patch

• Re-register drag sources in hooks API when item.type changes
• Export missing typings

react-dnd-html5-backend

Patch

• Export HTML5Context, HTML5BackendOptions interfaces

react-dnd

TLDR: useDrag and useDrop support both a memo pattern and a spec object now.

useDrag(() => spec) // good
useDrag(spec) // also good

In v13, we've tried to address some errors that were pervading with the react-dnd hooks API. Generally, making sure DragSource/DropTargets were up-to-date and that the system wasn't leaking handles was a precarious balancing act. Moving to a memo API pattern (e.g. useDrag(() => spec)) fixed this problem in our tests.

However, as we dug further into handler leakage issues, it became clear that anything using the hooks would reattach and receive a new handler ID whenever the spec changed at all. This was in contrast to the Decorator API's behavior of keeping stable handler IDs as the incoming props changed.

To fix the Hooks API to stop leaking handlers, we found a pretty simple solution: a classical class with a public setter for the spec object that's updated via a useEffect hook. This neatly avoids the mutating DragSource/DropTargets on every spec change. This had two effects: identifiers have been stabilized, and spec objects were usable again because changing them didn't cause DragSource/DropTarget instances to be regenerated and reattached.

In retrospect, this undoes the necessity of the major cut that happened with v13, but the Hooks API is much sturdier now. We hope that you find the improved memory stability in the hooks API to be useful in your projects.

Patch Updates

• Add invariant() invocations in useDrag, useDrop to verify that spec functions are used instead of objects
• Fix handler registration memory leak issue with useDrag, useDrop

React-DnD v13, Others v12

v12 was largely structural and organizational, but some issues were discovered shortly after release that warranted changing the hooks API.

Breaking Changes

• useDrag, useDrop hooks accept functions that create spec objects instead of spec objects directly. Clients can think about the API to useDrag() and useDrop() as being analogous to useMemo(). This allows clients to have direct control over when their DnD specifications are re-generated (which internally reattaches them to the DnD system).
• Use jsx-factory throughout the library

Non-Breaking Changes

• Add HTML native draggable type to HTML5Backend (see new example)
• Clients can specify a rootElement component in the HTML5Backend options to localize where DnD will process events in the client app.
• react-dnd-test-utils has improved support for testing with HTML5Backend and using @testing-library/react to simulate drag-and-drop sequences.

Patch

Update .npmignore files so that tsbuildinfo files are not included in publication. This reduces package sizes.

Minor

• Add getDecoratedComponent() method to wrapInTestContext imperative API. (#2488)

Patch

• Improve typings of wrapInTestContext(#2486)
• Eliminate module cycles in react-dnd (#2491)

Breaking Changes

Update Backends to use named exports for BackendFactory functions instead of default exports.

e.g. import HTML5Backend from 'react-dnd-html5-backend 👇 import { HTML5Backend } from 'react-dnd-html5-backend

In general, throughout the app we've minimized the usage of default exports as well. They interfere with type correctness and screw with UMD builds (e.g. having to scrape a .default property off of a UMD global).

Minor Changes

• Expose internal hook useDragDropManager at top level
• Add profiling function to backend interface
• Make handler functions public on backends

Patch Changes

• Correct memory leak in drag previews (#2423)
• Improve and correct typings

Patch

dnd-core: Use updated version @react-dnd/asap with browser variant support, this allows us to drop syntheticDefaultImports in dnd-core.

Patch

Fix UMD builds - our fork of ASAP was being brought in with node-specific code, breaking UMD builds. Using the canonical version of ASAP until we update our fork (#1684 )

Major

The package.type=module setting has been removed. This proved to be a major pain point for users, and was technically problematic at this time. We will eventually ship with package.type=module when NodeJS 12 drops out of maintenance and all of our dependencies ship ESM. (#1683)

Patch

The touch-backend has been updated to work-around iOS 13.x eventing issues (#1631) (thanks @zhusee2!)

Patch

• Remove syntheticDefaultImport usage of react in react-dnd (#1629) thanks @sandersn . Fully removing syntheticDefaultImport from react-dnd is a WIP. We will need pure ESM versions of asap and hoist-non-react-statics. Ideally invariant and shallowequal would have ESM builds available as well, but there are forked ESM variants of these packages.

Minor Changes

• Declare packages side-effect free for tree-shaking (#1577), thanks @maclockard
• HTML5Backend: Make file metadata available on dragstart event (#1610), thanks @LeopoldLerch
• TestBackend: Add DragDropManager accessor to TestBackend (#1564), thanks @ezr-ondrej

Patch Changes

• Improve UMD builds to conform to browserslist support target, add some basic UMD verification tests

Minor

• UMD builds are now shipped with the react-dnd, react-dnd-html5-backend, and react-dnd-touch-backend packages in addition to react-dnd-umd-builds

Patch

• Added refcounting to the DndProvider component. If the DndProvider is unmounted, the manager instance will be cleared out of the global context.

Patch

• (Typings) - Add getTargetIds to DragSourceMonitor interface declaration (#1478)
• Replace for..of statements with other looping semantics for older browser support (#1428
• Add an isomorphic useLayoutEffect implementation for SSR (#1497)
• Correct DragPreview connection logic for chainable connector functions (#1500)

Patch

• Fixed some issues in react-dnd where named exports of interfaces were causing JS breakage (#1462)
• Added a cra-test package to verify that react-dnd can be used in the context of create-react-app by default (#1462)

Libraries Affected

All libraries

Minor

• Add CJS builds to the core packages in order to facilitate better testing. (#1455, #1460)

Patch

• Correct some issues with interface imports/exports using Babel's TS transpilation (#1459)

Libraries

• react-dnd
• react-dnd-cjs
• react-dnd-test-utils
• react-dnd-test-utils-cjs
• react-dnd-umd-builds

Patch

• Redefine XYCoord interface in react-dnd interfaces (#1454)

Libraries

All Libraries Affected

Minor

The react-dnd toolchain has been changed up from using TypeScript to using Babel. This allows us to use a ‘browserlist’ query instead of a coarse tsc target when defining what JS features to ship with. The public API has not changed at all, but there could be underlying changes if your code is implementation dependent.

Patch

• Correct an issue where drag previews were disconnected if the dragSource changed (#1441)

Major

• Remove DragDropContext decorator. (#1439)
• Update BackendFactory function in dnd-core to accept a configuration object. (#1439)
• Construct the Backend outside of the DragDropManagerImpl class (#1439)

Minor

• Add react-dnd-touch-backend library
• Update DndProvider to accept an 'options' prop with backend configuration
• Correct state staleness issues when using hooks-based API (#1429, #1437)

Patch

• Prevent starting a react-dnd drag operation if a dragstart event has it's default-prevented (#1426)

Bugfixes

• The DndProvider component had been throwing errors if it was rendered multiple times because of the implicit singleton invariant of the HTML5Backend. To correct this, if a backend factory is passed to the DndProvider using <DndProvider backend={HTML5Backend}/>, it will only create a singleton instance of the DndContext per global context. This means that to create a second backend for an iframe, one needs to use: <DndProvider backend={HTML5Backend} context={iframeWindow} />.

Patch

The CommonJS libraries had runtime issues due to some @ts-ignore statements on non-typed module imports. Those have been removed from the core libraries.

Major

• ES Modules. The target output of TypeScript has been changed to esnext with esnext modules. This speeds up and simplifies our build process, and targets the future with modern web standards. The UMD builds have been moved to a new 'react-dnd-umd-builds' package. CommonJS builds have been removed.
• Polyfills: Legacy polyfills have been removed. At this point, that's just String.endsWith
• DragDropContextProvider:
  • ~DragDragDropContextProvider~ => DndProvider
  • ~DragDropContext, DragDropContextConsumer, and DragDropContextProvider~ => DndContext.

The package.json files for the react-dnd libraries contained a "module" field which was used to identify where the ES Module roots began. These fields were added with the intent of supporting CommonJS module loading (the de-facto NodeJS module system) simultaneously with the ES Module loading system (the emerging standard for JavaScript modules).

Unfortunately this change resulted in a lot of build headaches for users then their module bundlers started defaulting to using the ES Module roots.

This release reverts that change and leaves the v7 branch of React-Dnd as primarily using CommonJS. ES Module builds are still available under the esm/ folders, but it is up to users to use them at their own discretion.

In v8, ES Modules are used as the default module system. CommonJS-based packages are still available however in react-dnd-cjs, and react-dnd-html5-backend-cjs

• Release the Hooks API (#1381) (a5b0242), closes #1381
• v7.6.0 (c08efd5)
• chore: replace tslint with eslint (#1380) (fc44aee), closes #1380
• fix: add memoization to hooks example to improve performance (497afda)
• fix: documentation fixes (6630373)
• fix: improve performance in the sortable stress test example (a1584d9)

Minor

• Allow DragDropContextProvider to accept a manager prop (#1362)

Patch

• Improve performance of backend subscriptions (#1355, related)
• Handle cases where a DragDropRegistry may return an undefined dropResult. (#1281)
• Correct function-state issues with hooks-based APIs.

• Replace some remaining lodash imports with our internal replacements.
• Check for null cases in the DragSourceMonitor and DropTargetMonitor to handle situations where clients may be using older versions of dnd-core.

• Replace lodash with custom functions
• Correct issue where getDecoratedComponentInstance() would throw invariant errors when used internally
• Add String.endsWith polyfill for semver compat
• Improve decorator API typings (#1306)

Patch

Fixes an issue when using function components utilizing React.forwardRef as DragSource/DropTargets. The React-DnD wrapper class was being passed as the ref instance to hover instead of the decorated component instance.

Patch

• Fixed an issue where refs were being attached to function components via the DragLayer and DragDropContext.
• Fixed an issue where ref-forwarded function function components were not having refs attached to them.
• Updated the invariant messages regarding ref attachment to indicate that clients can either use a React Class component or React.forwardRef() to get instance handles.

Minor

• Add a third argument to the collector functions in DragSource and DropTarget that includes the props of the current component. (e.g. collect(connect, monitor, props)
• Connect functions can now accept Ref objects. (e.g. connectDragSource(ref))
• Add a new DragPreviewImage renderless component that wires up Drag Preview images.
• Improve decorated types to include as much of the original types as we can. Our typing strategy for this followed the same pattern that react-redux uses.
• Add react-dnd-test-utils package, which exposes the wrapInTestContext utility function

Patch

• Throw invariant errors when components are rendered outside of a DragDropContext.
• Hooks API updates

#1265 - Update ConnectDragSource/ConnectDropTarget typings to include null and Element consistently. #1266 - Update the experimental hooks API dragSource specification so that begin may return a dragObject.

Updates to the non-stable, hooks-based API.

• Add useDragPreview hook.

  • accepts a refForwarding component and returns an array with a component in slot zero that renders the component into a detached portal, and a ref in slot 1 that may be used in the dragSpec.

• useDrag

  • the begin() function is now optional, and returns void.
  • the first argument of end() is the DragResult
  • the type property has been removed
  • add a required item property, which must contain a type field
  • make the ref field optional, if this is not set, then one will be created.
  • returns an array: collected props in slot zero and the ref being used in slot 1

• useDrop

  • the type property has been renamed accept
  • the drop, hover and canDrop functions now take the DragItem as the first argument.
  • make the ref field optional, if this is not set, then one will be created.
  • returns an array: collected props in slot zero and the ref being used in slot 1

Minor Changes

• Add DragDropContextConsumer to the top-level react-dnd export (#1260)

Patch Changes

• Hooks API updates, add experimental flag to documentation to use hooks-based examples

This patch release puts the experimental hooks API behind an annoying import so that it's clear to users that this API should not be used in production yet.

import { __EXPERIMENTAL_DND_HOOKS_THAT_MAY_CHANGE_AND_BREAK_MY_BUILD__ } from 'react-dnd'

const { useDrag, useDrop } = __EXPERIMENTAL_DND_HOOKS_THAT_MAY_CHANGE_AND_BREAK_MY_BUILD__
...

• [patch] - #1249 - Check for uninitialized source/target identifiers

• [patch] - #1250 - Use ES5 target for CommonJs builds.

• [minor] - #1251, #1244, #1173 - Experimental Hooks API

This release includes an experimental hook-based React-Dnd API. Documentation for this feature still needs to be created, but the three public facing hooks are: useDragSource, useDropTarget, and useDragLayer.

The hooks API will is currently experimental, and breaking changes of hooks may occur in non-major versions.

• useDragSource:

const ref = useRef(); // pass in a ref instead of connectDragSource()
const { isDragging } = useDragSource(ref, ItemTypes.KNIGHT, {
    beginDrag(monitor){ /* */ },
    // collect function defined in specification
    collect: monitor => ({
        isDragging: monitor.isDragging(),
    }),
})
return <div ref={ref}>...</div>

• useDropTarget:

const ref = useRef(); // pass in a ref instead of connectDropTarget()
const { isOver, canDrop } = useDropTarget(ref, ItemTypes.KNIGHT, {
    canDrop: () => canMoveKnight(props.x, props.y),
    drop: () => moveKnight(props.x, props.y),
    // collect function defined in specification
    collect: monitor => ({
        isOver: monitor.isOver(),
        canDrop: monitor.canDrop(),
    }),
})

return <div ref={ref}>...</div>

• useDragLayer

const props = useDragLayer(monitor => ({
    item: monitor.getItem(),
    itemType: monitor.getItemType(),
    initialOffset: monitor.getInitialSourceClientOffset(),
    currentOffset: monitor.getSourceClientOffset(),
    isDragging: monitor.isDragging(),
}))

• Add EsModule builds in addition to CommonJS builds (#1205)
• Remove the dropEffect=none setting on native DnD events (#1240)
• Expose dataTransfer.items for files (#1241)
• Correct child mounting order (#1220)
• Refresh Dependencies (#1243)
• Eliminate errors when using Ref objects (#1242)

License Update The library was originally licensed as MIT, but during the transition to a Monorepo, the license was set to BSD 3-Clause. This release corrects that error and restores the MIT license across all packages.

• Add 'debugMode' option to DndContext (#1190) (572955b), closes #1190
• fix typo in Tutorial (#1169) (46fd5ae), closes #1169
• Fixed the typo in functional component example link (#1180) (e4722ff), closes #1180
• Update naive.md (#1168) (3a5e0d4), closes #1168
• Update README.md (c0e6cf5)
• v7.0.0 (f294f68)
• fix: clientOffset and initialClientOffset are null in canDrag #1175 (#1176) (8718ae5), closes #1175 #1176
• fix: make DecoratedComponent as static property (#1177) (#1185) (95d90b3), closes #1177 #1185
• fix: remove initClientOffset action - merge it into initCoords (#1191) (6b58b8b), closes #1191
• docs: fix examples page URL (#1181) (#1183) (6430c45), closes #1181 #1183 #1181
• docs: fix link in root page (#1189) (ffda6c7), closes #1189
• build: upgrade npm-run-all for security (#1186) (c025cd7), closes #1186
• ci: upgrade har-vlidator to fix CI corrupt (#1184) (478f5b5), closes #1184
• chore: add stalebot config (6f451ee)

• [Major] - Improve typings for DragSource, DropTarget and DragLayer decorator functions. This required dropping support of TypeScript decorators in our examples, and may cause breaking changes for TypeScript users. The core issue is that Typescript decorator results need to be assignable to the incoming type. We want to be able to explicitly remove DnD-collected props from the resultant component type. Our old way of dealing with this was to make DnD-collected props optional in our props interfaces, which resulted in unnecessary null-checks in render, and a leaky client interface. (#1134)
• [Patch] - In the beginDrag action, since publishSource defaults to true when no argument is passed, use a default initializer when an object is entered that does not specify it (#1161)
• [Patch] - Replace use of autobind-decorator library with class bind semantics, which eliminates that dependency.
• [Patch] - Fire off an initCoords event before dragStart to improve client offset-calculation logic.(#1082)
• [Patch] - Update the EnterLeaveCounter in HTML5Backend to use the configured window object. This corrects behavior in iframe environments (#1137)
• [Patch] - Correct an error where an incorrect dropEffect was being used when in a scrolling container (#1131)
• [Patch] - Library upgrades, documentation updates

• Restore support for react Stateless Functional Components.
• Audit the generic parameters for the top-level API to minimize how many clients should have to specify