agentation 1.1.1 → 1.3.0

package/README.md

@@ -33,9 +33,78 @@ The toolbar appears in the bottom-right corner. Click to activate, then click an
 - **Area selection** – Drag to annotate any region, even empty space
 - **Animation pause** – Freeze CSS animations to capture specific states
 - **Structured output** – Copy markdown with selectors, positions, and context
+- **Programmatic access** – Callback prop for direct integration with tools
 - **Dark/light mode** – Matches your preference or set manually
 - **Zero dependencies** – Pure CSS animations, no runtime libraries
 
+## Props
+
+| Prop | Type | Default | Description |
+|------|------|---------|-------------|
+| `onAnnotationAdd` | `(annotation: Annotation) => void` | - | Called when an annotation is created |
+| `onAnnotationDelete` | `(annotation: Annotation) => void` | - | Called when an annotation is deleted |
+| `onAnnotationUpdate` | `(annotation: Annotation) => void` | - | Called when an annotation is edited |
+| `onAnnotationsClear` | `(annotations: Annotation[]) => void` | - | Called when all annotations are cleared |
+| `onCopy` | `(markdown: string) => void` | - | Callback with markdown output when copy is clicked |
+| `copyToClipboard` | `boolean` | `true` | Set to false to prevent writing to clipboard |
+
+### Programmatic Integration
+
+Use callbacks to receive annotation data directly:
+
+```tsx
+import { Agentation, type Annotation } from 'agentation';
+
+function App() {
+  const handleAnnotation = (annotation: Annotation) => {
+    // Structured data - no parsing needed
+    console.log(annotation.element);      // "Button"
+    console.log(annotation.elementPath);  // "body > div > button"
+    console.log(annotation.boundingBox);  // { x, y, width, height }
+    console.log(annotation.cssClasses);   // "btn btn-primary"
+
+    // Send to your agent, API, etc.
+    sendToAgent(annotation);
+  };
+
+  return (
+    <>
+      <YourApp />
+      <Agentation
+        onAnnotationAdd={handleAnnotation}
+        copyToClipboard={false}  // Don't write to clipboard
+      />
+    </>
+  );
+}
+```
+
+### Annotation Type
+
+```typescript
+type Annotation = {
+  id: string;
+  x: number;                    // % of viewport width
+  y: number;                    // px from top (viewport if fixed)
+  comment: string;              // User's note
+  element: string;              // e.g., "Button"
+  elementPath: string;          // e.g., "body > div > button"
+  timestamp: number;
+
+  // Optional metadata (when available)
+  selectedText?: string;
+  boundingBox?: { x: number; y: number; width: number; height: number };
+  nearbyText?: string;
+  cssClasses?: string;
+  nearbyElements?: string;
+  computedStyles?: string;
+  fullPath?: string;
+  accessibility?: string;
+  isMultiSelect?: boolean;
+  isFixed?: boolean;
+};
+```
+
 ## How it works
 
 Agentation captures class names, selectors, and element positions so AI agents can `grep` for the exact code you're referring to. Instead of describing "the blue button in the sidebar," you give the agent `.sidebar > button.primary` and your feedback.

package/dist/index.d.mts

@@ -1,6 +1,31 @@
 import * as react from 'react';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 
+type Annotation = {
+    id: string;
+    x: number;
+    y: number;
+    comment: string;
+    element: string;
+    elementPath: string;
+    timestamp: number;
+    selectedText?: string;
+    boundingBox?: {
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+    };
+    nearbyText?: string;
+    cssClasses?: string;
+    nearbyElements?: string;
+    computedStyles?: string;
+    fullPath?: string;
+    accessibility?: string;
+    isMultiSelect?: boolean;
+    isFixed?: boolean;
+};
+
 type DemoAnnotation = {
     selector: string;
     comment: string;
@@ -10,8 +35,22 @@ type PageFeedbackToolbarCSSProps = {
     demoAnnotations?: DemoAnnotation[];
     demoDelay?: number;
     enableDemoMode?: boolean;
+    /** Callback fired when an annotation is added. */
+    onAnnotationAdd?: (annotation: Annotation) => void;
+    /** Callback fired when an annotation is deleted. */
+    onAnnotationDelete?: (annotation: Annotation) => void;
+    /** Callback fired when an annotation comment is edited. */
+    onAnnotationUpdate?: (annotation: Annotation) => void;
+    /** Callback fired when all annotations are cleared. Receives the annotations that were cleared. */
+    onAnnotationsClear?: (annotations: Annotation[]) => void;
+    /** Callback fired when the copy button is clicked. Receives the markdown output. */
+    onCopy?: (markdown: string) => void;
+    /** Whether to copy to clipboard when the copy button is clicked. Defaults to true. */
+    copyToClipboard?: boolean;
 };
-declare function PageFeedbackToolbarCSS({ demoAnnotations, demoDelay, enableDemoMode, }?: PageFeedbackToolbarCSSProps): react.ReactPortal | null;
+/** Alias for PageFeedbackToolbarCSSProps */
+type AgentationProps = PageFeedbackToolbarCSSProps;
+declare function PageFeedbackToolbarCSS({ demoAnnotations, demoDelay, enableDemoMode, onAnnotationAdd, onAnnotationDelete, onAnnotationUpdate, onAnnotationsClear, onCopy, copyToClipboard, }?: PageFeedbackToolbarCSSProps): react.ReactPortal | null;
 
 interface AnnotationPopupCSSProps {
     /** Element name to display in header */
@@ -163,33 +202,8 @@ declare function identifyAnimationElement(target: HTMLElement): string;
  */
 declare function getElementClasses(target: HTMLElement): string;
 
-type Annotation = {
-    id: string;
-    x: number;
-    y: number;
-    comment: string;
-    element: string;
-    elementPath: string;
-    timestamp: number;
-    selectedText?: string;
-    boundingBox?: {
-        x: number;
-        y: number;
-        width: number;
-        height: number;
-    };
-    nearbyText?: string;
-    cssClasses?: string;
-    nearbyElements?: string;
-    computedStyles?: string;
-    fullPath?: string;
-    accessibility?: string;
-    isMultiSelect?: boolean;
-    isFixed?: boolean;
-};
-
 declare function getStorageKey(pathname: string): string;
 declare function loadAnnotations<T = Annotation>(pathname: string): T[];
 declare function saveAnnotations<T = Annotation>(pathname: string, annotations: T[]): void;
 
-export { PageFeedbackToolbarCSS as Agentation, AnimatedBunny, type Annotation, AnnotationPopupCSS, type AnnotationPopupCSSHandle, type AnnotationPopupCSSProps, type DemoAnnotation, IconChatEllipsis, IconCheck, IconCheckSmall, IconCheckSmallAnimated, IconCheckmark, IconCheckmarkCircle, IconCheckmarkLarge, IconClose, IconCopyAlt, IconCopyAnimated, IconEye, IconEyeAlt, IconEyeAnimated, IconEyeClosed, IconEyeMinus, IconGear, IconHelp, IconListSparkle, IconMoon, IconPause, IconPauseAlt, IconPausePlayAnimated, IconPlayAlt, IconPlus, IconSun, IconTrashAlt, IconXmark, IconXmarkLarge, PageFeedbackToolbarCSS, getElementClasses, getElementPath, getNearbyText, getStorageKey, identifyAnimationElement, identifyElement, loadAnnotations, saveAnnotations };
+export { PageFeedbackToolbarCSS as Agentation, type AgentationProps, AnimatedBunny, type Annotation, AnnotationPopupCSS, type AnnotationPopupCSSHandle, type AnnotationPopupCSSProps, type DemoAnnotation, IconChatEllipsis, IconCheck, IconCheckSmall, IconCheckSmallAnimated, IconCheckmark, IconCheckmarkCircle, IconCheckmarkLarge, IconClose, IconCopyAlt, IconCopyAnimated, IconEye, IconEyeAlt, IconEyeAnimated, IconEyeClosed, IconEyeMinus, IconGear, IconHelp, IconListSparkle, IconMoon, IconPause, IconPauseAlt, IconPausePlayAnimated, IconPlayAlt, IconPlus, IconSun, IconTrashAlt, IconXmark, IconXmarkLarge, PageFeedbackToolbarCSS, getElementClasses, getElementPath, getNearbyText, getStorageKey, identifyAnimationElement, identifyElement, loadAnnotations, saveAnnotations };

package/dist/index.d.ts

@@ -1,6 +1,31 @@
 import * as react from 'react';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 
+type Annotation = {
+    id: string;
+    x: number;
+    y: number;
+    comment: string;
+    element: string;
+    elementPath: string;
+    timestamp: number;
+    selectedText?: string;
+    boundingBox?: {
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+    };
+    nearbyText?: string;
+    cssClasses?: string;
+    nearbyElements?: string;
+    computedStyles?: string;
+    fullPath?: string;
+    accessibility?: string;
+    isMultiSelect?: boolean;
+    isFixed?: boolean;
+};
+
 type DemoAnnotation = {
     selector: string;
     comment: string;
@@ -10,8 +35,22 @@ type PageFeedbackToolbarCSSProps = {
     demoAnnotations?: DemoAnnotation[];
     demoDelay?: number;
     enableDemoMode?: boolean;
+    /** Callback fired when an annotation is added. */
+    onAnnotationAdd?: (annotation: Annotation) => void;
+    /** Callback fired when an annotation is deleted. */
+    onAnnotationDelete?: (annotation: Annotation) => void;
+    /** Callback fired when an annotation comment is edited. */
+    onAnnotationUpdate?: (annotation: Annotation) => void;
+    /** Callback fired when all annotations are cleared. Receives the annotations that were cleared. */
+    onAnnotationsClear?: (annotations: Annotation[]) => void;
+    /** Callback fired when the copy button is clicked. Receives the markdown output. */
+    onCopy?: (markdown: string) => void;
+    /** Whether to copy to clipboard when the copy button is clicked. Defaults to true. */
+    copyToClipboard?: boolean;
 };
-declare function PageFeedbackToolbarCSS({ demoAnnotations, demoDelay, enableDemoMode, }?: PageFeedbackToolbarCSSProps): react.ReactPortal | null;
+/** Alias for PageFeedbackToolbarCSSProps */
+type AgentationProps = PageFeedbackToolbarCSSProps;
+declare function PageFeedbackToolbarCSS({ demoAnnotations, demoDelay, enableDemoMode, onAnnotationAdd, onAnnotationDelete, onAnnotationUpdate, onAnnotationsClear, onCopy, copyToClipboard, }?: PageFeedbackToolbarCSSProps): react.ReactPortal | null;
 
 interface AnnotationPopupCSSProps {
     /** Element name to display in header */
@@ -163,33 +202,8 @@ declare function identifyAnimationElement(target: HTMLElement): string;
  */
 declare function getElementClasses(target: HTMLElement): string;
 
-type Annotation = {
-    id: string;
-    x: number;
-    y: number;
-    comment: string;
-    element: string;
-    elementPath: string;
-    timestamp: number;
-    selectedText?: string;
-    boundingBox?: {
-        x: number;
-        y: number;
-        width: number;
-        height: number;
-    };
-    nearbyText?: string;
-    cssClasses?: string;
-    nearbyElements?: string;
-    computedStyles?: string;
-    fullPath?: string;
-    accessibility?: string;
-    isMultiSelect?: boolean;
-    isFixed?: boolean;
-};
-
 declare function getStorageKey(pathname: string): string;
 declare function loadAnnotations<T = Annotation>(pathname: string): T[];
 declare function saveAnnotations<T = Annotation>(pathname: string, annotations: T[]): void;
 
-export { PageFeedbackToolbarCSS as Agentation, AnimatedBunny, type Annotation, AnnotationPopupCSS, type AnnotationPopupCSSHandle, type AnnotationPopupCSSProps, type DemoAnnotation, IconChatEllipsis, IconCheck, IconCheckSmall, IconCheckSmallAnimated, IconCheckmark, IconCheckmarkCircle, IconCheckmarkLarge, IconClose, IconCopyAlt, IconCopyAnimated, IconEye, IconEyeAlt, IconEyeAnimated, IconEyeClosed, IconEyeMinus, IconGear, IconHelp, IconListSparkle, IconMoon, IconPause, IconPauseAlt, IconPausePlayAnimated, IconPlayAlt, IconPlus, IconSun, IconTrashAlt, IconXmark, IconXmarkLarge, PageFeedbackToolbarCSS, getElementClasses, getElementPath, getNearbyText, getStorageKey, identifyAnimationElement, identifyElement, loadAnnotations, saveAnnotations };
+export { PageFeedbackToolbarCSS as Agentation, type AgentationProps, AnimatedBunny, type Annotation, AnnotationPopupCSS, type AnnotationPopupCSSHandle, type AnnotationPopupCSSProps, type DemoAnnotation, IconChatEllipsis, IconCheck, IconCheckSmall, IconCheckSmallAnimated, IconCheckmark, IconCheckmarkCircle, IconCheckmarkLarge, IconClose, IconCopyAlt, IconCopyAnimated, IconEye, IconEyeAlt, IconEyeAnimated, IconEyeClosed, IconEyeMinus, IconGear, IconHelp, IconListSparkle, IconMoon, IconPause, IconPauseAlt, IconPausePlayAnimated, IconPlayAlt, IconPlus, IconSun, IconTrashAlt, IconXmark, IconXmarkLarge, PageFeedbackToolbarCSS, getElementClasses, getElementPath, getNearbyText, getStorageKey, identifyAnimationElement, identifyElement, loadAnnotations, saveAnnotations };