@taufik-nurrohman/rich-text-editor
v1.3.1
Published
A rich text editor that is designed to accept limited set of inline HTML tags only.
Downloads
3
Maintainers
taufik-nurrohmanReadme
Rich Text Editor
A rich text editor that is designed to accept limited set of inline HTML tags only.
This rich text editor works best on any form that are accessible in the public such as comment form in a blog, chat form in a social media and question or answer form in a forum.
Usage
<!DOCTYPE html>
<html dir="ltr">
<head>
<meta charset="utf-8">
<title>Demo</title>
<link href="rich-text-editor.min.css" rel="stylesheet">
</head>
<body>
<textarea></textarea>
<script src="rich-text-editor.min.js"></script>
<script>
var editor = new RTE(document.querySelector('textarea'));
</script>
</body>
</html>Options
var editor = new RTE(source, config);Variable | Description
-------- | -----------
source | The text area element.
config | The configuration data. See below!
config = {
classes: ['rich-text-editor'],
tools: ['b', 'i', 'u', 'a', 'x'], // visible tool(s)
tags: [ // allowed HTML tag(s)
'a',
'abbr',
'b',
'br',
'code',
'dfn',
'del',
'em',
'i',
'ins',
'kbd',
'mark',
'p',
'span',
'strong',
'u',
'var'
],
attributes: [ // allowed HTML attribute(s)
'class',
'data-[\\w-]+?',
'href',
'id',
'rel',
'style',
'target',
'title'
],
text: {
b: ['Bold', 'B', '⌘+B'],
i: ['Italic', 'I', '⌘+I'],
u: ['Underline', 'U', '⌘+U'],
a: ['Link', 'A', '⌘+L'],
x: ['Source', '⋯', '⌘+⇧+X']
},
tidy: true, // tidy HTML output?
enter: true, // set to `false` to automatically submit the closest form on enter key press
x: function(e, node) {}, // on mode change (view/source); set to `false` to disable the source view
update: function(e, node) {} // on view/source update
};Note: All block tags are not allowed except
<p>tags without attributes.
Methods
Interactions
editor.focus();
editor.focus(0); // focus start
editor.focus(1); // focus end
editor.focus(true); // select all
editor.blur();
editor.enable();
editor.disable();
editor.create();
editor.destroy();Properties
editor.lot; // selection storage [source, view]
editor.config; // editor configuration
editor.container; // editor container
editor.view; // editor view
editor.source; // editor source
editor.tools; // editor tools
editor.dialog; // editor dialogSet Value
editor.set('Lorem ipsum dolor sit amet.');Get Value
console.log(editor.get());Save Selection
var s = editor.s();Restore Selection
editor.r(s);Get Selection
editor.v(); // as plain text
editor.v(true); // as HTML
editor.v(true, false); // as original selected HTML value in `editor.view`
editor.v(true, true, false); // as HTML and remove the wrapping `<p>` tagWrap Selection with HTML Element
editor.w('strong'); // toggle wrap/unwrap `<strong>` tag
editor.w('strong', 1); // force wrap `<strong>` tag
editor.w('strong', 0); // force unwrap `<strong>` tagWrap selection with HTML element and add attributes on that element:
var e = editor.w('a');
e.href = 'http://example.com';
e.rel = 'nofollow';
e.target = '_blank';Collapse Selection
editor.c(0); // collapse to the start of the selection
editor.c(1); // collapse to the end of the selectionInsert HTML at Caret/Selection
editor.i('<img arc="file.png">', true); // select the inserted HTML
editor.i('<img arc="file.png">', 0); // put caret after the inserted HTML (insert before caret)
editor.i('<img arc="file.png">', 1); // put caret before the inserted HTML (insert after caret)Get Selected HTML Node
editor.e(); // return list of nodes in the current selection
editor.e('a'); // check if the selected text is an `<a>` tagSanitize HTML
editor.f('foo bar <b>baz</b> <span>qux</span>');Get Selection as Node
console.log(editor.n());Create Selection Range
Create selection range from A node to B node.
var p = editor.view.querySelectorAll('p');
editor.m([p[0], p.pop()]);Tool State
if (editor.is.e('strong')) {
// caret was selecting a `<strong>` tag or is placed in a `<strong>` tag
}Tool
Create
// id: the tool ID
// text: array of [title, content, description]
// fn: the function that will be triggered on click
// i: tool index from the current tool list (if not defined, tool will be put at the end of the list)
//
// editor.t(id, text, fn, i);Create a bold button:
editor.t('b', ['Bold', '<b>B</b>', 'Ctrl+B'], function(e, node) { … });Dialog
Create
// fn(e, input);
editor.d(placeholder, value, fn);Show
editor.d.v();editor.d.v(true); // save previous selectionHide
editor.d.x();editor.d.x(true); // restore previous selectioneditor.d.x(true, true); // ignore the error, exit anywayState
Check whether these elements are visible at the time:
editor.is.view; // the rich text editor view
editor.is.source; // the HTML source view
editor.is.dialog; // the dialog vieweditor.is.focus; // check if cursor is active in the view
editor.is.blur; // check if cursor is not active in the view
editor.is.error; // check if there was an error