Slate is a low-level editor framework that helps you deal with difficult parts when building an editor, such as events handlers, elements, formatting, commands, rendering, serializing, normalizing, etc.
While you are trying to build your own editors, it still needs a lot of skills to make something similar to Quill or ProseMirror. This repository allows you to build your editor right away with minimal slate knowledge.
@udecode/slate-plugins is built on top of slate to handle plugins and
state management for an optimal development experience. This repository
comes with a lot of plugins as elements, marks, serializers,
normalizers, queries, transforms, components and so on.
You only need one component to get started:
zustand store is internally used to support multiple editor states.
The API is design system friendly. We provide a default design system for quick start but you can plug-in your own one using a single function.
We enforce separation of concerns by packaging each feature for build optimization and versioning.
All plugins accept extensible options and if you need to fork a plugin, all its functions are exported.
|Common queries, transforms and utilities.|
|Core slate-plugins architecture.|
|Default UI for alignment.|
|Default UI for block quotes.|
|Default UI for code blocks.|
|Headings (from 1 to 6).|
|Images and pasting images from clipboard.|
|Default UI for images.|
|Default UI for hyperlinks.|
|Bulleted, numbered and to-do lists.|
|Default UI for lists.|
|Embeddable media such as YouTube or Vimeo videos.|
|Default UI for embeddable media.|
|Autocompleting @mentions and #tags.|
|Default UI for mentions.|
|Default UI for tables.|
|Basic text formatting: bold, code, italic, strikethrough, subscript, superscript and underline.|
|Keyboard input formatting.|
|Provides all packages.|
|Soft-break and exit-break.|
|Drag and drop with react-dnd.|
|Highlighting searching text.|
|Default UI for find-replace.|
|Insert nodes with an id key.|
|Reset node type.|
|Common UI utilities with fluentui.|
|Ensures a trailing block.|
|Toolbar components: balloon, heading, buttons.|
@zbeyens: I'm building an app with an editor like many of you and my first initiative was to spend months to share this work, while hundreds of developers were coding and debugging the exact same features. Open-source is a long-term investment for a bug-free product and reducing technical debt, so I can only encourage you to join this collaboration. Our goal is to build a fully-featured editor.
Thanks goes to these wonderful people (emoji key):
💻 🔌 💡 🐛 🤔
Eivind Barstad Waaler
💻 🔌 💡 🐛
💻 🔌 💡
💻 🔌 🐛 🤔
💻 🔌 💡
🔌 💡 🐛
This project follows the all-contributors specification. Contributions of any kind welcome!