@itsumma/textarena

Textarena is a simple WYSIWYG (What You See Is What You Get) pluggable editor for rich media stories.

Usage no npm install needed!

<script type="module">
  import itsummaTextarena from 'https://cdn.skypack.dev/@itsumma/textarena';
</script>

README

Textarena

Build

Textarena is a simple WYSIWYG (What You See Is What You Get) pluggable editor for rich media stories.

Key featuresGetting startedPluginsDemoRelated

Preview

Key features

There are a few key features:

To learn how to install and use Textarena, view Getting started.

Block elements

In some other editors, the workspace is represented by a single contenteditable element in which you can create various HTML markup. Because of this bugs with moving text fragments or scaling images occur, while parts of the page jump and twitch. There is also an bug with highlighting large parts of the text in the case when you just want to make a few words a heading or bold.

The Textarena workspace consists of separate blocks: paragraphs, headings, images, lists, quotes, etc. Each of them is an independent element provided by Textarena Plugin. This allows to avoid such bugs.

Keyboard shortcuts with hints

For convenience, there are keyboard shortcuts in the Textarena. They allow you to add Textarena elements, change their order, change the text styling, insert special characters and manipulate the history of changes.

Of course, in order not to memorize all the keyboard shortcuts, the Textarena has hints. How to view them is described below.

When the cursor is on an empty paragraph, a placeholder hint appears.

Creator bar

Hold Ctrl (Cmd ⌘ on Mac) or Alt (Option ⌥ on Mac) to see shortcut tips.

Creator bar keyboard shortcut tips:
Creator bar with tips

Toolbar keyboard shortcut tips:
Toolbar with tips

It is also possible to view hints by clicking on the button with the symbol '?'. This button is located in the lower right corner.

Keyboard shortcut hints

Textarena own parser

When inserting text from other editors, there may be a problem that additional styles are added. They interfere with the correct display of the text in the current editor and its further formatting.

To avoid this problem, the arena has its own parser. It removes styles and attributes that may affect the editor's work. You can configure which attributes should be kept and which should be avoided in the configuration of plugins.

You can read more about plugins here.

Textarena own change history

Depending on the browser, there is a possibility of incorrect operation of the change history, for example, when nothing happens when trying to cancel changes.

To avoid this problem, the arena stores its own history of changes.

Style control

Textarena is used on various web resources that have their own styling.

In order not to violate the design of the web resource, Textarena supports the ability to control styles and classes assigned to the elements of Textarena. This control is carried out by configuring plugins.

You can read more about plugins here.

Typograf support

Textarens supports the package Typograf. It helps to automatically place unbreakable spaces, correct minor typos, bring quotes to the correct form, replace hyphens with dashes in the right places, and much more.

To use the Typograf, select the text and click the button centered at the bottom with the text 'Typograf'.

Typograf

Related

ng-textarena - Angular version of the Textarena