visbug-editor 0.1.0

package/LICENSE

@@ -0,0 +1,169 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+   1. Definitions.
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+   END OF TERMS AND CONDITIONS
+   APPENDIX: How to apply the Apache License to your work.
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+   Copyright [yyyy] [name of copyright owner]
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,490 @@
+# visbug-editor
+
+Core editing features extracted from [VisBug](https://github.com/GoogleChromeLabs/ProjectVisBug) for use in web applications.
+
+[![npm version](https://img.shields.io/npm/v/visbug-editor.svg)](https://www.npmjs.com/package/visbug-editor)
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+
+## Overview
+
+`visbug-editor` is a framework-agnostic library that provides inline visual editing capabilities. It allows users to directly manipulate content within a container element, with support for:
+
+- **Position Tool**: Drag-and-drop positioning and arrow key nudging
+- **Text Tool**: Inline text editing with contenteditable
+- **Font Tool**: Typography controls (size, weight, style, spacing)
+- **Image Tool**: Drag and drop image replacement
+
+All operations include full undo/redo support with smart change batching.
+
+## Features
+
+**Visual Editing Tools**
+- Position Tool - Drag elements to reposition, use arrow keys for precise movement
+- Text Tool - Inline text editing
+- Font Tool - Typography controls (size, spacing, weight, style)
+- Image Swap - Drag-and-drop image replacement
+
+**Built-in Components**
+- Selection overlay with resize handles (8 grips: corners + edges)
+- Hover indicators with element labels
+- Visual feedback for all interactions
+- Dynamic overlay updates when elements change
+
+**History Management**
+- Full undo/redo support
+- Smart change batching and merging
+- Event-based change notifications
+
+**Framework Agnostic**
+- Works with vanilla JS, React, Vue, Angular, etc.
+- Shadow DOM or regular DOM mode
+- TypeScript definitions included
+
+## Installation
+
+```bash
+npm install visbug-editor
+```
+
+Or with yarn:
+
+```bash
+yarn add visbug-editor
+```
+
+## Quick Start
+
+### Basic Usage
+
+```javascript
+import { VisBugEditor } from 'visbug-editor';
+
+const editor = new VisBugEditor({
+  container: document.getElementById('editable-area'),
+  initialTool: 'position',
+  onToolChange: (tool) => console.log('Tool changed:', tool),
+  onSelectionChange: (elements) => console.log('Selected:', elements),
+  onChange: ({ canUndo, canRedo }) => {
+    console.log('Can undo:', canUndo, 'Can redo:', canRedo);
+  }
+});
+
+// Switch tools
+editor.activateTool('text');
+editor.activateTool('font');
+
+// Undo/Redo
+editor.undo();
+editor.redo();
+
+// Get/Set content
+const html = editor.getContent();
+editor.setContent('<h1>New content</h1>');
+
+// Clean up
+editor.destroy();
+```
+
+### TypeScript
+
+Full TypeScript support with complete type definitions:
+
+```typescript
+import { VisBugEditor, VisBugEditorOptions } from 'visbug-editor';
+
+const options: VisBugEditorOptions = {
+  container: document.getElementById('app')!,
+  mode: 'shadowDOM',
+  initialTool: 'position',
+  onToolChange: (tool: string) => {
+    console.log('Tool:', tool);
+  }
+};
+
+const editor = new VisBugEditor(options);
+```
+
+## Container Concept
+
+When you pass a container to the editor, **the children of the container become editable**, not the container itself:
+
+```html
+<div id="my-container">
+  <!-- This h1 is editable -->
+  <h1>Editable Heading</h1>
+
+  <!-- This paragraph is editable -->
+  <p>You can edit this text</p>
+
+  <!-- This image is swappable -->
+  <img src="image.jpg" />
+</div>
+```
+
+```javascript
+const editor = new VisBugEditor({
+  container: document.getElementById('my-container')
+});
+```
+
+The container acts as the "editing canvas" boundary.
+
+## API Reference
+
+### Constructor Options
+
+```typescript
+interface VisBugEditorOptions {
+  // Required
+  container: HTMLElement;              // Container whose children will be editable
+
+  // Optional
+  mode?: 'shadowDOM' | 'div';          // Default: 'shadowDOM'
+  initialTool?: 'position' | 'text' | 'font'; // Default: 'position'
+
+  // Callbacks
+  onToolChange?: (tool: string) => void;
+  onSelectionChange?: (elements: HTMLElement[]) => void;
+  onChange?: (state: { canUndo: boolean; canRedo: boolean }) => void;
+  onImageUpload?: (file: File) => Promise<string>;
+
+  // Customization
+  styles?: Record<string, string>;
+
+  // Behavior
+  clearHistoryOnSetContent?: boolean;  // Default: true
+}
+```
+
+### Methods
+
+**Tool Management**
+- `activateTool(toolName)` - Switch to a different tool ('position', 'text', 'font')
+- `getCurrentTool()` - Get the currently active tool
+
+**Selection**
+- `selectElement(element)` - Select a single element
+- `selectElements(elements)` - Select multiple elements
+- `getSelectedElements()` - Get currently selected elements
+- `clearSelection()` - Clear current selection
+
+**History**
+- `undo()` - Undo the last change
+- `redo()` - Redo the last undone change
+- `canUndo()` - Check if undo is available
+- `canRedo()` - Check if redo is available
+- `getHistory()` - Get the history array
+- `clearHistory()` - Clear the history
+
+**Content**
+- `getContent()` - Get clean HTML without editor UI
+- `setContent(html)` - Set content and optionally clear history
+
+**Lifecycle**
+- `destroy()` - Clean up and destroy the editor
+
+## Tools
+
+### Position Tool (Default)
+
+Drag elements to reposition them. Uses keyboard shortcuts for precise control:
+
+- **Arrow Keys** - Move 1px
+- **Shift + Arrow** - Move 10px
+- **Alt + Arrow** - Move 0.5px
+
+Automatically records changes to history for undo/redo.
+
+### Text Tool
+
+Click on any element to edit its text content inline using contenteditable. Press Enter or click outside to finish editing.
+
+### Font Tool
+
+Typography controls with keyboard shortcuts:
+
+**Font Size**
+- `Cmd/Ctrl + Up` - Increase font size
+- `Cmd/Ctrl + Down` - Decrease font size
+
+**Letter Spacing (Kerning)**
+- `Cmd/Ctrl + Shift + Up` - Increase letter spacing
+- `Cmd/Ctrl + Shift + Down` - Decrease letter spacing
+
+**Line Height (Leading)**
+- `Alt + Up` - Increase line height
+- `Alt + Down` - Decrease line height
+
+**Font Weight**
+- `Cmd/Ctrl + B` - Toggle bold
+
+**Font Style**
+- `Cmd/Ctrl + I` - Toggle italic
+
+### Image Swap (Always Active)
+
+Drag and drop images onto any `<img>` tag or element with a background image to replace it. Supports:
+- Direct image URL replacement
+- Custom upload handler via `onImageUpload` callback
+
+## Examples
+
+### React Integration
+
+```jsx
+import { useEffect, useRef, useState } from 'react';
+import { VisBugEditor } from 'visbug-editor';
+
+function Editor() {
+  const containerRef = useRef(null);
+  const editorRef = useRef(null);
+  const [canUndo, setCanUndo] = useState(false);
+  const [canRedo, setCanRedo] = useState(false);
+
+  useEffect(() => {
+    if (containerRef.current && !editorRef.current) {
+      editorRef.current = new VisBugEditor({
+        container: containerRef.current,
+        onChange: ({ canUndo, canRedo }) => {
+          setCanUndo(canUndo);
+          setCanRedo(canRedo);
+        }
+      });
+    }
+
+    return () => {
+      editorRef.current?.destroy();
+    };
+  }, []);
+
+  return (
+    <div>
+      <button onClick={() => editorRef.current?.undo()} disabled={!canUndo}>
+        Undo
+      </button>
+      <button onClick={() => editorRef.current?.redo()} disabled={!canRedo}>
+        Redo
+      </button>
+      <div ref={containerRef}>
+        <h1>Editable Content</h1>
+      </div>
+    </div>
+  );
+}
+```
+
+### Vue Integration
+
+```vue
+<template>
+  <div>
+    <button @click="undo" :disabled="!canUndo">Undo</button>
+    <button @click="redo" :disabled="!canRedo">Redo</button>
+    <div ref="container">
+      <h1>Editable Content</h1>
+    </div>
+  </div>
+</template>
+
+<script setup>
+import { ref, onMounted, onUnmounted } from 'vue';
+import { VisBugEditor } from 'visbug-editor';
+
+const container = ref(null);
+const canUndo = ref(false);
+const canRedo = ref(false);
+let editor = null;
+
+onMounted(() => {
+  editor = new VisBugEditor({
+    container: container.value,
+    onChange: ({ canUndo: cu, canRedo: cr }) => {
+      canUndo.value = cu;
+      canRedo.value = cr;
+    }
+  });
+});
+
+onUnmounted(() => {
+  editor?.destroy();
+});
+
+const undo = () => editor?.undo();
+const redo = () => editor?.redo();
+</script>
+```
+
+### Next.js Integration
+
+```jsx
+"use client";
+
+import { useEffect, useRef, useState } from "react";
+import { VisBugEditor } from "visbug-editor";
+
+export default function EditableContent() {
+  const containerRef = useRef(null);
+  const editorRef = useRef(null);
+  const [activeTool, setActiveTool] = useState("position");
+  const [canUndo, setCanUndo] = useState(false);
+  const [canRedo, setCanRedo] = useState(false);
+
+  useEffect(() => {
+    if (containerRef.current && !editorRef.current) {
+      editorRef.current = new VisBugEditor({
+        container: containerRef.current,
+        mode: "shadowDOM",
+        initialTool: "position",
+        onToolChange: (tool) => setActiveTool(tool),
+        onChange: (state) => {
+          setCanUndo(state.canUndo);
+          setCanRedo(state.canRedo);
+        },
+      });
+    }
+
+    return () => {
+      editorRef.current?.destroy();
+      editorRef.current = null;
+    };
+  }, []);
+
+  return (
+    <div className="editor-wrapper">
+      <div className="toolbar">
+        <button onClick={() => editorRef.current?.activateTool("position")}>
+          Position
+        </button>
+        <button onClick={() => editorRef.current?.activateTool("text")}>
+          Text
+        </button>
+        <button onClick={() => editorRef.current?.activateTool("font")}>
+          Font
+        </button>
+        <button onClick={() => editorRef.current?.undo()} disabled={!canUndo}>
+          Undo
+        </button>
+        <button onClick={() => editorRef.current?.redo()} disabled={!canRedo}>
+          Redo
+        </button>
+      </div>
+
+      <div ref={containerRef} className="editable-area">
+        <h1>Edit Me!</h1>
+        <p>This content is editable</p>
+      </div>
+    </div>
+  );
+}
+```
+
+### Custom Image Upload
+
+```javascript
+const editor = new VisBugEditor({
+  container: document.getElementById('app'),
+  onImageUpload: async (file) => {
+    // Upload to your server
+    const formData = new FormData();
+    formData.append('image', file);
+    
+    const response = await fetch('/api/upload', {
+      method: 'POST',
+      body: formData
+    });
+    
+    const { url } = await response.json();
+    return url; // Return the uploaded image URL
+  }
+});
+```
+
+## Shadow DOM vs Div Mode
+
+### Shadow DOM (Recommended)
+
+**Pros:**
+- Style isolation between editor and content
+- DOM encapsulation
+- No style conflicts
+
+**Cons:**
+- Not supported in very old browsers
+- Slight complexity in event handling
+
+### Div Mode (Fallback)
+
+**Pros:**
+- Universal browser support
+- Simpler event handling
+
+**Cons:**
+- Potential style conflicts
+- Editor styles may affect content
+
+The library automatically falls back to div mode if Shadow DOM is not supported.
+
+## Content Persistence
+
+### Saving Content
+
+```javascript
+// Get clean HTML (without editor UI)
+const html = editor.getContent();
+
+// Save to backend
+await fetch("/api/save", {
+  method: "POST",
+  body: JSON.stringify({ html }),
+});
+```
+
+### Loading Content
+
+```javascript
+// Load from backend
+const response = await fetch("/api/content/123");
+const { html } = await response.json();
+
+// Set content (clears selection and optionally history)
+editor.setContent(html);
+```
+
+## Browser Support
+
+- Chrome/Edge 80+
+- Firefox 75+
+- Safari 13.1+
+
+Requires support for:
+- ES6 Modules
+- Custom Elements
+- Shadow DOM (optional, falls back to regular DOM)
+- MutationObserver
+
+## Bundle Size
+
+- ESM: ~144 KB (uncompressed)
+- Browser: ~153 KB (uncompressed)
+- CJS: ~144 KB (uncompressed)
+- UMD: ~144 KB (uncompressed)
+
+All builds include source maps for debugging.
+
+## License
+
+Apache-2.0
+
+## Credits
+
+Extracted from [VisBug](https://github.com/GoogleChromeLabs/ProjectVisBug) by Adam Argyle.
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## Links
+
+- [GitHub Repository](https://github.com/GoogleChromeLabs/ProjectVisBug)
+- [Issue Tracker](https://github.com/GoogleChromeLabs/ProjectVisBug/issues)
+- [Original VisBug](https://github.com/GoogleChromeLabs/ProjectVisBug)