A utility to parse editorjs clean data to HTML.
-
Browser - Get /build/edjsHTML.browser.js
-
Nodejs - Get /build/edjsHTML.node.js
-
For Both Browser & Node - Get /build/edjsHTML.js
npm install editorjs-html-revised
const edjsParser = edjsHTML();
let html = edjsParser.parse(editorjs_clean_data);
console.log(html);
const edjsHTML = require("editorjs-html-revised");
const edjsParser = edjsHTML();
const html = edjsParser.parse(editorjs_clean_data);
console.log(html);
See Releases
- Header (H1-H6)
- Lists (Ordered & Unordered)
- Images
- Delimiter
- Paragraph
- Quote
const edjsParser = edjsHTML();
const HTML = edjsParser.parse(editorjs_data);
// returns array of html strings per block
console.log(HTML);
const edjsParser = edjsHTML();
const blockHTML = edjsParser.parseBlock(editorjs_clean_data_block);
// returns string of html for this block
console.log(blockHTML);
editorjs-html
supports extending its functionality to render custom editorjs blocks. Moroever, You can even override these basic supported blocks.
-
The
edjsHTML()
accepts an optional object that would allow you to extend its functionality. -
The name of the function must match with editor-js custom block type.
// Your custom editorjs generated block
{
type: "custom",
data: {
text: "Hello World"
}
}
// Parse this block in editorjs-html
function customParser(block){
return `<custom-tag> ${block.data.text} </custom-tag>`;
}
const edjsParser = edjsHTML({custom: customParser});
[Update] From v2.0.0 onwards, the parser functions recieves full block
instead of just data
property of the block. Read releases for more information.
Create an issue or send a PR for any contributions you would like to make.
I am thankful for everyone who has contributed their own bits to the repository. Even though the library is small and the scope for writing new or lots of features is limited. I still grateful to see a lots of contributions coming in.
I would love to have your feedback and any suggestions. You can also let me know, if you need support for any more editorjs blocks.
If you find this helpful, consider giving this repository a Star. You can also buy me a coffee here
MIT Public License