docs.rs failed to build tauri-plugin-visual-editor-0.1.1
Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.

tauri-plugin-visual-editor

Visual Inspector plugin for Tauri 2 — select UI elements, capture screenshots, and copy Context Bundles into AI editors like Cursor.

Bridge between your running Tauri app and AI-assisted development. Not a Cursor replacement.

Features

Embedded floating toolbar (no extra window required)
Visual element inspection with hover + multi-select
Native screenshots (window, webview, element crop)
Context composer with element + screenshot chips
Structured Context Bundle export for AI editors
Optional SDK for data-inspector-* metadata (recommended)
DevTools toggle, hard reload, five-gate security model

Quick install (host app)

1. Rust

# src-tauri/Cargo.toml
[dependencies]
tauri-plugin-visual-editor = { version = "0.1", features = ["visual-inspector"] }

// src-tauri/src/lib.rs
.plugin(tauri_plugin_visual_editor::init())

2. Config

// src-tauri/tauri.conf.json
{
  "plugins": {
    "visualEditor": {
      "enabled": true,
      "allow": true,
      "overlayMode": "embedded",
      "autoOpen": true,
      "overlayDeferMs": 100
    }
  }
}

3. Capabilities

"permissions": ["core:default", "visual-editor:all"]

No frontend import required — the overlay auto-injects into your webview.

4. Best bundle quality (recommended)

npm install @iamthamanic/visual-editor-sdk

import { InspectorMeta } from '@iamthamanic/visual-editor-sdk/react';

<InspectorMeta component="SaveButton" file="src/SaveButton.tsx" id="save">
  <button>Save</button>
</InspectorMeta>

Full guide: docs/quick-start.md

Packages

Package	Registry	Purpose
`tauri-plugin-visual-editor`	crates.io	Tauri plugin (includes guest overlay)
`@iamthamanic/visual-editor-sdk`	npm	`InspectorMeta` + metadata helpers

Hosts do not need npm install @tauri-plugin/visual-editor — guest JS ships inside the Rust crate.

Update in consuming apps

cargo update -p tauri-plugin-visual-editor
npm update @iamthamanic/visual-editor-sdk

See docs/consuming-apps.md.

Examples

git clone https://github.com/iamthamanic/tauri-plugin-visual-editor.git
cd tauri-plugin-visual-editor
npm install
npm run checks
npm run tauri:dev --workspace=example-react-vite

examples/react-vite — React + Vite + SDK metadata
examples/vanilla — vanilla JS + manual data-inspector-* attrs

Documentation

Doc	Description
Quick Start	Complete host setup checklist
Integration Guide	Multi-webview, security, API usage
Plugin API	Commands and types
Context Bundle Format	Export structure
Architecture	Hub, guest injection, screenshots
Release	Publishing workflow

Development

npm run checks          # quality gate (Rust + TypeScript)
cargo test --workspace
npm run tauri:dev --workspace=example-react-vite

Project structure

tauri-plugin-visual-editor/
├── crates/              # Rust plugin + core
├── packages/            # guest, sdk, inspector-app
├── examples/            # react-vite, vanilla
├── docs/
└── templates/           # dependabot + local patch templates for hosts

License

MIT — see LICENSE

tauri-plugin-visual-editor 0.1.1