An open-source entry in TopGit's GitHub warehouse: facebookarchive/draft-js, 22.6k stars, JavaScript. A React framework for building text editors.
Snapshot summary built from the project's own GitHub metadata — there's no written TopGit review yet. The page will update automatically when a full review is published.
WHY NO REVIEW YET
TopGit writes full reviews for the most-starred, most-requested repositories. This page is a snapshot until then — see the READ ME tab for the original README in full.
THIS PROJECT IS CURRENTLY IN MAINTENANCE MODE. It will not receive any feature updates, only critical security bug patches. On 31st December 2022 the repo will be fully archived.
For users looking for an open source alternative, Meta have been working on migrating to a new framework, called Lexical. It's still experimental, and we're working on adding migration guides, but, we believe, it provides a more performant and accessible alternative.
Draft.js is a JavaScript rich text editor framework, built for React and
backed by an immutable model.
Extensible and Customizable: We provide the building blocks to enable
the creation of a broad variety of rich text composition experiences, from
basic text styles to embedded media.
Declarative Rich Text: Draft.js fits seamlessly into
React applications,
abstracting away the details of rendering, selection, and input behavior with a
familiar declarative API.
Immutable Editor State: The Draft.js model is built
with immutable-js, offering
an API with functional state updates and aggressively leveraging data persistence
for scalable memory usage.
Learn how to use Draft.js in your own project.
Draft.js is used in production on Facebook, including status and
comment inputs, Notes, and
messenger.com.
API Notice
Before getting started, please be aware that we recently changed the API of
Entity storage in Draft.
Previously, the old API was set to be removed in v0.11.0. Since, the plans have changed— v0.11.0 still supports the old API and v0.12.0 will remove it. Refer to the docs for more information and information on how to migrate.
Note that the editor itself is only as tall as its contents. In order to give users a visual cue, we recommend setting a border and a minimum height via the .DraftEditor-root CSS selector, or using a wrapper div like in the above example.
Because Draft.js supports unicode, you must have the following meta tag in the <head></head> block of your HTML file:
<meta charset="utf-8" />
Further examples of how Draft.js can be used are provided in the /examples directory of this repo.
Building Draft.js
Draft.js is built with Yarn v1. Using other package managers mgiht work, but is not officially supported.
To clone and build, run:
git clone https://github.com/facebook/draft-js.git
cd draft-js
yarn install
yarn run build
Examples
To run the examples in the /examples directory, first build Draft.js locally as described above. Then, open the example HTML files in your browser.
Browser Support
IE / Edge
Firefox
Chrome
Safari
iOS Safari
Chrome for Android
IE11, Edge [1, 2]
last 2 versions
last 2 versions
last 2 versions
not fully supported [3]
not fully supported [3]
[1] May need a shim or a polyfill for some syntax used in Draft.js (docs).
[2] IME inputs have known issues in these browsers, especially Korean (docs).
[3] There are known issues with mobile browsers, especially on Android (docs).
Resources and Ecosystem
Check out this curated list of articles and open-sourced projects/utilities: Awesome Draft-JS.
Discussion and Support
Join our Slack team!
Contribute
We welcome pull requests. Learn how to
contribute.
License
Draft.js is MIT licensed.
Examples provided in this repository and in the documentation are separately
licensed.
Yes — facebookarchive/draft-js ships under the MIT license, which makes its source code freely readable (and, depending on license terms, forkable and reusable). Source: github.com/facebookarchive/draft-js.
What is facebookarchive/draft-js?
facebookarchive/draft-js (facebookarchive/draft-js) is a JavaScript project on GitHub. From the project's own README: A React framework for building text editors.
Where do I read more about facebookarchive/draft-js?
This TopGit page is a snapshot — the READ ME tab shows the project's own README content (links stripped, images preserved). The GitHub repository at github.com/facebookarchive/draft-js is the definitive source.
Read full README in the tab above.
Want a second opinion on draft-js?
Ask an AI that can read this page — one click and you get its take on draft-js.