EditorJS Toggle Block

!stability-alpha

Toggle block tool for Editor.js


Installation

$3

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

Include module at your application

`js
import ToggleBlock from 'editorjs-toggle-block';
`

$3

You can load a specific version of the package from jsDelivr CDN.

Require this script on a page with Editor.js.

`html

`

Usage

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

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

$3

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

$3

`shell
$ npm run build:dev
`

$3

To test the functionality of the plugin, you can use the provided playground:

1. Navigate to the playground folder in the project directory.
2. Open the index.html file in your web browser.
3. Experiment the plugin's behavior.

$3

1. Create a production bundle
`shell
$ npm run build
`
2. Commit dist/bundle.js

$3

`shell
$ npm run test
``

Code of conduct

We welcome everyone to contribute. Make sure you have read the [CODE_OF_CONDUCT][coc] before.

Contributing

For information on how to contribute, please refer to our [CONTRIBUTING][contributing] guide.

Changelog

Features and bug fixes are listed in the [CHANGELOG][changelog] file.

License

This library is licensed under an MIT license. See [LICENSE][license] for details.

Acknowledgements

Made with 💙 by kommitters Open Source

[license]: https://github.com/kommitters/editorjs-toggle-block/blob/main/LICENSE
[coc]: https://github.com/kommitters/editorjs-toggle-block/blob/main/CODE_OF_CONDUCT.md
[changelog]: https://github.com/kommitters/editorjs-toggle-block/blob/main/CHANGELOG.md
[contributing]: https://github.com/kommitters/editorjs-toggle-block/blob/main/CONTRIBUTING.md