Task Lists

Task lists render checkboxes that users can toggle directly in the editor.

Usage


import { availablePlugins } from "@inkstream/starter-kit"
 
<RichTextEditor
  plugins={[availablePlugins.list]}
  toolbarLayout={['lists']}
/>

Type [ ] or [x] at the start of a line to create a task item:


[ ] Buy groceries
[x] Write documentation

Task list state is serialised as HTML with data-checked attributes:


<ul data-type="task-list">
  <li data-checked="false">Buy groceries</li>
  <li data-checked="true">Write documentation</li>
</ul>