tiny-editor
v0.5.0
Published
A tiny HTML rich text editor written in vanilla JavaScript
Downloads
1,314
Maintainers
Readme
tiny-editor
A tiny HTML rich text editor written in vanilla JavaScript
Goal
Create a less than 5 Kb (compressed) library that enables a HTML element to be used as a rich text editor in plain old vanilla JavaScript.
Support
If you use and like this library, feel free to support my Open Source projects.
How to install
npm install tiny-editor
or load the bundle file directly at the end of your HTML document.
<script src="https://unpkg.com/tiny-editor/dist/bundle.js"></script>
How to use
- Reference the editor library in your HTML document
- Add a
data-tiny-editor
attribute to the HTML element you want to transform into an editor
How to dynamically create an editor
Use the exported function window.__tinyEditor.transformToEditor()
which take as the first argument the DOM element (usually a <div>
) that you want to transform to an editor. Refer to the /public/index.html
for an example.
How to extract the formatted text
Listen for the input
event on the editor HTML element.
document
.querySelectorAll('[data-tiny-editor]')
.forEach(editor =>
editor.addEventListener('input', e => console.log(e.target.innerHTML)
)
);
How to customize
There are various options that can be used to customize how the Tiny Editor will be rendered. By default, every options are enabled. You can disable an option using data attributes.
For example, you can remove the bold format button using the following attribute:
<div data-tiny-editor data-bold="no"></div>
Options
data-formatblock="no"
: remove the styles drop down listdata-bold="no"
: remove the bold buttondata-italic="no"
: : remove the italic buttondata-underline="no"
: remove the underline buttondata-fontname="no"
: remove the font drop down listdata-forecolor="no"
: : remove the text color buttondata-justifyleft="no"
: remove the left align buttondata-justifycenter="no"
: remove the center align buttondata-justifyright="no"
: remove the right align buttondata-insertorderedlist="no"
: remove the numbered list buttondata-insertunorderedlist="no"
: remove the bulleted list buttondata-outdent="no"
: remove the decrease indent buttondata-indent="no"
: remove the increase indent buttondata-remove-format="no"
: remove the clear formatting buttondata-autofocus="no"
: remove autofocus from the editor
Supported browsers
Modern browser (Chrome, Firefox, Edge,...) are supported. Tiny Editor doesn't work on Internet Explorer.