red-axe/am-editor
Am Editor
This project is a framework for building real-time collaborative rich-text editing environments. It provides a structured, schema-based engine that enforces document integrity while allowing multiple users to modify content simultaneously through synchronized state management and conflict resolution protocols.
The editor distinguishes itself through a highly modular plugin architecture that supports the integration of complex, interactive UI components built with external frontend libraries. By utilizing a custom rendering engine and a versioned, immutable document state tree, it enables developers to inject custom metadata, handle specialized submission logic, and maintain consistent document structures across diverse collaborative sessions.
The platform covers a broad range of capabilities for rich-text development, including comprehensive multimedia management, advanced text formatting controls, and interactive widgets such as mentions, hyperlinks, and mathematical formula rendering. It also provides tools for monitoring user interactions, such as cursor tracking and formatting change notifications, to ensure visibility into the editing process.
The system is designed for production environments, supporting multi-process execution to distribute workloads and improve performance. It is implemented in TypeScript and offers extensive configuration options for localization, schema definitions, and custom toolbar components.
Features
- Real-Time Collaborative Editing - Provides a real-time collaborative editing environment that synchronizes document state changes across multiple users.
- Rich Text Editors - Provides the core framework for building custom document models and rich text editing experiences.
- Document Schema Enforcement - Enforces structural constraints and nesting rules on document nodes to ensure consistent data formatting across collaborative sessions.
- Real-time Synchronization - Maintains consistent document state across multiple users using conflict resolution protocols.
- Operational Transformation Sync - Implements operational transformation protocols to resolve conflicts and maintain consistency across multiple collaborative clients.
- Extensible Plugin Architectures - Supports modular extension through a plugin architecture for custom nodes and UI components.
- Persistent Document Trees - Maintains document content as a persistent, versioned, and immutable tree structure to facilitate efficient synchronization and diffing.
- Schema-Enforced Editors - Validates allowed node types, attributes, and nesting rules using schema-based constraints to maintain document integrity.
- WYSIWYG Editors - Provides a WYSIWYG editing environment with schema enforcement and modular tools.
- Rich Text Editors - Provides a framework for creating customizable browser-based rich text editing interfaces with complex formatting and media support.
- File Upload - Provides a dedicated interface for selecting and uploading video files with custom constraints.
- Document Element Insertion - Provides mechanisms for inserting structural and visual elements into the document flow.
- External Content Integrations - Embeds third-party web content into the document with configurable display options.
- Non-History Formatting Removals - Allows programmatic removal of formatting marks without affecting the document undo history.
- Markdown to Rich Text Parsers - Converts markdown syntax into structured rich text objects during user input.
- Multimedia Embeddings - Integrates various media types and interactive components directly into the document structure.
- Structural Mark Restorations - Enables the reconstruction of complex document formatting from stored structural data.
- Hyperlink Insertions - Provides UI controls for inserting and managing hyperlinks within the text.
- External Media Proxying - Handles the ingestion and local storage of external media assets to ensure document stability.
- Web Multimedia Integration - Manages the upload, processing, and embedding of multimedia assets within a structured document environment.
- Modular Plugin Architectures - Extends core functionality by integrating modular plugins built with modern frontend frameworks.
- Formatting Change Monitors - Triggers callbacks for formatting changes to ensure visibility into the editing process.
- Custom Rendering Engines - Utilizes a custom rendering engine to support complex document structures beyond standard browser capabilities.
- Synchronized Formatting Marks - Ensures that formatting marks are persisted and synchronized across all collaborative users.
- Custom UI Components - Mounts complex interactive UI components as isolated elements within the document.
- Autocomplete Mention Insertions - Provides a searchable dropdown interface for inserting tagged entities into the document.
- Document Schema Definitions - Registers and defines structural constraints and attributes for document elements to ensure consistent formatting.
- Interactive UI Components - Integrates custom interactive elements into the document flow for complex content.
- Formula Rendering - Renders mathematical formulas by converting data into visual images or SVG representations.
- Editor Image Uploaders - Handles the end-to-end workflow of selecting, uploading, and inserting images into the editor.
- Structural Path Mappings - Provides a mechanism to separate raw text from structural formatting metadata for document processing.
- Stable Cursor Tracking - Tracks and maintains logical cursor positions across concurrent collaborative edits.
- Framework-Agnostic Rendering - Enables mounting complex interactive UI components as isolated cards within the document flow using external frontend frameworks.
- Plugin Systems - Supports a modular plugin system for adding rich text features, media embedding, and interactive elements.
