autumnnote 1.2.1 → 1.4.0

package/README.md

@@ -16,7 +16,7 @@ A modern, lightweight WYSIWYG rich-text editor built with vanilla JavaScript (ES
 
 > Write rich text. No dependencies. No drama.
 
-[Live Demo](https://cmm-cmm.github.io/Autumn-Note/)
+[Live Demo](https://cmm-cmm.github.io/Autumn-Note/) · [Docs](https://cmm-cmm.github.io/Autumn-Note/docs.html) · [Playground](https://cmm-cmm.github.io/Autumn-Note/playground.html)
 
 <p align="center"><img src="demo/Screenshot.png" alt="AutumnNote Screenshot"/></p>
 
@@ -27,14 +27,15 @@ A modern, lightweight WYSIWYG rich-text editor built with vanilla JavaScript (ES
 1. [Features](#features)
 2. [Installation](#installation)
 3. [Quick Start](#quick-start)
-4. [API](#api)
-5. [Options](#options)
-6. [Toolbar Customisation](#toolbar-customisation)
-7. [Keyboard Shortcuts](#keyboard-shortcuts)
-8. [Mentions](#mentions)
-9. [Project Structure](#project-structure)
-10. [Comparison](#comparison)
-11. [License](#license)
+4. [Plugin API](#plugin-api)
+5. [API](#api)
+6. [Options](#options)
+7. [Toolbar Customisation](#toolbar-customisation)
+8. [Keyboard Shortcuts](#keyboard-shortcuts)
+9. [Mentions](#mentions)
+10. [Project Structure](#project-structure)
+11. [Comparison](#comparison)
+12. [License](#license)
 
 ---
 
@@ -109,7 +110,7 @@ Right-click inside the editor opens a context menu with: **Undo**, **Redo**, **C
 - **No jQuery** — pure vanilla ES2022, zero runtime dependencies
 - **Bootstrap friendly** — optional Bootstrap 4/5 styling (`useBootstrap: true`)
 - **FontAwesome ready** — auto-detects FA on the page; falls back to built-in SVG icons
-- **Plugin-ready** — register custom modules via `AutumnNote.defaults`
+- **Plugin API** — first-class plugin system: `AutumnNote.use(plugin)`, `context.getPlugin(name)`, global button registry (`registerButton`), per-instance installation, `AsnPlugin<T>` TypeScript interface
 - **Tree-shakeable** — ES module build; all core utilities individually exported
 - **TypeScript definitions** — bundled `types/index.d.ts` with full JSDoc coverage
 - **@mention autocomplete** — type `@` (or any custom trigger) to open a floating dropdown backed by a user-supplied `onSearch` function; inserts a non-editable mention chip; customisable chip HTML via `onInsert`
@@ -269,6 +270,61 @@ const editor = AutumnNote.create('#my-editor', {
 
 ---
 
+## Plugin API
+
+Plugins package editor extensions — custom modules, toolbar buttons, and event handlers — into a reusable, distributable object.
+
+```js
+import AutumnNote from 'autumnnote';
+
+const WordCountPlugin = {
+  name: 'word-count',
+  version: '1.0.0',
+  // Buttons registered BEFORE create() — usable by name in toolbar config
+  buttons: [{
+    name: 'wordCountBtn',
+    icon: 'hashtag',
+    tooltip: 'Word count',
+    action: (ctx) => alert(`${ctx.getWordCount()} words`),
+  }],
+  // Called after all built-in modules initialise
+  install(ctx, options) {
+    ctx.on('change', () => console.log('words:', ctx.getWordCount()));
+    return { getMax: () => options.maxWords };
+  },
+  uninstall(ctx) { /* cleanup */ },
+};
+
+// Global — applied to every future editor instance
+AutumnNote.use(WordCountPlugin, { maxWords: 500 });
+
+const editor = AutumnNote.create('#editor', {
+  toolbar: [['bold', 'italic', 'wordCountBtn']], // 'wordCountBtn' resolved from registry
+});
+
+editor.getPlugin('word-count').getMax(); // → 500
+```
+
+**Per-instance installation:**
+
+```js
+const editor = AutumnNote.create('#editor');
+editor.use(WordCountPlugin, { maxWords: 200 });
+editor.invoke('toolbar.rebuild'); // re-render toolbar with new buttons
+```
+
+| Method | Description |
+|---|---|
+| `AutumnNote.use(plugin, opts?)` | Install globally. Buttons registered immediately; `install()` called after modules init. |
+| `AutumnNote.hasPlugin(name)` | Returns `true` if plugin registered globally. |
+| `AutumnNote.registerButton(def)` | Register a single button globally by name. |
+| `context.use(plugin, opts?)` | Install on this instance only. |
+| `context.getPlugin<T>(name)` | Returns the public API from `plugin.install()`. |
+
+See the [full Plugin API docs →](https://cmm-cmm.github.io/Autumn-Note/docs.html#plugin-api)
+
+---
+
 ## API
 
 ### Factory