slate-plugins-next v0.59.1

slate-plugins-next

Slate is a completely customizable framework for building rich text editors. However, your codebase can quickly get complex when implementing tens of features. Built on top of Slate, slate-plugins-next enables you to use a list of configurable and extendable plugins to keep your codebase clean and easy to debug.

This library comes with a lot of plugins for the elements, marks, deserialization, normalization, and so on. We also provide a bunch of helpers on top of Slate's API.

Try out the existing ones and create your own plugins!

📦 Included

• ✨ 20+ Editor Plugins.
• ✅ Unit tested with slate@0.58.1.
• 🏷️ Separation of Concerns.
• ⚛️ Atomic Design.
• 📖 Docs and Demos on Storybook.

Table of contents

• 🚀 Getting Started
• 🔌 Plugins
• 🤔 Notice
  • Why
  • Bundle size
• 👥 Community
• 👏 Contributing
  • 👨‍💻 Development scripts
• ✨ Contributors
• :memo: License

🚀 Getting Started

yarn add slate-plugins-next@0.58.13

⚠️ In production, you should pin the dependency until 1.0.0 is released.

You will also need these peerDependencies:

yarn add slate slate-hyperscript slate-react styled-components react react-dom

For full documentation on using slate-plugins-next visit: slate-plugins-next.netlify.app

For additional help, join us in our Slack

🔌 Plugins

🤔 Notice

Why

Slate is a powerful 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 need a lot of efforts to make something similar to Quill or ProseMirror. This repository allows you to build your editor right away with minimal slate knowledge.

Bundle size

For simplicity, a single package slate-plugins-next has been published to share all the plugins. It's not a problem as it is tree-shakeable. However, a few plugins use external dependencies. These should be moved into their own package in the future.

👥 Community

• Chatting on Slack

👏 Contributing

We welcome contributions to slate-plugins-next! Please feel free to share your own plugins here.

📥 Pull requests and 🌟 Stars are always welcome. Read our contributing guide to get started, or find us on Slack, we will take the time to guide you

👨‍💻 Development scripts

Useful scripts include:

yarn

Installs package dependencies

yarn storybook

Starts storybook dev

yarn lint

boolean check if code conforms to linting eslint rules

yarn test

Test with Jest

yarn release

Lint, test, build and push a release to git and npm will ask for version in interactive mode - using lerna.

Contributors ✨

License

MIT