kommittersEditorJS Drag/Drop Plugin
Drag/Drop feature for Editor.js.
Installation
Install via NPM
Get the package
$ npm i --save-dev editorjs-drag-dropInclude module at your application
import DragDrop from "editorjs-drag-drop";Load from CDN
You can load a specific version of the package from jsDelivr CDN.
Require this script on a page with Editor.js.
<script src="https://cdn.jsdelivr.net/npm/editorjs-drag-drop"></script>Usage
Add the plugin to the onReady property of the Editor.js configuration to initialize it:
const editor = new EditorJS({
onReady: () => {
new DragDrop(editor);
},
});You can customize the indicator border style by passing a second parameter to the plugin constructor:
const editor = new EditorJS({
onReady: () => {
new DragDrop(editor, "2px solid #fff");
},
});If no parameter is provided, the default border style 1px dashed #aaa is used.
Select the block, drag the toolbar settings button, and drop it at the desired position.
Integration with editorjs-undo
If you're already using editorjs-undo, your code might look like this:
const editor = new EditorJS({
onReady: () => {
new Undo({ editor });
new DragDrop(editor);
},
});Usage with React.
If you are using React, you could create a function to handle the onReady property, the function will store the DragDrop instance. Then, you must call the function in onReady in the editorJS instance.
const handleReady = (editor) => {
new DragDrop(editor);
};
class ReactEditor extends Component {
render() {
return (
<EditorJs
onReady = { handleReady }
tools = { ... }
/>
)
}
}Note: If you are also using editorjs-undo your handleReady function must have the editorjs-undo instance as well.
const handleReady = (editor) => {
new Undo({ editor });
new DragDrop(editor);
};Usage with react-editor-js.
If you are using react-editor-js, you should use the 'onInitialize' prop in the ReactEditorJS component to obtain the abstract editorjs as follow:
........
export const ReactEditor = () => {
const editorCore = React.useRef(null)
const handleInitialize = React.useCallback((instance) => {
editorCore.current = instance
}, [])
const handleReady = () => {
const editor = editorCore.current._editorJS;
new Undo({ editor })
new DragDrop(editor);
};
const ReactEditorJS = createReactEditorJS()
return(
<ReactEditorJS
onInitialize={handleInitialize}
onReady = {handleReady}
tools={....}
defaultValue={....}
/>
)
}Development
Development mode
$ yarn build:devProduction release
- Create a production bundle
$ yarn build- Commit
dist/bundle.js
Run tests
$ yarn testCode of conduct
We welcome everyone to contribute. Make sure you have read the CODE_OF_CONDUCT before.
Contributing
For information on how to contribute, please refer to our CONTRIBUTING guide.
Changelog
Features and bug fixes are listed in the CHANGELOG file.
License
This library is licensed under an MIT license. See LICENSE for details.
Acknowledgements
Made with 💙 by kommitters Open Source