How pradeep241094/react-wysiwyg-editor works
Project Type and Purpose
• This repository is an open-source React + TypeScript library (NPM package) providing a WYSIWYG editor component with dual-mode editing (HTML/Markdown), advanced media handling, toolbar configuration, sanitization, and accessory modals.
• It also contains supporting demo applications (demo-app, test-installation) and build/deployment scripts for CI/CD, packaging, and publishing.
File Structure Analysis
• Top-level
• src/ → Core library source: components, utils, types, styles
• dist/ → Compiled outputs (CJS + ES + .css + TypeScript definitions)
• demo-app/ → Standalone Vite-based demo application showcasing the editor
• test-installation/→ Minimal app to verify npm installation
• scripts/ → Build, publish, test-installation helper scripts
• README.md, configs → Documentation and build/deployment configuration
• Patterns
• Component hierarchy under src/components (WYSIWYGEditor, Toolbar, modals, EditableArea) follows a UI-centric modular design.
• Utility functions under src/utils handle command execution, selection management, content sanitization, toolbar configuration resolution.
• Build outputs under dist mirror the src structure (components/, utils/, types/) indicating a straightforward compile pipeline.
• Demo apps import the built library or source directly via TypeScript path or NPM package.
Core Components and Interactions
• WYSIWYGEditor (root UI component)
↳ uses EditableArea for contentEditable region
↳ uses Toolbar or AdvancedToolbar (preset or custom via ToolbarConfigResolver)
↳ orchestrates modals: FileUploadModal, ImageCropModal, LinkPreviewPopup, FindReplaceModal, NotificationModal, SpecialCharModal, TableInsertModal, UrlInputModal
• CommandExecutor (singleton)
↔ invoked by toolbar buttons, modals, or programmatically to execute document.execCommand or custom commands
• contentSanitizer
↔ invoked on paste or before output to clean unsafe HTML
• selectionUtils
↔ capture/restore selections when opening/closing modals
• ToolbarConfigResolver
↔ merges preset/include/exclude/order rules into final enabledButtons list for Toolbar
• External integration
↔ Demo-app/test-installation import WYSIWYGEditor + styles from the built package
↔ Consumers import from @prmargas/react-wysiwyg-editor via NPM
Architectural Patterns and Principles
• Modular UI components (each modal or toolbar section is its own component)
• Singleton command system for centralized command execution
• Functional separation: UI (components) vs. logic (utils) vs. configuration (types + resolver)
• Publishable library with dual‐module output (CJS + ES) and full TypeScript declarations
• Demo and test harnesses to validate integration and cross-browser compatibility