# Lumen Editor

## Docs

- [Lumen Editor Constructor: new Editor(target, options)](https://docs.lumen.bjanczak.com/api/constructor.md): Complete reference for the Editor constructor signature, the target parameter, and all constructor options with their types, defaults, and descriptions.
- [Lumen Editor Events: change, error, autosave & More](https://docs.lumen.bjanczak.com/api/events.md): All Lumen Editor events, their payload types, and exactly when they fire — including change, error, autosave, view:toggle, and selectionchange.
- [Lumen Editor Instance Methods: Complete API Reference](https://docs.lumen.bjanczak.com/api/methods.md): Complete reference for all Lumen Editor instance methods, including signatures, parameter types, return types, and runnable code examples for each.
- [Module API: Custom Toolbar Buttons in Lumen Editor](https://docs.lumen.bjanczak.com/api/modules.md): The EditorModule interface, how to access and reuse built-in modules, and a complete walkthrough of building and registering custom toolbar buttons.
- [Plugin API: Extending Lumen Editor with Custom Plugins](https://docs.lumen.bjanczak.com/api/plugins.md): The EditorPlugin type signature, what plugins can access, and how to install them via the plugins constructor option or the editor.use() method.
- [Lumen Editor Basics: Instance, Events, and Lifecycle](https://docs.lumen.bjanczak.com/concepts/editor-basics.md): Learn how to create a Lumen Editor instance, read and write content, listen to events, extend with plugins, and clean up when you're done.
- [Lumen Editor Security Model: XSS, RCE, and Upload Safety](https://docs.lumen.bjanczak.com/concepts/security.md): Lumen Editor provides built-in XSS protection, RCE prevention, SSRF mitigation, and file upload validation so your users are protected by default.
- [Light and Dark Themes in Lumen Editor: Customization](https://docs.lumen.bjanczak.com/concepts/themes.md): Lumen Editor ships with built-in light and dark themes. Switch at runtime with setTheme(), or target CSS class names to apply your own brand styles.
- [Configuring the Lumen Editor Toolbar: Commands and Groups](https://docs.lumen.bjanczak.com/concepts/toolbar.md): The Lumen Editor toolbar is an array of command groups. Learn the array-of-groups format, all 17 built-in commands, and how to build a custom toolbar.
- [Lumen Editor Built-in Toolbar Modules: Full Reference](https://docs.lumen.bjanczak.com/configuration/modules.md): Reference for all 17 built-in Lumen Editor toolbar modules, including their groups and the full module object interface for creating custom modules.
- [Lumen Editor Constructor Options: Complete Reference](https://docs.lumen.bjanczak.com/configuration/options.md): Complete reference for all Lumen Editor constructor options, including types, defaults, and descriptions for every supported configuration key.
- [Lumen Editor HTML Sanitizer Configuration Reference](https://docs.lumen.bjanczak.com/configuration/sanitizer.md): Configure Lumen Editor's built-in HTML sanitizer: allowed tags, attributes, URL protocols, image data URIs, and CSS style properties.
- [Auto-Save Editor Content to localStorage](https://docs.lumen.bjanczak.com/guides/auto-save.md): Configure Lumen Editor's built-in auto-save with a storage key and debounce delay, then listen to the autosave event and restore content on page load.
- [Extend Lumen Editor with Custom Plugins](https://docs.lumen.bjanczak.com/guides/custom-plugins.md): Build a plugin function that accesses the editor API and DOM, subscribes to events, and install it via the plugins option or editor.use() after init.
- [Add Custom Toolbar Buttons to Lumen Editor](https://docs.lumen.bjanczak.com/guides/custom-toolbar.md): Define a custom module object, merge it with Lumen Editor's built-in modules, and add it to the toolbar config to render new command buttons.
- [Handle Image Uploads in Lumen Editor](https://docs.lumen.bjanczak.com/guides/image-uploads.md): Wire the uploadImage hook, understand file validation rules, and apply server-side safeguards for secure image handling in Lumen Editor.
- [Localizing Lumen Editor Toolbar Labels](https://docs.lumen.bjanczak.com/guides/localization.md): Use Lumen Editor's built-in English or Turkish locales, or supply a custom locale object to display toolbar tooltips in any language you need.
- [Lumen Editor vs Quill vs TinyMCE: Which Should You Use](https://docs.lumen.bjanczak.com/help/comparison.md): Compare Lumen Editor, Quill, and TinyMCE on bundle size, dependencies, security, sanitization, framework support, and licensing to pick the right editor.
- [Troubleshooting Lumen Editor: Fix Common Issues Fast](https://docs.lumen.bjanczak.com/help/troubleshooting.md): Diagnose and fix common Lumen Editor issues: rendering failures, content saving problems, image upload errors, and unexpected paste behaviour.
- [Installing Lumen Editor via npm, yarn, pnpm, or CDN](https://docs.lumen.bjanczak.com/installation.md): Install Lumen Editor using npm, yarn, or pnpm, or drop it onto any page with a CDN script tag — no build step required for either approach.
- [Lumen Editor: Lightweight WYSIWYG Rich Text Editor](https://docs.lumen.bjanczak.com/introduction.md): Lumen Editor is a ~12 KB, zero-dependency, framework-agnostic WYSIWYG editor with built-in HTML sanitization and a fully configurable toolbar.
- [Quickstart: Get Started with Lumen Editor in 5 Minutes](https://docs.lumen.bjanczak.com/quickstart.md): Install Lumen Editor, mount it on a page, configure your toolbar and options, then read and react to content changes — all in under five minutes.