Live Preview: Svelte Agentation
Svelte Agentation turns UI annotations into structured context that AI coding agents can understand and act on.
pnpm i sv-agentation
npm i sv-agentation
bun i sv-agentation
yarn add sv-agentation
<script lang="ts">
import { browser, dev } from '$app/environment';
import { Agentation } from 'sv-agentation';
</script>
{#if browser && dev}
<Agentation />
{/if}
Mount the inspector only in development and only in the browser.
<script lang="ts">
import { browser, dev } from '$app/environment';
import { Agentation } from 'sv-agentation';
// Absolute path to project root
let workspaceRoot = 'C:/Users/YourName/Projects/YourProject';
</script>
{#if browser && dev}
<Agentation {workspaceRoot} openSourceOnClick />
{/if}
<script lang="ts">
import { browser, dev } from '$app/environment';
import { Agentation } from 'sv-agentation';
import type { AgentationAnnotationSnapshot, AgentationExportPayload } from 'sv-agentation';
function handleAnnotationAdd(annotation : AgentationAnnotationSnapshot) {
console.log('New annotation added:', annotation);
}
function handleCopy(markdown : string, payload : AgentationExportPayload) {
console.log('Notes copied:', markdown, payload);
}
</script>
{#if browser && dev}
<Agentation onAnnotationAdd={handleAnnotationAdd} onCopy={handleCopy} />
{/if}
| Shortcut | Action | Description |
|---|---|---|
i |
Toggle inspector | Open or close the inspector toolbar and annotation mode. |
c |
Copy all notes | Copy notes as Markdown when at least one note exists. |
r |
Reset toolbar position | Move the floating toolbar back to the latest explicit prop value, saved placement, or default. |
o |
Open source | Open the currently hovered source location when the inspector is active. |
esc |
Cancel current action | Clear transient selections, close the composer, or close settings/delete state. |
shift + ctrl/cmd + click |
Build a group selection | Add or remove elements from a grouped annotation target before releasing the modifiers. |
compact, standard, detailed, or forensic output modes.browser && dev.| Prop | Type | Description |
|---|---|---|
workspaceRoot |
string | null |
Absolute project root for source lookup and editor links. |
selector |
string | null |
Optional selector to scope inspectable elements. |
vscodeScheme |
'vscode' | 'vscode-insiders' |
Choose the VS Code URL scheme for open-in-editor actions. |
openSourceOnClick |
boolean |
Open source directly on click instead of only showing metadata. |
deleteAllDelayMs |
number |
Confirmation delay for delete-all notes. |
toolbarPosition |
'top-left' | 'top-center' | 'top-right' | 'mid-right' | 'mid-left' | 'bottom-left' | 'bottom-center' | 'bottom-right' |
When provided, syncs the floating toolbar to this preset and stores it as the latest saved placement. |
outputMode |
'compact' | 'standard' | 'detailed' | 'forensic' |
When provided, syncs the copy/export mode and stores it for later sessions. |
pauseAnimations |
boolean |
When provided, syncs animation pausing while the inspector is active and stores it for later sessions. |
clearOnCopy |
boolean |
When provided, syncs whether copied notes are cleared and stores it for later sessions. |
includeComponentContext |
boolean |
When provided, syncs component-context capture and stores it for later sessions. |
includeComputedStyles |
boolean |
When provided, syncs computed-style capture and stores it for later sessions. |
copyToClipboard |
boolean |
Disable direct clipboard writes and use callbacks only. |
onAnnotationAdd |
(annotation) => void |
Called after a note is created. |
onAnnotationUpdate |
(annotation) => void |
Called after a note is updated. |
onAnnotationDelete |
(annotation) => void |
Called after a note is deleted. |
onAnnotationsClear |
(annotations) => void |
Called after all notes are cleared. |
onCopy |
(markdown, payload) => void |
Called after note export is prepared. |
This project is highly inspired by Agentation.com.