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 link tag in your HTML document <head> to load the Font Awesome icon set

<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.3.1/css/all.css" integrity="sha384-mzrmE5qonljUremFsqc01SB46JvROS7bZs3IO2EmfFsd15uHvIt+Y8vEf7N7fWAU" crossorigin="anonymous">

Add a data-tiny-editor attribute to the HTML element you want to transform into an editor

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 list
data-bold="no": remove the bold button
data-italic="no": : remove the italic button
data-underline="no": remove the underline button
data-fontname="no": remove the font drop down list
data-forecolor="no": : remove the text color button
data-justifyleft="no": remove the left align button
data-justifycenter="no": remove the center align button
data-justifyright="no": remove the right align button
data-insertorderedlist="no": remove the numbered list button
data-insertunorderedlist="no": remove the bulleted list button
data-outdent="no": remove the decrease indent button
data-indent="no": remove the increase indent button
data-remove-format="no": remove the clear formatting button

Supported browsers

Modern browser (Chrome, Firefox, Edge,...) are supported. Tiny Editor doesn't work on Internet Explorer.

stepanvanzuriak / tiny-editor