Extensions

taskList

Node 0.57 kB gzipped

A checklist.

The checkbox is real DOM rather than a `::before`, because a checklist people cannot tick with the mouse is a bulleted list with extra steps. It carries `contenteditable="false"` so the caret never lands inside it.

1 · Install

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

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

3 · Use it

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

editor.commands.toggleTaskList()
editor.focus()

From the keyboard: Mod-Shift-7 .

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

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

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

const read = () => button.setAttribute('aria-pressed', String(editor.isActive('taskList')))
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
toggleTaskList editor.commands.toggleTaskList()

Keyboard shortcuts

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.

Styling

This one needs CSS to look right, and ships the minimum as a string rather than a file · nothing loads unless you load it, and you can ignore it and write your own. 

import { taskListCSS } from '@matrajs/core'

const style = document.createElement('style')
style.textContent = taskListCSS
document.head.append(style)

In the document

← All 83 extensions

Edit this page on GitHub