autumnnote 1.0.9 → 1.1.1

package/README.md

@@ -1,15 +1,16 @@
-# AutumnNote
+# Autumn Note
 
 <p align="center"><img src="image/banner.png" width="120" alt="AutumnNote Banner"/></p>
 
-[![Version](https://img.shields.io/badge/version-1.0.9-blue)](#)
+[![npm](https://img.shields.io/npm/v/autumnnote?label=version&color=blue&logo=npm)](https://www.npmjs.com/package/autumnnote)
+[![npm downloads](https://img.shields.io/npm/dw/autumnnote?label=downloads%2Fweek&logo=npm&color=cb3837)](https://www.npmjs.com/package/autumnnote)
+[![Bundle Size](https://img.shields.io/bundlephobia/minzip/autumnnote?label=minzipped&color=success)](https://bundlephobia.com/package/autumnnote)
+[![GitHub Stars](https://img.shields.io/github/stars/cmm-cmm/Autumn-Note?style=flat&logo=github&color=yellow)](https://github.com/cmm-cmm/Autumn-Note)
 [![CI](https://github.com/cmm-cmm/Autumn-Note/actions/workflows/pages.yml/badge.svg)](https://github.com/cmm-cmm/Autumn-Note/actions/workflows/pages.yml)
 [![JavaScript](https://img.shields.io/badge/JavaScript-ES2022-F7DF1E?logo=javascript&logoColor=black)](https://developer.mozilla.org/en-US/docs/Web/JavaScript)
-[![Build](https://img.shields.io/badge/Build-Vite-646CFF?logo=vite&logoColor=white)](https://vitejs.dev/)
-[![Test](https://img.shields.io/badge/Test-Vitest-6E9F18?logo=vitest&logoColor=white)](https://vitest.dev/)
 [![License](https://img.shields.io/badge/License-MIT-brightgreen)](https://opensource.org/licenses/MIT)
 [![jQuery](https://img.shields.io/badge/jQuery-free-lightgrey)](#)
-[![FontAwesome](https://img.shields.io/badge/FontAwesome-6.5.2-528DD7?logo=fontawesome&logoColor=white)](https://fontawesome.com/)
+[![TypeScript](https://img.shields.io/badge/TypeScript-definitions-3178C6?logo=typescript&logoColor=white)](types/index.d.ts)
 
 A modern, lightweight WYSIWYG rich-text editor built with vanilla JavaScript (ES2022+) — no jQuery, no heavy dependencies.
 
@@ -30,9 +31,10 @@ A modern, lightweight WYSIWYG rich-text editor built with vanilla JavaScript (ES
 5. [Options](#options)
 6. [Toolbar Customisation](#toolbar-customisation)
 7. [Keyboard Shortcuts](#keyboard-shortcuts)
-8. [Project Structure](#project-structure)
-9. [Comparison](#comparison)
-10. [License](#license)
+8. [Mentions](#mentions)
+9. [Project Structure](#project-structure)
+10. [Comparison](#comparison)
+11. [License](#license)
 
 ---
 
@@ -97,6 +99,9 @@ Right-click inside the editor opens a context menu with: **Undo**, **Redo**, **C
 - **Placeholder** — CSS `::before` pseudo-element, zero DOM node cost
 - **Read-only mode** — `readOnly: true` renders a non-editable preview with toolbar hidden; toggle at runtime via `editor.setDisabled()`
 - **Auto-save** — `autoSave: true` persists content to `localStorage` on every change; key configurable via `autoSaveKey`
+- **Auto-save restore** — when `autoSave` and `autoSaveRestore` are both `true`, a dismissible banner prompts the user to restore or discard a previously saved draft on load; configurable age window via `autoSaveRestoreTimeout`
+- **Bubble toolbar** — `bubbleToolbar: true` shows a compact floating toolbar above selected text with quick-access buttons (bold, italic, underline, strikethrough, link, text colour, remove format, inline code); button set configurable via `bubbleToolbarItems`
+- **Markdown shortcuts** — `markdownShortcuts: true` (default) converts Markdown syntax typed in the editor into HTML in real time: `# ` → H1–H3, `> ` → blockquote, `- ` / `* ` → unordered list, `1. ` → ordered list, `[ ] ` → checklist, `---` → HR, ` ``` ` → code block; inline: `**bold**`, `*italic*`, `~~strikethrough~~`, `` `code` ``
 - **Custom focus ring** — `focusColor` accepts any CSS colour string to override the default blue focus ring
 - **Spellcheck** — browser spellcheck enabled by default (`spellcheck: true`)
 
@@ -107,6 +112,7 @@ Right-click inside the editor opens a context menu with: **Undo**, **Redo**, **C
 - **Plugin-ready** — register custom modules via `AutumnNote.defaults`
 - **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`
 
 ### Security
 - All HTML (pasted content, `setHTML()`, or code-view output) passes through a DOM-based sanitiser that strips `<script>`, `<object>`, `<embed>`, and all `on*` event handler attributes
@@ -231,6 +237,36 @@ const editor = AutumnNote.create('#my-editor', {
 });
 ```
 
+### Bubble toolbar
+
+```js
+const editor = AutumnNote.create('#my-editor', {
+  bubbleToolbar: true,
+  bubbleToolbarItems: ['bold', 'italic', 'underline', 'strikethrough', 'link', 'removeFormat'],
+});
+```
+
+### @mention autocomplete
+
+```js
+const editor = AutumnNote.create('#my-editor', {
+  mention: {
+    onSearch(query, callback) {
+      const users = [
+        { id: 1, label: 'Alice' },
+        { id: 2, label: 'Bob' },
+        { id: 3, label: 'Charlie' },
+      ];
+      callback(users.filter(u => u.label.toLowerCase().includes(query.toLowerCase())));
+    },
+    onInsert(item) {
+      // optional: return custom HTML for the mention chip
+      return `<span class="mention" data-id="${item.id}">@${item.label}</span>`;
+    },
+  },
+});
+```
+
 ---
 
 ## API
@@ -320,6 +356,13 @@ const editor = AutumnNote.create('#my-editor', {
 | `colorSwatches` | `string[]` | `[]` | Custom brand colour swatches prepended to the colour picker palette. |
 | `focusColor` | `string` | `null` | Custom focus ring colour (any valid CSS colour). Overrides the default blue. |
 | `lang` | `string \| object` | `'en'` | UI display language. Built-in codes: `'en'`, `'vi'`, `'ja'`, `'zh'`, `'fr'`, `'de'`, `'es'`, `'ko'`. Pass a partial locale object for custom overrides. |
+| `markdownShortcuts` | `boolean` | `true` | Convert Markdown-style syntax typed in the editor to HTML in real time (block and inline rules). |
+| `bubbleToolbar` | `boolean` | `false` | Show a mini floating toolbar above the text selection for quick formatting. |
+| `bubbleToolbarItems` | `string[]` | `['bold','italic','underline','link','foreColor','removeFormat']` | Buttons shown in the bubble toolbar. Available names: `'bold'`, `'italic'`, `'underline'`, `'strikethrough'`, `'link'`, `'foreColor'`, `'removeFormat'`, `'inlineCode'`. |
+| `autoSaveRestore` | `boolean` | `false` | When `autoSave` is also `true`, show a restore banner on load if a draft exists. |
+| `autoSaveRestoreTimeout` | `number` | `7` | Max draft age in days before it is auto-discarded. `0` = no expiry. |
+| `onAutoSaveRestore` | `Function` | `null` | `(html, context) => void` — called after the user restores a draft. |
+| `mention` | `object` | `null` | @mention configuration object. Set `mention.onSearch` to activate. See [Mentions](#mentions). |
 | `onChange` | `Function` | `null` | `(html: string) => void` — called on every content change. |
 | `onFocus` | `Function` | `null` | `(context) => void` — called when the editor gains focus. |
 | `onBlur` | `Function` | `null` | `(context) => void` — called when the editor loses focus. |
@@ -452,6 +495,39 @@ Object.assign(AutumnNote.defaults, {
 
 ---
 
+## Mentions
+
+The `mention` option object activates `@mention` autocomplete. Only `onSearch` is required; all other fields are optional.
+
+| Field | Type | Default | Description |
+|---|---|---|---|
+| `onSearch` | `Function` | — | `(query, callback) => void` — called when the user types after the trigger character. Pass an array of `{ id, label, avatar? }` to the callback. |
+| `onInsert` | `Function` | `null` | `(item) => string \| null` — return custom HTML for the inserted mention chip. Return `null` to use the built-in chip. |
+| `trigger` | `string` | `'@'` | Character that opens the dropdown. |
+| `minChars` | `number` | `0` | Minimum characters after the trigger before `onSearch` is called. `0` = open immediately. |
+| `maxResults` | `number` | `8` | Maximum items shown in the dropdown. |
+| `debounce` | `number` | `200` | Debounce delay in milliseconds for `onSearch` calls. |
+| `mentionClass` | `string` | `'an-mention'` | CSS class applied to the inserted mention chip. |
+| `allowSpaces` | `boolean` | `false` | Allow spaces in the query string before the dropdown closes. |
+
+### Example
+
+```js
+AutumnNote.create('#editor', {
+  mention: {
+    trigger: '@',
+    minChars: 1,
+    onSearch(query, callback) {
+      fetch(`/api/users?q=${encodeURIComponent(query)}`)
+        .then(r => r.json())
+        .then(users => callback(users)); // [{ id, label, avatar? }]
+    },
+  },
+});
+```
+
+---
+
 ## Project Structure
 
 ```
@@ -495,7 +571,11 @@ src/
 │   │   ├── CodeTooltip.js    Floating toolbar for code blocks (copy/delete)
 │   │   ├── EmojiDialog.js    Unicode emoji picker (~380 emoji, 7 categories)
 │   │   ├── IconDialog.js     FontAwesome icon picker (FA 6 Free Solid, 8 categories)
-│   │   └── ShortcutsDialog.js  Keyboard shortcuts reference dialog (Shift+?)
+│   │   ├── ShortcutsDialog.js  Keyboard shortcuts reference dialog (Shift+?)
+│   │   ├── BubbleToolbar.js  Mini floating toolbar above text selection
+│   │   ├── MarkdownShortcuts.js  Inline Markdown-to-HTML input rules
+│   │   ├── AutoSaveRestore.js   Draft restore banner for localStorage drafts
+│   │   └── Mention.js        @mention autocomplete with floating dropdown
 │   ├── Context.js            Editor instance hub: module registry and event bus
 │   ├── settings.js           Default options (AsnOptions)
 │   ├── renderer.js           DOM layout builder
@@ -529,7 +609,7 @@ Build output in `dist/`:
 
 ## Comparison
 
-The table below compares AutumnNote against editors commonly used in this category. Specific library names are omitted to avoid bias.
+The table below compares AutumnNote against editors commonly used in this category — such as Summernote, Quill, TinyMCE, and Froala. Specific library names are kept generic to avoid direct bias; the comparison is based on publicly documented feature sets.
 
 | Feature | Editor A | Editor B | Editor C | **AutumnNote** |
 |---|---|---|---|---|

package/dist/autumnnote.css

@@ -1802,4 +1802,173 @@
   .an-video-resizer {
     display: none !important;
   }
+}
+.an-asr-banner {
+  display: flex;
+  align-items: center;
+  gap: 8px;
+  padding: 8px 12px;
+  background: #eff6ff;
+  border-bottom: 1px solid #bfdbfe;
+  font-size: 13px;
+  color: #1e40af;
+  flex-wrap: wrap;
+}
+.an-theme-dark .an-asr-banner {
+  background: #1e3a5f;
+  border-bottom-color: #1e4d8c;
+  color: #93c5fd;
+}
+
+.an-asr-msg {
+  flex: 1;
+  min-width: 0;
+}
+
+.an-asr-btn-restore {
+  padding: 3px 10px;
+  font-size: 12px;
+  font-weight: 600;
+  background: #3b82f6;
+  color: #fff;
+  border: none;
+  border-radius: 4px;
+  cursor: pointer;
+  line-height: 1.5;
+}
+.an-asr-btn-restore:hover {
+  background: #2563eb;
+}
+
+.an-asr-btn-discard {
+  padding: 3px 10px;
+  font-size: 12px;
+  background: transparent;
+  color: #6b7280;
+  border: 1px solid #d1d5db;
+  border-radius: 4px;
+  cursor: pointer;
+  line-height: 1.5;
+}
+.an-asr-btn-discard:hover {
+  background: #f3f4f6;
+}
+
+.an-bubble-toolbar {
+  display: none;
+  position: fixed;
+  z-index: 10040;
+  background: #ffffff;
+  border: 1px solid #d1d5db;
+  border-radius: 8px;
+  padding: 4px 6px;
+  gap: 2px;
+  box-shadow: 0 8px 28px rgba(0, 0, 0, 0.14);
+  align-items: center;
+  animation: an-bubble-in 0.1s ease;
+  pointer-events: auto;
+  user-select: none;
+}
+.an-theme-dark .an-bubble-toolbar {
+  background: #24273a;
+  border-color: #3f3f5f;
+}
+
+@keyframes an-bubble-in {
+  from {
+    opacity: 0;
+    transform: translateY(4px);
+  }
+  to {
+    opacity: 1;
+    transform: translateY(0);
+  }
+}
+.an-bubble-btn {
+  display: flex;
+  align-items: center;
+  justify-content: center;
+  width: 28px;
+  height: 28px;
+  padding: 0;
+  background: transparent;
+  border: none;
+  border-radius: 5px;
+  color: #111827;
+  cursor: pointer;
+  transition: background 0.15s ease, color 0.15s ease;
+}
+.an-bubble-btn svg {
+  pointer-events: none;
+  stroke: currentColor;
+}
+.an-bubble-btn:hover {
+  background: #f3f4f6;
+  color: #111827;
+}
+.an-bubble-btn.an-active {
+  background: #dbeafe;
+  color: #3b82f6;
+}
+.an-theme-dark .an-bubble-btn {
+  color: #cdd6f4;
+}
+.an-theme-dark .an-bubble-btn:hover {
+  background: #313244;
+}
+.an-theme-dark .an-bubble-btn.an-active {
+  background: #1e3a5f;
+  color: #93c5fd;
+}
+
+.an-mention-dropdown {
+  display: none;
+  position: fixed;
+  z-index: 9998;
+  background: #ffffff;
+  border: 1px solid #d1d5db;
+  border-radius: 6px;
+  box-shadow: 0 4px 16px rgba(0, 0, 0, 0.12);
+  min-width: 180px;
+  max-width: 280px;
+  max-height: 240px;
+  overflow-y: auto;
+  padding: 4px 0;
+}
+
+.an-mention-item {
+  display: flex;
+  align-items: center;
+  gap: 8px;
+  padding: 6px 12px;
+  cursor: pointer;
+  font-size: 13px;
+  color: #111827;
+  transition: background 0.15s ease;
+}
+.an-mention-item:hover, .an-mention-item.an-mention-active {
+  background: #f3f4f6;
+}
+
+.an-mention-avatar {
+  width: 24px;
+  height: 24px;
+  border-radius: 50%;
+  object-fit: cover;
+  flex-shrink: 0;
+}
+
+.an-mention {
+  display: inline;
+  background: #eff6ff;
+  color: #3b82f6;
+  border-radius: 3px;
+  padding: 0 3px;
+  font-weight: 500;
+  cursor: default;
+  user-select: all;
+}
+.an-theme-dark .an-mention {
+  background: #1e3a5f;
+  color: #93c5fd;
 }/*$vite$:1*/