slate

completely customizable framework for building rich text editors.

slate

completely customizable framework
for building rich text editors.

 

Why? · Principles · Demo · Examples · Plugins · Documentation · Contributing!

 

  

 

A completely customizable framework for building rich text editors. http://slatejs.org

Slate lets you build rich, intuitive editors like those in MediumDropbox Paper or Google Docs—which are becoming table stakes for applications on the web—without your codebase getting mired in complexity.

It can do this because all of its logic is implemented with a series of plugins, so you aren’t ever constrained by what is or isn’t in “core”. You can think of it like a pluggable implementation of contenteditable built on top of React and Immutable. It was inspired by libraries like Draft.jsProsemirror and Quill.

🤖 Slate is currently in beta. Its core API is useable now, but you might need to pull request a fix or two for advanced use cases. Some of its APIs are not “finalized” and maybe change over time as we discover better solutions.

 

Why?

Why create Slate? Well… (Beware: this section has a few of my opinions!)

Before creating Slate, I tried a lot of the other rich text libraries out there—Draft.jsProsemirrorQuill, etc. What I found was that while getting simple examples to work was easy enough, once you started trying to build something like MediumDropbox Paper or Google Docs, you ran into deeper issues…

  • The editor’s “schema” was hardcoded and hard to customize. Things like bold and italic were supported out of the box, but what about comments, or embeds, or even more domain-specific needs?
  • Transforming the documents programmatically was very convoluted. Writing as a user may have worked, but making programmatic changes, which is critical for building advanced behaviors, was needlessly complex.
  • Serializing to HTML, Markdown, etc. seemed like an afterthought. Simple things like transforming a document to HTML or Markdown involved writing lots of boilerplate code, for what seemed like very common use cases.
  • Re-inventing the view layer seemed inefficient and limiting. Most editors rolled their own views, instead of using existing technologies like React, so you have to learn a whole new system with new “gotchas”.
  • Collaborative editing wasn’t designed for in advance. Often the editor’s internal representation of data made it impossible to use to for a realtime, collaborative editing use case without basically rewriting the editor.
  • The repositories were monolithic, not small and reusable. The code bases for many of the editors often didn’t expose the internal tooling that could have been re-used by developers, leading to having to reinvent the wheel.
  • Building complex, nested documents was impossible. Many editors were designed around simplistic “flat” documents, making things like tables, embeds and captions difficult to reason about and sometimes impossible.

Of course not every editor exhibits all of these issues, but if you’ve tried using another editor you might have run into similar problems. To get around the limitations of their API’s and achieve the user experience you’re after, you have to resort to very hacky things. And some experiences are just plain impossible to achieve.

If that sounds familiar, you might like Slate.

Which brings me to how Slate solves all of that…

Read full article on GitHub

 

Subscribe to the Newsletter

Get our latest news,tutorials,guides,tips & deals delivered to your inbox.

Leave a Reply

Your email address will not be published. Required fields are marked *

This site uses Akismet to reduce spam. Learn how your comment data is processed.