Essential Studio® Rich Text Editor SDK
Thank you for choosing Syncfusion Essential Studio® Rich Text Editor SDK 35.1.37. We appreciate having you as a customer. Please take a moment to read the information in this document before proceeding further. This document contains important information on configuring Essential Studio® Rich Text Editor SDK 35.1.37 for optimal use.
Overview
The Essential Studio® Rich Text Editor SDK provides powerful, feature-rich solutions for content editing and document creation. It includes the Rich Text Editor for traditional WYSIWYG editing, the BlockEditor for modern block-based content authoring, the Modern Rich Text Editor for a modern, extensible WYSIWYG experience built on ProseMirror, and the Headless Editor Library as a framework-agnostic editing foundation. These components support both web and mobile platforms.
Key Features
Rich Text Editor
- Editing Modes - Supports both HTML (WYSIWYG) and Markdown editing modes with live preview.
- Comprehensive Toolbar - Fully customizable toolbar with multiple layouts (Expand, MultiRow, Scrollable) and floating toolbar support.
- Rich Text Formatting - Complete text formatting with fonts, colors, headings, alignment, lists, and inline styles.
- Media Insertion - Insert and manage images, videos, audio files, tables, hyperlinks, and code blocks.
- AI Assistant - Built-in AI integration for content generation, summarization, translation, and smart suggestions. Supports OpenAI, Azure AI, and custom AI services.
- Smart Editing - Emoji picker, slash menu (type `/`), @mentions with autocomplete, mail merge, format painter, and auto-format for Markdown.
- Import & Export - Import Word documents (DOCX) and export content to Word and PDF formats with server-side library support.
- Paste Cleanup - Intelligent paste handling with cleanup options for content from Word, Excel, Google Docs, and other sources.
- Form Integration - Seamless form integration with validation support and XHTML validation.
- Editor Management - Undo/redo support, resizable editor, source code view, character count, auto-save, and full-screen mode.
- Accessibility - WCAG 2.1 compliant with keyboard navigation, screen reader support, and customizable shortcuts.
- Globalization - Multi-language support with RTL (right-to-left) text direction and localization.
- Security - Built-in XSS prevention with HTML sanitization and secure content handling.
BlockEditor
- Real-Time Collaboration - Enable multiple users to edit content simultaneously with synchronized updates, user presence indicators, remote cursors, and conflict-free collaborative editing.
- Block-Based Architecture - Modern block-based content creation where each element (paragraphs, headings, lists, tables, code) is a discrete, manageable, and reorderable block.
- Rich Block Types - Comprehensive blocks including text (paragraph, headings, lists), media (images), layout (tables), content (code, quotes, callouts), and collapsible sections.
- Intuitive Menus - Slash command menu (`/`), right-click context menu, inline text formatting toolbar, block action menu, and transform menu for converting block types.
- Drag-and-Drop - Smooth drag-and-drop reordering of blocks with visual handles and drop indicators.
- Mentions & Labels - @mention users with autocomplete and add categorization labels with custom trigger characters.
- Content Management - Programmatic API for adding, removing, updating, and moving blocks with support for nested structures.
- Export & Import - Export content as JSON, HTML, or plain text. Import from JSON for data persistence.
- Paste Cleanup - Intelligent paste sanitization to clean formatting from external sources.
- Undo/Redo - Full undo/redo functionality with configurable history and keyboard shortcuts.
- Keyboard Shortcuts - Comprehensive shortcuts for power users with full customization support.
- Accessibility - WCAG 2.1 compliant with keyboard navigation, screen reader support, and ARIA attributes.
- Styling & Theming - Custom CSS classes, built-in themes, dark mode support, and responsive design.
Modern Rich Text Editor (preview)
- Rich text formatting - Apply common text styles such as bold, italic, underline, strikethrough, subscript, superscript, fonts, and colors.
- Block formatting - Format content using headings, paragraphs, block quotes, code blocks, callouts, horizontal rules, and collapsible sections.
- Lists - Create bulleted, numbered, and checklist lists with multiple styles and indentation support.
- Text alignment - Align content to the left, center, right, or justify.
- Automatic markdown formatting - Automatically apply rich text formatting when typing common Markdown syntax for headings, lists, emphasis, code, and other supported content.
- Link management - Insert, edit, open, copy, and remove links using contextual editing actions.
- Image editing - Insert, update, replace, and remove images with support for captions, alt text, alignment, wrapping, and dimensions.
- Table editing - Create and manage tables with row, column, header, cell formatting, alignment, and deletion options.
- Flexible toolbar - Configure automatic, expanded, multi-row, or scrollable toolbar layouts to suit different screen sizes and editing needs.
- Quick toolbars - Provide contextual actions for links, images, tables, and other selected content.
- Slash commands - Quickly find and execute editor actions by typing
/ in the editing area.
- Undo and redo - Manage editing history with configurable undo and redo behavior.
- Keyboard shortcuts - Configure custom keyboard shortcuts to support efficient editing workflows.
- Placeholder and read-only - Display placeholder text for empty content and restrict editing when read-only mode is enabled.
Headless Editor Library (preview)
- Headless editing foundation - Provides a UI-independent editing engine that integrates with various editor interfaces and application frameworks.
- ProseMirror-based editing - Uses ProseMirror as the underlying document model and editing engine for structured content, transactions, selections, and plugins.
- Extensible editor architecture - Provides an extension system for adding, configuring, and composing editor functionality without coupling features to a specific UI.
- Command framework - Introduces a centralized command system for content manipulation, formatting, selection, lists, and document transformations.
- Structured document model - Supports nodes, inline marks, blocks, nested content, and schema-based document structures for reliable content management.
- Rich content - Provides built-in support for headings, lists, links, images, tables, code blocks, callouts, and collapsible sections.
- Custom node view - Enables custom rendering and an interactive UI for complex document elements such as images, tables, and other structured content.
- Event system - Provides editor lifecycle, content, selection, focus, paste, delete, and file events to monitor and customize editor behavior.
- Schema management - Provides schema definition, validation, and migration capabilities to maintain structured, consistent editor content.
- File and upload handling - Provides reusable file handling and upload-state infrastructure for media and other file-based editing scenarios.
- Keyboard and selection - Provides configurable keyboard bindings and selection APIs for building customized editing interactions.
- Reusable editing foundation - Provides a common foundation for building different editor experiences, including rich-text and structured content editors.
Common Features
- Cross-Platform Support - Available for JavaScript, React, Angular, Vue, ASP.NET Core, ASP.NET MVC, Blazor, and .NET MAUI platforms.
- Responsive Design - Mobile-friendly and touch-optimized interface for all screen sizes and devices.
- Modular Architecture - Import only required modules to minimize bundle size and optimize performance.
- Customizable UI - Extensive customization options for toolbars, menus, styling, and behavior.
- Rich Event System - Comprehensive events for content changes, user actions, and lifecycle management.
- Powerful API - Full programmatic control for content manipulation, selection, and toolbar management.
- State Management - Support for controlled/uncontrolled modes with auto-save and state persistence.
- Security First - Built-in XSS protection and HTML sanitization for secure content handling.
- Performance Optimized - Efficient rendering for large documents with optimized operations.
- Browser Compatibility - Support for all modern browsers including Chrome, Firefox, Safari, Edge, and mobile browsers.
- WCAG Compliant - Full accessibility compliance with keyboard navigation and screen reader support.
- Professional Support - Technical support through forums, tickets, knowledge base, and direct assistance.
Sample Browser
Online Sample Browser
Explore interactive demos showcasing the capabilities of our controls:
GitHub Sample Repositories
Access platform-specific sample projects on GitHub:
Software Requirements
Ensure your development environment meets platform-specific requirements. For detailed and up-to-date information,
refer to the official Syncfusion documentation for each platform:
Web Platforms
Mobile Platforms
Learning
Documentation
Access comprehensive platform-specific documentation:
Technical Support
Your feedback helps us improve. Please share your experience or report issues through our support channels.
|
|