Extensions

horizontalRule

Node in starterKit 0.07 kB gzipped

Parses hr · renders hr.

1 · Install

One package for every extension · there is no @matrajs/horizontalRule to install.

npm i @matrajs/core

2 · Add it to the editor

Import it and put it in the extensions array. That array is the whole feature list: what is not in it is not in your bundle and not in the document's schema.

import { createEditor, document, paragraph, text, horizontalRule } from '@matrajs/core'

const editor = createEditor({
  extensions: [document, paragraph, text, horizontalRule],
  element: document.querySelector('#editor'),
})

Already in starterKit · if you spread that kit you have this extension and adding it again is a duplicate the schema will reject.

3 · Use it

Run a command, and give focus back · a click on a button takes it away.

editor.commands.insertHorizontalRule()
editor.focus()

Wired to a button, with the pressed state kept in step:

const button = document.querySelector('#insertHorizontalRule')

button.addEventListener('click', () => {
  editor.commands.insertHorizontalRule()
  editor.focus()
})

const read = () => button.setAttribute('aria-pressed', String(editor.isActive('horizontalRule')))
editor.on('selectionChange', read)
editor.on('change', read)
read()

Both events, not one. selectionChange covers the caret moving into it; change covers the command that changed it without moving anything. A toolbar wired to only the first goes stale the moment someone uses the keyboard.

Commands

Every one returns true if it changed the document and false if it could not · a command that does not apply where the caret is says so rather than throwing.

Command	Call
`insertHorizontalRule`	`editor.commands.insertHorizontalRule()`

In the document

Reads hr when HTML is pasted or loaded.
Writes hr in getHTML() and renderToHTML().