Window State

GitHubnpmcrates.io

Referencia de API

Guarda las posiciones y tamaños de las ventanas y los restaura cuando la aplicación se vuelve a abrir.

Plataformas Soportadas

Este plugin requiere una versión de Rust de al menos 1.77.2

Plataforma	Nivel	Notas
windows
linux
macos
android
ios

Configuración

Instala el plugin window-state para comenzar.

Automático

Usa el gestor de paquetes de tu proyecto para agregar la dependencia:

npm

npm run tauri add window-state

yarn

yarn run tauri add window-state

pnpm

pnpm tauri add window-state

deno

deno task tauri add window-state

bun

bun tauri add window-state

cargo

cargo tauri add window-state

Manual

1. Ejecuta el siguiente comando en la carpeta src-tauri para agregar el plugin a las dependencias del proyecto en Cargo.toml:

   cargo add tauri-plugin-window-state --target 'cfg(any(target_os = "macos", windows, target_os = "linux"))'

2. Modifica lib.rs para inicializar el plugin:

   src-tauri/src/lib.rs

   #[cfg_attr(mobile, tauri::mobile_entry_point)]
   pub fn run() {
       tauri::Builder::default()
           .setup(|app| {
               #[cfg(desktop)]
               app.handle().plugin(tauri_plugin_window_state::Builder::default().build());
               Ok(())
           })
           .run(tauri::generate_context!())
           .expect("error while running tauri application");
   }

3. Instala los bindings de JavaScript utilizando tu gestor de paquetes de JavaScript preferido:

   npm

   npm install @tauri-apps/plugin-window-state

   yarn

   yarn add @tauri-apps/plugin-window-state

   pnpm

   pnpm add @tauri-apps/plugin-window-state

   deno

   deno add npm:@tauri-apps/plugin-window-state

   bun

   bun add @tauri-apps/plugin-window-state

Uso

Después de agregar el plugin window-state, todas las ventanas recordarán su estado cuando la aplicación se esté cerrando y se restaurarán a su estado anterior en el próximo lanzamiento.

También puedes acceder al plugin window-state tanto en JavaScript como en Rust.

Consejo

Restaurar el estado ocurrirá después de la creación de la ventana, así que para evitar que la ventana parpadee, puedes establecer visible en false al crear la ventana, el plugin mostrará la ventana cuando restaure el estado

JavaScript

Puedes usar saveWindowState para guardar manualmente el estado de la ventana:

import { saveWindowState, StateFlags } from '@tauri-apps/plugin-window-state';
// when using `"withGlobalTauri": true`, you may use
// const { saveWindowState, StateFlags } = window.__TAURI__.windowState;

saveWindowState(StateFlags.ALL);

Del mismo modo, puedes restaurar manualmente el estado de una ventana desde el disco:

import {
  restoreStateCurrent,
  StateFlags,
} from '@tauri-apps/plugin-window-state';
// when using `"withGlobalTauri": true`, you may use
// const { restoreStateCurrent, StateFlags } = window.__TAURI__.windowState;

restoreStateCurrent(StateFlags.ALL);

Rust

Puedes usar el método save_window_state() expuesto por el trait AppHandleExt:

use tauri_plugin_window_state::{AppHandleExt, StateFlags};

// `tauri::AppHandle` now has the following additional method
app.save_window_state(StateFlags::all()); // will save the state of all open windows to disk

Del mismo modo, puedes restaurar manualmente el estado de una ventana desde el disco usando el método restore_state() expuesto por el trait WindowExt:

use tauri_plugin_window_state::{WindowExt, StateFlags};

// all `Window` types now have the following additional method
window.restore_state(StateFlags::all()); // will restore the window's state from disk

Permisos

De forma predeterminada, todos los comandos y alcances (scopes) potencialmente peligrosos del plugin están bloqueados y no se puede acceder a ellos. Debes modificar los permisos en tu configuración de capabilities para habilitarlos.

Consulta la Visión General de Capacidades para obtener más información y la guía paso a paso para usar permisos de plugins.

src-tauri/capabilities/default.json

{
  "permissions": [
    ...,
    "window-state:default",
  ]
}

Permiso Predeterminado

Este conjunto de permisos configura qué tipo de operaciones están disponibles desde el plugin window-state.

Permisos Otorgados

Todas las operaciones están habilitadas por defecto.

Este conjunto de permisos predeterminado incluye lo siguiente:

• allow-filename
• allow-restore-state
• allow-save-window-state

Tabla de Permisos

Identificador	Descripción
window-state:allow-filename	Habilita el comando filename sin ningún alcance preconfigurado.
window-state:deny-filename	Deniega el comando filename sin ningún alcance preconfigurado.
window-state:allow-restore-state	Habilita el comando restore_state sin ningún alcance preconfigurado.
window-state:deny-restore-state	Deniega el comando restore_state sin ningún alcance preconfigurado.
window-state:allow-save-window-state	Habilita el comando save_window_state sin ningún alcance preconfigurado.
window-state:deny-save-window-state	Deniega el comando save_window_state sin ningún alcance preconfigurado.