Options
All
  • Public
  • Public/Protected
  • All
Menu

@udecode/plate - v6.0.0

Plate

PRs Welcome Tested with Jest
Powered by Vercel

Visit plate.udecode.io for docs, guides, API and more!

Introduction

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/plate 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.

  • 🏎 Simple Start

You only need one component to get started: <Plate>

  • 🐻 State Management

zustand store is internally used to support multiple editor states.

  • πŸ’… Design System

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.

  • πŸ”Œ 40+ Packages

We enforce separation of concerns by packaging each feature for build optimization and versioning.

  • πŸ›  Extensible

All plugins accept extensible options and if you need to fork a plugin, all its functions are exported.

  • πŸ“¦ Tree-shaking / ES modules
  • βœ… TypeScript types
  • βœ… Unit tested with slate@0.63.0 and slate-react@0.65.2

Documentation

To find out more see the following Plate documentation sections:

The documentation is far from being complete and will be constantly evolving (as will the packages).

Looking for slate-plugins?

This repo has been renamed to plate. The name change should not disrupt any current usage, repo clones, pull requests or issue reporting. Links should redirect to the new location. The library formerly known as @udecode/slate-plugins is now available as @udecode/plate.

Contributing and project organization

Ideas and discussions

Discussions is the best place for bringing opinions and contributions. Letting us know if we're going in the right or wrong direction is great feedback and will be much appreciated!

Development

Plate is a modular, multi-package, monorepo project. It consists of a core package that creates the plugin system, based on which the plugin packages are implemented.

See the contributing guide to learn how to contribute your code to the project.

Packages

Core libraries

Name Version Description
@udecode/plate-common @udecode/plate-common npm package badge Common queries, transforms and utilities.
@udecode/plate-core @udecode/plate-core npm package badge Core plate architecture.

Element Plugins

Name Version Description
@udecode/plate-basic-elements @udecode/plate-basic-elements npm package badge Basic elements plugins.
@udecode/plate-alignment @udecode/plate-alignment npm package badge Text alignment plugin.
@udecode/plate-alignment-ui @udecode/plate-alignment-ui npm package badge Text alignment UI.
@udecode/plate-block-quote @udecode/plate-block-quote npm package badge Block quote plugin.
@udecode/plate-block-quote-ui @udecode/plate-block-quote-ui npm package badge Block quote UI.
@udecode/plate-code-block @udecode/plate-code-block npm package badge Code block plugin.
@udecode/plate-code-block-ui @udecode/plate-code-block-ui npm package badge Code block UI.
@udecode/plate-excalidraw @udecode/plate-excalidraw npm package badge Excalidraw plugin.
@udecode/plate-heading @udecode/plate-heading npm package badge Headings (1-6) plugin.
@udecode/plate-image @udecode/plate-image npm package badge Image plugin. Supports pasting images from clipboard.
@udecode/plate-image-ui @udecode/plate-image-ui npm package badge Image UI.
@udecode/plate-link @udecode/plate-link npm package badge Link plugin.
@udecode/plate-link-ui @udecode/plate-link-ui npm package badge Link UI.
@udecode/plate-list @udecode/plate-list npm package badge Bulleted, numbered and to-do list plugins.
@udecode/plate-list-ui @udecode/plate-list-ui npm package badge List UI.
@udecode/plate-media-embed @udecode/plate-media-embed npm package badge Media embed plugin.
@udecode/plate-media-embed-ui @udecode/plate-media-embed-ui npm package badge Media embed UI.
@udecode/plate-mention @udecode/plate-mention npm package badge Mention plugin (autocomplete @mentions, #tags, etc.).
@udecode/plate-mention-ui @udecode/plate-mention-ui npm package badge Mention UI.
@udecode/plate-paragraph @udecode/plate-paragraph npm package badge Paragraph plugin.
@udecode/plate-table @udecode/plate-table npm package badge Table plugin.
@udecode/plate-table-ui @udecode/plate-table-ui npm package badge Table UI.

Mark Plugins

Name Version Description
@udecode/plate-basic-marks @udecode/plate-basic-marks npm package badge Basic marks plugins: bold, code, italic, strikethrough, subscript, superscript and underline.
@udecode/plate-font @udecode/plate-font npm package badge Font color and background color plugins.
@udecode/plate-highlight @udecode/plate-highlight npm package badge Highlight plugin.
@udecode/plate-kbd @udecode/plate-kbd npm package badge Keyboard input plugin.

Serializer Plugins

Name Version Description
@udecode/plate-html-serializer @udecode/plate-serializer npm package badge Serializing utilities.
@udecode/plate-html-serializer @udecode/plate-html-serializer npm package badge HTML serializer plugin.
@udecode/plate-md-serializer @udecode/plate-md-serializer npm package badge Markdown serializer plugin.
@udecode/plate-ast-serializer @udecode/plate-ast-serializer npm package badge AST serializer plugin.
@udecode/plate-csv-serializer @udecode/plate-csv-serializer npm package badge CSV serializer plugin.

Plugins

Name Version Description
@udecode/plate @udecode/plate npm package badge All-in-one package.
@udecode/plate-autoformat @udecode/plate-autoformat npm package badge Autoformatting plugin. Replaces predefined characters with a corresponding format (e.g. foo becomes bold).
@udecode/plate-break @udecode/plate-break npm package badge Insert break plugins.
@udecode/plate-dnd @udecode/plate-dnd npm package badge Drag and drop with react-dnd.
@udecode/plate-find-replace @udecode/plate-find-replace npm package badge Find and replace plugin.
@udecode/plate-find-replace-ui @udecode/plate-find-replace-ui npm package badge Find and replace UI.
@udecode/plate-node-id @udecode/plate-node-id npm package badge Node ID plugin.
@udecode/plate-normalizers @udecode/plate-normalizers npm package badge Normalizer plugins.
@udecode/plate-reset-node @udecode/plate-reset-node npm package badge Reset node plugin.
@udecode/plate-select @udecode/plate-select npm package badge Node selecting plugins.
@udecode/plate-styled-components @udecode/plate-ui-fluent npm package badge Styled components (Plate UI library).
@udecode/plate-trailing-block @udecode/plate-trailing-block npm package badge Trailing-block plugin.
@udecode/plate-toolbar @udecode/plate-toolbar npm package badge Toolbar UI (balloon, heading, buttons, etc.).
@udecode/plate-test-utils @udecode/plate-test-utils npm package badge Test utilities.

Author's Note

@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.

BecomeΒ aΒ Sponsor!

Contributors

🌟 Stars and πŸ“₯ Pull requests are welcome! Don't hesitate to share your plugins here. Read our contributing guide to get started, or find us on Slack, we will take the time to guide you.

Thanks goes to these wonderful people (emoji key):


Ziad Beyens

🚧

Dylan Schiemann

🚧

Horacio Herrera

πŸ’» πŸ”Œ πŸ’‘ πŸ› πŸ€”

Eivind Barstad Waaler

πŸ’» πŸ”Œ πŸ’‘ πŸ›

Petr Sahula

πŸ’» πŸ”Œ πŸ’‘

Mark Vujevits

πŸ’»

Alan

πŸ’» πŸ”Œ πŸ› πŸ€”

cycle-app

πŸ’»

Paul

πŸ’» πŸ›

Daniel Lunde

πŸ’» πŸ”Œ

Roman Landenband

πŸ’» πŸ”Œ πŸ’‘

Karthikeyan

πŸ”Œ πŸ’‘ πŸ›

Csaba BenkΕ‘

πŸ”Œ

This project follows the all-contributors specification. Contributions of any kind welcome!

License

MIT

Generated using TypeDoc