@editora/checklist
v1.0.3
Published
Checklist plugin for Rich Text Editor
Readme
@editora/checklist
[!IMPORTANT] Live Website: https://editora-ecosystem.netlify.app/
Storybook: https://editora-ecosystem-storybook.netlify.app/
Checklist plugin for Editora rich text editor.
What It Does
- Toggles checklist structure for selected blocks.
- Converts regular lists and paragraphs into checklist items.
- Supports multi-line conversion.
- Supports toggling back from checklist to paragraph blocks.
- Preserves selection/caret as much as possible across transformations.
Installation
npm install @editora/checklistOr bundle install:
npm install @editora/pluginsUsage
import { ChecklistPlugin } from "@editora/checklist";
const plugins = [ChecklistPlugin()];Toolbar Command and Shortcut
- Command:
toggleChecklist - Toolbar label:
Checklist - Shortcut:
Mod-Shift-9
Rendered Structure
Checklist content uses list semantics with metadata attributes:
ul[data-type="checklist"]li[data-type="checklist-item"][data-checked="true|false"]
Notes
- Public package entry exports
ChecklistPlugin.
