JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 664290
  • Score
    100M100P100Q177612F
  • License BSD-3-Clause

A React framework for building text editors.

Package Exports

  • draft-js
  • draft-js/dist/Draft.css
  • draft-js/lib/AtomicBlockUtils
  • draft-js/lib/CharacterMetadata
  • draft-js/lib/CompositeDraftDecorator
  • draft-js/lib/ContentBlock
  • draft-js/lib/ContentState
  • draft-js/lib/DefaultDraftBlockRenderMap
  • draft-js/lib/DefaultDraftInlineStyle
  • draft-js/lib/DefaultDraftInlineStyle.js
  • draft-js/lib/DraftDecoratorType
  • draft-js/lib/DraftEditorBlock.react
  • draft-js/lib/DraftEditorContents.react
  • draft-js/lib/DraftEditorLeaf.react
  • draft-js/lib/DraftEntity
  • draft-js/lib/DraftModifier
  • draft-js/lib/DraftOffsetKey
  • draft-js/lib/DraftPasteProcessor
  • draft-js/lib/DraftStringKey
  • draft-js/lib/EditorState
  • draft-js/lib/KeyBindingUtil
  • draft-js/lib/adjustBlockDepthForContentState
  • draft-js/lib/convertFromDraftStateToRaw
  • draft-js/lib/convertFromHTMLToContentBlocks
  • draft-js/lib/convertFromRawToDraftState
  • draft-js/lib/createCharacterList
  • draft-js/lib/decodeEntityRanges
  • draft-js/lib/decodeInlineStyleRanges
  • draft-js/lib/encodeEntityRanges
  • draft-js/lib/encodeInlineStyleRanges
  • draft-js/lib/generateRandomKey
  • draft-js/lib/getContentStateFragment
  • draft-js/lib/getDefaultKeyBinding
  • draft-js/lib/getDraftEditorSelection
  • draft-js/lib/getEntityKeyForSelection
  • draft-js/lib/getFragmentFromSelection
  • draft-js/lib/getRangesForDraftEntity
  • draft-js/lib/getSafeBodyFromHTML
  • draft-js/lib/isSoftNewlineEvent
  • draft-js/lib/modifyBlockForContentState
  • draft-js/lib/sanitizeDraftText
  • draft-js/lib/splitBlockInContentState

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (draft-js) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Draft.js Build Status npm version

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.

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.