A toolkit for building WYSIWYG editors with Mobiledoc
npm install @tryghost/mobiledoc-kit
Mobiledoc Kit (beta) is a framework-agnostic library for building WYSIWYG editors
supporting rich content via cards.
This repository hosts the core Mobiledoc-Kit library. If you want to use Mobiledoc-Kit to create a WYSIWYG editor you have the following options:
| Environment | Library |
| ----------- | ------- |
| Plain JavaScript | mobiledoc-kit (this repo) |
| Ember | ember-mobiledoc-editor |
| React | react-mobiledoc-editor |
| Vue | vue-mobiledoc-editor |
If you only want to use the Mobiledoc-Kit runtime, for rendering mobiledoc posts only (not editing or creating them), you can use:
| Output Format/Environment | Library |
| ---------- | ------- |
| Plain JavaScript In-Browser (DOM) | mobiledoc-dom-renderer |
| Server-Side Rendering (HTML) | see mobiledoc-dom-renderer's Rendering HTML section |
| Server-Side Rendering (Text-only, e.g. SEO) | mobiledoc-text-renderer |
| In-Browser (DOM) Rendering, with Ember | ember-mobiledoc-dom-renderer |
| React Server and Browser Renderer | mobiledoc-react-renderer |
Mobiledoc is a deliberately simple and terse format, and you are encouraged to write your own renderer if you have other target output formats (e.g., a PDF renderer, an iOS Native Views Renderer, etc.).
Try a demo at bustle.github.io/mobiledoc-kit/demo.
API Documentation is available online.
* Posts are serialized to a JSON format called Mobiledoc instead of to
HTML. Mobiledoc can be rendered for the web, mobile web, or in theory on any
platform. Mobiledoc is portable and fast.
* The editor makes limited use of Content Editable, the siren-song of doomed
web editor technologies.
Mobiledoc is designed for rich* content. We call rich sections of an
article "cards" and rich inline elements "atoms" and implementing a new one doesn't require an understanding
of Mobiledoc editor internals. Adding a new atom or card takes an afternoon, not several
days. To learn more, see the docs for
Atoms,
Cards
and
Mobiledoc Renderers
To learn more about the ideas behind Mobiledoc and the editor (note that the
editor used to be named Content-Kit), see these blog posts:
* The Content-Kit announcement post.
* Building the Content-Kit Editor on Content Editable
* Content-Kit: Programmatic Editing
The Mobiledoc kit saves posts in
Mobiledoc format.
The Mobiledoc.Editor class is invoked with an element to render into and
optionally a Mobiledoc to load. For example:
``js`
var simpleMobiledoc = {
version: "0.3.1",
markups: [],
atoms: [],
cards: [],
sections: [
[1, "p", [
[0, [], 0, "Welcome to Mobiledoc"]
]]
]
};
var element = document.querySelector('#editor');
var options = { mobiledoc: simpleMobiledoc };
var editor = new Mobiledoc.Editor(options);
editor.render(element);
options is an object which may include the following properties:
* mobiledoc - [object] A mobiledoc object to load and edit.placeholder
* - [string] default text to show before a user starts typing.spellcheck
* - [boolean] whether to enable spellcheck. Defaults to true.autofocus
* - [boolean] When true, focuses on the editor when it is rendered.undoDepth
* - [number] How many undo levels should be available. Defaultcards
value is five. Set this to zero to disable undo/redo.
* - [array] The list of cards that the editor may renderatoms
* - [array] The list of atoms that the editor may rendercardOptions
* - [object] Options passed to cards and atomsunknownCardHandler
* - [function] This will be invoked by the editor-rendererunknownAtomHandler
whenever it encounters an unknown card
* - [function] This will be invoked by the editor-rendererparserPlugins
whenever it encounters an unknown atom
* - [array] See DOM Parsing Hooks
The editor leverages unicode characters, so HTML documents must opt in to
UTF8. For example this can be done by adding the following to an HTML
document's
:`html
`$3
*
- serialize the current post for persistence. Returns
Mobiledoc.
* editor.destroy() - teardown the editor event listeners, free memory etc.
* editor.disableEditing() - stop the user from being able to edit the
current post with their cursor. Programmatic edits are still allowed.
* editor.enableEditing() - allow the user to make edits directly
to a post's text.
* editor.editCard(cardSection) - change the card to its edit mode (will change
immediately if the card is already rendered, or will ensure that when the card
does get rendered it will be rendered in the "edit" state initially)
* editor.displayCard(cardSection) - same as editCard except in display mode.
* editor.range - Read the current Range object for the cursor.$3
A
Position object represents a location in a document. For example your
cursor may be at a position, text may be inserted at a position, and a range
has a starting position and an ending position.Position objects are returned by several APIs, for example
deleteRange returns
a position. Some methods, like splitSection accept a position as an argument.A position can be created for any point in a document with
section#toPosition(offset).Position API includes:
*
position.section - The section of this position
* position.offset - The character offset of this position in the section.
* position.marker - Based on the section and offset, the marker this position
is on. A position may not always have a marker (for example a cursor before
or after a card).
* position.toRange(endPosition) - Create a range based on two positions. Accepts
the direction of the range as a second optional argument.
* position.isEqual(otherPosition) - Is this position the same as another
* position.move(characterCount) - Move a number of characters to the right
(positive number) or left (negative number)
* position.moveWord(direction) - Move a single word in a given direction.$3
Range represents a range of a document. A range has a starting position
(head), ending position (tail), and a direction (for example highlighting
text left-to-right is a forward direction, highlighting right-to-left is a
backward direction).Ranges are returned by several APIs, but most often you will be interested in
the current range selected by the user (be it their cursor or an actual
selection). This can be accessed at
editor#range. Several post editor APIs
expect a range as an argument, for example setRange or deleteRange.Ranges sport several public APIs for manipulation, each of which returns a new,
unique range instance:
*
range.head - The position on the range closer to the start of the document.
* range.tail - The position on the range closer to the end of the document.
* range.isCollapsed - A range is collapsed when its head and tail are the same
position.
* range.focusedPosition - If a range has a forward direction, then tail. If
it has a backward direction, then head.
* range.extend(characterCount) - Grow a range one character in whatever its
direction is.
* range.move(direction) - If the range is collapsed, move the range forward
one character. If it is not, collapse it in the direction passed.
* range.expandByMarker(callback) - In both directions attempt grow the
range as long as callback returns true. callback is passed each marker
as the range is grown.$3
API consumers may want to react to given interaction by the user (or by
a programmatic edit of the post). Lifecycle hooks provide notification
of change and opportunity to edit the post where appropriate.
Register a lifecycle hook by calling the hook name on the editor with a
callback function. For example:
`js
editor.didUpdatePost(postEditor => {
let { range } = editor;
let cursorSection = range.head.section; if (cursorSection.text === 'add-section-when-i-type-this') {
let section = editor.builder.createMarkupSection('p');
postEditor.insertSectionBefore(section, cursorSection.next);
postEditor.setRange(new Mobiledoc.Range(section.headPosition));
}
});
`The available lifecycle hooks are:
*
- An opportunity to use the
postEditor and possibly change the post before rendering begins.
* editor.willRender() - After all post mutation has finished, but before
the DOM is updated.
* editor.didRender() - After the DOM has been updated to match the
edited post.
* editor.willDelete((range, direction, unit)) - Provides range, direction and unit to identify the coming deletion.
* editor.didDelete((range, direction, unit)) - Provides range, direction and unit to identify the completed deletion.
* editor.cursorDidChange() - When the cursor (or selection) changes as a result of arrow-key
movement or clicking in the document.
* editor.onTextInput() - When the user adds text to the document (see example)
* editor.inputModeDidChange() - The active section(s) or markup(s) at the current cursor position or selection have changed. This hook can be used with Editor#activeMarkups, Editor#activeSections, and Editor#activeSectionAttributes to implement a custom toolbar.
* editor.beforeToggleMarkup(({markup, range, willAdd} => {...}) - Register a
callback that will be called before editor#toggleMarkup is applied. If any
callback returns literal false, the toggling of markup will be canceled.
(Toggling markup done via the postEditor, e.g. editor.run(postEditor => will skip this callback.For more details on the lifecycle hooks, see the Editor documentation.
$3
A major goal of the Mobiledoc kit is to allow complete customization of user
interfaces using the editing surface. The programmatic editing API allows
the creation of completely custom interfaces for buttons, hot-keys, and
other interactions.
To change the post in code, use the
editor.run API. For example, the
following usage would mark currently selected text as "strong":`js
editor.run(postEditor => {
postEditor.toggleMarkup('strong');
});
`It is important that you make changes to posts, sections, and markers through
the
and postEditor API. This API allows the Mobiledoc editor to conserve
and better understand changes being made to the post.`js
editor.run(postEditor => {
const mention = postEditor.builder.createAtom("mention", "John Doe", { id: 42 });
// insert at current cursor position:
// or should the user have to grab the current position from the editor first?
postEditor.insertMarkers(editor.range.head, [mention]);
});
`For more details on the API of
, see the API documentation.For more details on the API for the builder, required to create new sections
atoms, and markers, see the builder API.
$3
The Mobiledoc editor allows the configuration of hot keys and text expansions.
For instance, the hot-key command-B to make selected text bold, is registered
internally as:
`javascript
const boldKeyCommand = {
str: 'META+B',
run(editor) {
editor.run(postEditor => postEditor.toggleMarkup('strong'));
}
};
editor.registerKeyCommand(boldKeyCommand);
`All key commands must have
and run properties as shown above.str describes the key combination to use and may be a single key, or modifier(s) and a key separated by +, e.g.: META+K (cmd-K), META+SHIFT+K (cmd-shift-K)Modifiers can be any of
CTRL, META, SHIFT, or ALT.The key can be any of the alphanumeric characters on the keyboard, or one of the following special keys:
BACKSPACE, TAB, ENTER, ESC, SPACE, PAGEUP, PAGEDOWN, END, HOME, LEFT, UP, RIGHT, DOWN, INS, DEL#### Overriding built-in keys
You can override built-in behavior by simply registering a hot key with the same name.
For example, to submit a form instead of entering a new line when
is pressed you could do the following:`javascript
const enterKeyCommand = {
str: 'enter',
run(editor) {
// submit the form
}
};
editor.registerKeyCommand(enterKeyCommand);
`To fall-back to the default behavior, return
from run.$3
The editor exposes a hook
onTextInput that can be used to programmatically react
to text that the user enters. Specify a handler object with text or match
properties and a callback function, and the editor will invoke the callback
when the text before the cursor ends with text or matches match.
The callback is called after the matching text has been inserted. It is passed
the editor instance and an array of matches (either the result of match.exec
on the matching user-entered text, or an array containing only the ).`javascript
editor.onTextInput({
text: 'X',
run(editor) {
// This callback is called after user types 'X'
}
});editor.onTextInput({
match: /\d\dX$/, // Note the "$" end anchor
run(editor) {
// This callback is called after user types number-number-X
}
});
`The editor has several default text input handlers that are defined in
.To remove default text input handlers call the unregister function.
`javascript
editor.unregisterAllTextInputHandlers();
`####
special-case match characterWhen writing a matching string it is common to use
\s at the end of a match
regex, thus triggering the handler for a given string when the users presses
the space or tab key.When the enter key is pressed no actual characters are added to a document.
Instead a new section is created following the current section. Despite this,
you may use
\n in a match regex to capture moments when the enter key is
pressed. For example if you wanted to process a URL for auto-linking you
might want to process the string on both the space key and when the user hits
enter.Since
\s is a superset of \n, that makes the following regex a valid match
for a hand-typed URL after the user presses space or enter:`regex
/\b(https?:\/\/[^\s]+)\s$/
`$3
A developer can override the default parsing behavior for leaf DOM nodes in
pasted HTML.
For example, when an
tag is pasted it may be appropriate to
fetch that image, upload it to an authoritative source, and create a specific
kind of image card with the new URL in its payload.A demonstration of this:
`js
function imageToCardParser(node, builder, {addSection, addMarkerable, nodeFinished}) {
if (node.nodeType !== 1 || node.tagName !== 'IMG') {
return;
}
var payload = { src: node.src };
var cardSection = builder.createCardSection('my-image', payload);
addSection(cardSection);
nodeFinished();
}
var options = {
parserPlugins: [imageToCardParser]
};
var editor = new Mobiledoc.Editor(options);
var element = document.querySelector('#editor');
editor.render(element);
`Parser hooks are called with three arguments:
*
- The node of DOM being parsed. This may be a text node or an element.
* builder - The abstract model builder.
* env - An object containing three callbacks to modify the abstract
* addSection - Close the current section and add a new one
* addMarkerable - Add a markerable (marker or atom) to the current section
* nodeFinished - Bypass all remaining parse steps for this nodeNote that you must call
nodeFinished to stop a DOM node from being
parsed by the next plugin or the default parser.Caveats
$3
mobiledoc-kit and the Grammarly extension do not play well together (see issue 422). Until this is resolved, you can avoid any such problems by disabling Grammarly for the mobiledoc-kit instances on your page. To do this, add the data-gramm="false" attribute to the mobiledoc-kit main DOM element.Contributing
Fork the repo, write a test, make a change, open a PR.
$3
Install dependencies via yarn:
npm install -g yarn or brew install yarn
* Install dependencies with yarn: Run tests via the built-in broccoli server:
*
* Or run headless tests via testem:
*
Tests in CI are run at Travis via Saucelabs (see the
npm script).$3
To run the demo site locally:
*
npm start
* The assets for the demo are in
.$3
If you notice a bug or have a feature request please open an issue on github.
If you have a question about usage you can post in the slack channel (automatic invites available from our slackin app) or on StackOverflow using the
mobiledoc-kit tag.$3
* Use
np (npm install -g np)
* np (e.g. np 0.12.0)
* git push $3
The demo website is hosted at
bustle.github.io/mobiledoc-kit/demo.
To preview the website, start the server and visit
http://localhost:4200/demo/. The code for
this website can be found in
. Note that the development server
does not rebuild jsdoc.To publish a new version:
*
npm run build:website - This builds the website into website/ and commits it
* npm run deploy:website - Pushes the website/ subtree to the gh-pages
branch of your Development of Mobiledoc and the supporting libraries was generously funded by Bustle Labs. Bustle Labs is the tech team behind the editorial staff at Bustle, a fantastic and successful feminist and women’s interest site based in NYC.