Plate

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

Hiring

@udecode offers Plate consultancy services. If you're a company in need of a gig, please contact @zbeyens.

Introduction

Plate is a plugin system for Slate and React to make it easier to build fully-featured editors. It handles things like node rendering, events handlers, serializing, and normalizing so you don't have to.

This repository comes with a lot of plugins, including elements, marks, serializers, normalizers, queries, transforms, and components.

Plate uses jotai for state management and is designed to support decoupled design systems. It comes with a default design system, but you can also plug in your own.

With more than 70 packages, @udecode/plate enforces separation of concerns for improved build optimization and versioning. It is also extensible, with all plugins accepting options and their functions being exported. Finally, it is tree-shakeable and comes with heavy TypeScript support.

Motivation

Are you tired of struggling to build your own custom editor from scratch? Do you wish there was an easier way to take advantage of the powerful features of Slate without needing to be an expert in its low-level details? Look no further than Plate!

With Plate, building your own editor is as simple as using a single component. But don't let its simplicity fool you - Plate is packed with powerful features to help you create the perfect editor for your needs. It uses Jotai for state management, and offers a default design system or the ability to plug in your own. Plus, with over 70 packages for individual features, you can easily customize and optimize your editor.

But that's not all - Plate also supports extensibility and comes with TypeScript support for even stronger type checking.

Don't spend any more time struggling to build your custom editor. Try Plate today and start building the perfect editor for your needs!

Documentation

For more information on @udecode/plate, please refer to the following documentation sections:

• API documentation
• Docs
  • Quick start
  • Guides
  • Playground
• Examples
  • NextJS
  • CRA

Note that the documentation is a work in progress and will be updated regularly as the project evolve.

Contributing and project organization

Ideas and discussions

Discussions is the best place for bringing opinions and contributions. Your feedback and contributions are welcome and will help us ensure that we are heading in the right direction with the project.

Development

Plate is a modular, multi-package project that uses a monorepo structure. The core package provides the foundation for the plugin system, and the plugin packages are built on top of this.

If you are interested in contributing to the development of Plate, please refer to the contributing guide for information on how to submit your code to the project.

Author's Note

As the author of @udecode/plate, I understand the challenges of building an app with an editor. I spent months working on this project and realized that many other developers were facing the same difficulties. That's why I decided to open-source this work and invite others to collaborate.

Open-source is a long-term investment that can help us create a bug-free product and reduce technical debt. By working together, we can build a fully-featured editor that will benefit us all. I encourage you to join this collaboration and contribute to the project. Together, we can create something truly great.

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 Discord, 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