ncodefresh / draft-js

A React framework for building text editors.

Draft.js

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

Examples

Visit https://facebook.github.io/draft-js/ to try out a simple rich editor example.

The repository includes a variety of different editor examples to demonstrate some of the features offered by the framework.

To run the examples, first build Draft.js locally:

git clone https://github.com/facebook/draft-js.git
cd draft-js
npm install
npm run build

then open the example HTML files in your browser.

Draft.js is used in production on Facebook, including status and comment inputs, Notes, and messenger.com.

Build and run website

The first time, get all the dependencies loaded via

npm install

Then, run the server via

npm start
Open http://localhost:8080/draft-js/index.html

How dockerize this project?

Create Dockerfile for this project and try it on Codefresh.

FROM node:latest

RUN mkdir -p /usr/src/app
WORKDIR /usr/src/app
COPY . /usr/src/app
COPY package.json /usr/src/app/

RUN npm install --silent
RUN cd website && pwd && npm install
RUN npm run build

WORKDIR /usr/src/app/website
CMD [ "npm", "start" ]

Discussion and Support

Join our Slack team!

Contribute

We actively welcome pull requests. Learn how to contribute.

License

Draft.js is BSD Licensed. We also provide an additional patent grant.

Examples provided in this repository and in the documentation are separately licensed.