facebookarchive/draft-jsArchived
Draft Js
Draft-js is a framework for building customizable rich text editors within React applications. It serves as a state manager for document content and metadata, providing a system to handle text ranges, atomic blocks, and the conversion of HTML strings into structured document formats.
The framework enables the creation of interactive editing interfaces that support custom inline styling and configurable block rendering. It includes tools for managing rich media document handling, allowing the integration of non-editable content and metadata into a text stream.
The project covers a broad range of editor capabilities, including accessibility support via ARIA labels, custom keyboard event handling, and the management of clipboard and drag-and-drop operations. It also provides controls to override default browser text behaviors such as auto-correct and auto-capitalize.
Features
- Rich Text Editors - Implements a comprehensive framework for building customizable rich text editors with structured document models in React.
- Rich Text Editors - Provides a comprehensive framework for building customizable, web-based rich text editors with structured document models.
- Block-Based Document Models - Implements a document model organized as a sequence of discrete blocks to separate structure from inline styling.
- Immutable State Utilities - Maintains the document state as a persistent, immutable data structure to enable efficient snapshots and undo history.
- Document - Manages metadata and entities associated with specific text ranges within the document state.
- Content Block Editors - Enables the insertion and movement of non-editable atomic blocks of content within the document.
- Content Editable Proxies - Provides a proxy wrapper around native HTML editable elements to synchronize document state with a React view.
- Range-Based Entity Mappings - Tracks metadata for specific text spans using decoupled start and end offsets to manage document entities.
- Document State Management - Serves as a state manager for document content and metadata, handling text ranges and atomic blocks.
- Text Input Managers - Provides logic for overriding default browser text behaviors and keyboard events to implement specific editing and navigation logic.
- HTML to Document Parsers - Includes a system for parsing HTML strings into structured document formats for use within the editor.
- Keyboard Navigation Interception - Intercepts specific keyboard events and arrow key navigation to trigger custom editor behaviors.
- Rendering Pipelines - Uses an architectural pipeline to map internal content state to customizable React components for visual output.
- Structured Block Renderers - Allows mapping specific content block types to corresponding React components to control visual rendering.
- Editor Accessibility Optimizations - Implements ARIA labels and keyboard navigation support to ensure complex editor components are accessible to screen readers.
- HTML Content Processing - Provides utilities for parsing raw HTML strings and integrating them into the structured document model.
- HTML Content Processing - Parses raw HTML strings into a structured document format, supporting images and various link protocols.
- Inline Styling Systems - Supports applying custom visual styles to specific ranges of text through a user-defined styling function.
- Rich Media Document Handling - Provides a system for managing atomic blocks and entity metadata to integrate images and links into the text stream.
- DOM Reconciliation Utilities - Implements manual DOM reconciliation to synchronize internal state with the browser DOM and prevent cursor jumps.
- React Editors - Rich text framework built for React with immutable models.
