editron-wysiwyg-editor
v4.0.1
Published
WYSIWYG Editor for the Editron json-editor
Downloads
34
Readme
editron wysiwyg-editor
npm i editron-wysiwyg-editor --save
Setup
Add the bundled editor as a plugin
Use bundled versions of this editor
Add the editor after the core-modules and it will register automatically (paths depend on your build-setup)
<!-- dependencies for the wyswiwyg-editor -->
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/medium-editor/5.16.1/js/medium-editor.min.js"></script>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/medium-editor/5.16.1/css/medium-editor.min.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/medium-editor/5.16.1/css/themes/bootstrap.css">
<!-- styles -->
<link rel="stylesheet" href="../node_modules/editron-wysiwyg-editor/dist/editron-wysiwyg-editor.css">
<!-- plugin editor -->
<script type="text/javascript" src="../node_modules/editron/dist/editron-modules.js"></script>
<script type="text/javascript" src="../node_modules/editron/dist/editron-core.js"></script>
<script type="text/javascript" src="../node_modules/editron-wysiwyg-editor/dist/editron-wysiwyg-editor.js"></script>
Custom build the editor
bundle the editor with webpack
Javascript
To use this editor within a webpack build, require the editor and add it to the editors list
const { Controller } = require("editron");
const editronWysiwygEditor = require("editron-wysiwyg-editor");
const editors = [
editronWysiwygEditor
...otherEditors
];
const editron = new Controller(schema, data, { editors });
Add the required wysiwyg-dependencies to your page
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/medium-editor/5.16.1/js/medium-editor.min.js"></script>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/medium-editor/5.16.1/css/medium-editor.min.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/medium-editor/5.16.1/css/themes/bootstrap.css">
Validators
Optionally register the htmlValidator to editron
const editron = new Controller(schema, data);
editron.addValidator("format", "html", require("./wysiwygeditor/htmlValidator").validate);
Styles
Optionally import the custom wysiwyg-editor styles via sass
@import "editron-wysiwyg-editor/editron-wysiwyg-editor.scss";
or simply add the bundled css-file (path is depending on your build-setup)
<link rel="stylesheet" href="../node_modules/editron-wysiwyg-editor/dist/editron-wysiwyg-editor.css">
Schema
The editor will be added for a matching schema like
{
"type": "string",
"format": "html",
"options": {
"mediumEditor": {}
}
}