@blockslides/extension-bubble-menu-preset 0.1.0

package/LICENSE.md

@@ -0,0 +1,36 @@
+MIT License
+
+Copyright (c) 2025 BlockSlides
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+---
+
+## Acknowledgments
+
+This project includes code and patterns adapted from [Tiptap](https://tiptap.dev),
+an open-source headless editor framework for web artisans.
+
+**Tiptap License:**
+
+- Copyright (c) 2025, Tiptap GmbH
+- Licensed under MIT License
+- Original source: https://github.com/ueberdosis/tiptap
+
+See `_tiptap/LICENSE.md` for the full Tiptap license.

package/README.md

@@ -0,0 +1,74 @@
+# BubbleMenuPreset
+
+Opinionated bubble menu with built-in actions (undo/redo, font family/size, bold, italic, underline, text color, highlight color, link, align) on top of `@blockslides/extension-bubble-menu`. Provides a ready-to-use menu element, palettes, and sensible defaults.
+
+## Install
+
+```bash
+npm install @blockslides/extension-bubble-menu-preset
+# pnpm add @blockslides/extension-bubble-menu-preset
+# yarn add @blockslides/extension-bubble-menu-preset
+```
+
+Peer deps you’ll typically also want loaded:
+- `@blockslides/extensions/undo-redo`
+- `@blockslides/extension-text-style` (color, fontFamily, fontSize)
+- `@blockslides/extension-highlight` (with `multicolor: true` for per-color)
+- `@blockslides/extension-link`
+- `@blockslides/extension-text-align`
+
+## Usage
+
+```ts
+import BubbleMenuPreset from '@blockslides/extension-bubble-menu-preset'
+import { UndoRedo } from '@blockslides/extensions/undo-redo'
+import { Highlight } from '@blockslides/extension-highlight'
+import { Color, FontFamily, FontSize } from '@blockslides/extension-text-style'
+import { Link } from '@blockslides/extension-link'
+import { TextAlign } from '@blockslides/extension-text-align'
+
+new Editor({
+  extensions: [
+    UndoRedo,
+    Color,
+    FontFamily,
+    FontSize,
+    Highlight.configure({ multicolor: true }),
+    Link,
+    TextAlign.configure({ types: ['paragraph', 'heading'] }),
+    BubbleMenuPreset.configure({
+      // items is optional; defaults to the full preset shown below.
+      // items: [
+      //   'undo','redo',
+      //   'fontFamily','fontSize',
+      //   'bold','italic','underline',
+      //   'textColor','highlightColor',
+      //   'link','align',
+      // ],
+      // optional overrides:
+      // textColors, highlightColors, fonts, fontSizes, alignments,
+      // className, injectStyles, options (placement/offset/flip...), shouldShow, appendTo
+    }),
+  ],
+})
+```
+
+## What you get
+- Built-in controls with sensible defaults and hover states; white background, ~20% radius.
+- Swatch grids for text and highlight colors + “None” + custom color input; auto-repositions via `setMeta('bubbleMenu','updatePosition')`.
+- Disables buttons if commands are absent. If you pass your own `element`, the preset won’t inject its own.
+
+## Options (overrides)
+- `items`: order of built-ins. Defaults: `['undo','redo','fontFamily','fontSize','bold','italic','underline','textColor','highlightColor','link','align']`.
+- `textColors`, `highlightColors`: palettes (arrays of strings).
+- `fonts`, `fontSizes`, `alignments`: dropdown choices.
+- `className`: extra class on the root element.
+- `injectStyles`: set `false` to provide your own styles.
+- `options`: forwarded to Floating UI via `@blockslides/extension-bubble-menu` (`placement`, `strategy`, `offset`, `flip`, `shift`, etc.).
+- `shouldShow`, `appendTo`, `pluginKey`, `updateDelay`, `resizeDelay`, `getReferencedVirtualElement`: same semantics as the base bubble menu.
+
+## Notes
+- Highlight color requires `Highlight.configure({ multicolor: true })` to respect per-color values.
+- Link prompt is simple; replace with your own UI by supplying a custom `element` or swapping the handler.
+- If the menu size changes (e.g., palette open/close), the preset emits `setMeta('bubbleMenu','updatePosition')` to keep positioning correct.
+