DblK/editorjs-toggle-block

Toggle block tool for EditorJS

EditorJS Toggle Block

Toggle block tool for Editor.js

Installation

Install via NPM

$ npm i --save-dev editorjs-toggle-block

Include module at your application

import ToggleBlock from 'editorjs-toggle-block';

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-toggle-block"></script>

Usage

Add a new tool to the tools property of the Editor.js initial config.

const editor = EditorJS({
  tools: {
    toggle: {
      class: ToggleBlock,
      inlineToolbar: true,
    },
  },
});

Shortcuts

1. Type the > character followed by Space to create a new toggle.
2. Type Shift + Tab to extract a nested block.
3. Type Tab to insert an existing block into a toggle.

Development

Development mode

$ npm run build:dev

Production release

1. Create a production bundle

   $ npm run build

2. Commit dist/bundle.js

Run tests

$ npm run test

Code 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