Skip to content

Latest commit

 

History

History
74 lines (49 loc) · 2.65 KB

installation.md

File metadata and controls

74 lines (49 loc) · 2.65 KB
Raw

Installation

module formats: umd, cjs, and esm

General

  1. Add the @hello-pangea/dnd package
# npm
npm install @hello-pangea/dnd --save

# pnpm
pnpm add @hello-pangea/dnd

# yarn
yarn add @hello-pangea/dnd
  1. Use the package
import { DragDropContext } from '@hello-pangea/dnd';
  1. Profit 🕺

React environment

In order to use @hello-pangea/dnd you will probably want to have a React environment set up.

Distribution bundle

A universal module definition bundle is published on npm under the /dist folder for consumption . We publish the following files:

  • dist/dnd.js
  • dist/dnd.min.js (minified bundle)

These bundles list react as an external which needs to be provided. This is done to reduce the size of the bundle and prevent consumers from loading react multiple times. You can provide react through your module system or simply by having react on the window.

You can use the UMD to run @hello-pangea/dnd directly in the browser.

<!-- peer dependency -->
<script src="https://unpkg.com/react@16.3.1/umd/react.development.js"></script>
<!-- lib (change x.x.x for the version you would like) -->
<script src="https://unpkg.com/@hello-pangea/dnd@x.x.x/dist/dnd.js"></script>
<!-- needed to mount your react app -->
<script src="https://unpkg.com/react-dom@16.3.1/umd/react-dom.development.js"></script>

<script>
  const React = window.React;
  const ReactDOM = window.ReactDOM;
  const { DragDropContext, Draggable, Droppable } = window.ReactBeautifulDnd;

  function App() {
    // ...
  }

  // You can use JSX if your environment supports it
  ReactDOM.render(React.createElement(App), document.getElementById('app'));
</script>

There is also an example codepen you can use to play with this installation method.

ClojureScript

You can consume @hello-pangea/dnd from within ClojureScript using CLJSJS!

← Back to documentation