Extensions

highlight

Mark 0.15 kB gzipped

Parses mark · renders mark.

1 · Install

One package for every extension · there is no @matrajs/highlight 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, highlight } from '@matrajs/core'

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

3 · Use it

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

editor.commands.toggleHighlight('…')
editor.focus()

From the keyboard: Mod-Shift-h .

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

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

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

const read = () => button.setAttribute('aria-pressed', String(editor.isActive('highlight')))
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
`toggleHighlight`	`editor.commands.toggleHighlight(color: string)`
`unsetHighlight`	`editor.commands.unsetHighlight()`

Keyboard shortcuts

Mod-Shift-h · toggleHighlight

Mod is Command on a Mac and Control everywhere else. To rebind one, put your own extension after this in the array · later keys win.

In the document

Attribute	Default
`color`	`none`

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

← All 83 extensions

Edit this page on GitHub