Tauri Plugin Widgets

Native widgets for Android, iOS, macOS, Windows, and Linux from one declarative JSON configuration.

Full documentation (schema, platform setup, elements, showcase):
https://s00d.github.io/tauri-plugin-widgets

The complete config schema, platform setup guides, and element reference live on the documentation site — they are no longer maintained in this README.

Install

# any package manager — or: cargo tauri add tauri-plugin-widgets
pnpm tauri add tauri-plugin-widgets

Manual alternative:

# src-tauri/Cargo.toml
[dependencies]
tauri-plugin-widgets = "0.4"

pnpm add tauri-plugin-widgets-api

Example

import { setWidgetConfig } from "tauri-plugin-widgets-api";

await setWidgetConfig(
  {
    small: {
      type: "vstack",
      padding: 12,
      background: "#1a1a2e",
      children: [
        { type: "text", content: "72°", fontSize: 36, fontWeight: "bold", color: "#fff" },
        { type: "progress", value: 0.7, tint: "#4CAF50", label: "Humidity" },
      ],
    },
  },
  "group.com.example.myapp",
  "weather",
);

Register the plugin with tauri_plugin_widgets::init() and add widgets:default to capabilities. Details: Install · First widget.

Platform setup

Quick scaffold: npx tauri-plugin-widgets-api init-macos|init-ios|init-windows.

Contributing

Architecture, goldens, harnesses: docs/contributing/development.md.

License

MIT