Struct WidgetWindowConfig 

pub struct WidgetWindowConfig {

    pub label: String,
    pub url: Option<String>,
    pub width: f64,
    pub height: f64,
    pub x: Option<f64>,
    pub y: Option<f64>,
    pub always_on_top: bool,
    pub skip_taskbar: bool,
    pub group: Option<String>,
    pub widget_id: Option<String>,
    pub instance: Option<String>,
    pub size: Option<String>,
    pub layer: Option<WindowLayer>,
    pub click_through: Option<bool>,
    pub focusable: Option<bool>,
    pub all_workspaces: Option<bool>,
    pub shadow: Option<bool>,
    pub effects: Option<WindowEffectHint>,
    pub placement: Option<WidgetPlacement>,
    pub remember_position: Option<bool>,
}

Configuration for creating a desktop widget window.

When url is omitted the plugin serves its built-in renderer automatically (via a custom URI-scheme protocol). In that case group tells the renderer which config to load, and size selects the layout family ("small", "medium", or "large").

Fields

label: String

Tauri window label (must be unique).

url: Option<String>

Frontend route or URL. Leave empty / omit to use the built-in widget renderer that ships with the plugin.

width: f64

Window width in logical pixels.

height: f64

Window height in logical pixels.

x: Option<f64>

Optional X position.

y: Option<f64>

Optional Y position.

always_on_top: bool

Keep the widget above other windows.

skip_taskbar: bool

Hide from the taskbar / dock.

group: Option<String>

Widget group identifier — passed to the built-in renderer so it knows which config to load via get_widget_config.

widget_id: Option<String>

Widget identity within the group (required for built-in renderer).

instance: Option<String>

Placement id for the built-in renderer: reads config:{widgetId}#{instance} first and fills {{instance}}. Defaults to none.

size: Option<String>

Size family the renderer should display: "small", "medium", or "large". Defaults to "small" when omitted.

layer: Option<WindowLayer>

Stacking layer. Unset: top when alwaysOnTop, else desktop on Linux (the historical DESKTOP pin) and normal on macOS / Windows.

click_through: Option<bool>

Let clicks pass through to whatever is below. Default false.

focusable: Option<bool>

Whether the window can take keyboard focus. Default true.

all_workspaces: Option<bool>

Show on every virtual desktop / Space. Default: true for the desktop layer.

shadow: Option<bool>

System window shadow (macOS / Windows). Default: platform default.

effects: Option<WindowEffectHint>

Backdrop material hint (macOS vibrancy, Windows 11 mica / acrylic). Needs a transparent window; ignored where the platform has no such material (Linux).

placement: Option<WidgetPlacement>

Place relative to a monitor’s work area instead of absolute x / y.

remember_position: Option<bool>

Remember where the user moved the window (per label) and restore it next time. Default true; a remembered position wins over x / y / placement while it is still on a connected monitor.

Trait Implementations

impl Clone for WidgetWindowConfig

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for WidgetWindowConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for WidgetWindowConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for WidgetWindowConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for WidgetWindowConfig

Available on crate feature schema only.

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl Serialize for WidgetWindowConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.