{"id":13800691,"url":"https://github.com/tauri-apps/tauri-plugin-window-state","last_synced_at":"2025-04-05T08:05:28.630Z","repository":{"id":36993807,"uuid":"410452392","full_name":"tauri-apps/tauri-plugin-window-state","owner":"tauri-apps","description":"[READ ONLY] This repository is a mirror, for issue tracking and development head to: https://github.com/tauri-apps/plugins-workspace","archived":false,"fork":false,"pushed_at":"2024-10-08T07:30:43.000Z","size":1157,"stargazers_count":126,"open_issues_count":0,"forks_count":17,"subscribers_count":11,"default_branch":"v1","last_synced_at":"2024-10-29T15:44:17.359Z","etag":null,"topics":["tauri-plugin"],"latest_commit_sha":null,"homepage":"https://github.com/tauri-apps/plugins-workspace","language":"Rust","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tauri-apps.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.spdx","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-09-26T04:49:19.000Z","updated_at":"2024-09-23T15:55:48.000Z","dependencies_parsed_at":"2024-11-06T04:05:04.237Z","dependency_job_id":"cd7c1694-422f-4bcc-8bc4-ecde6063d5e0","html_url":"https://github.com/tauri-apps/tauri-plugin-window-state","commit_stats":{"total_commits":28,"total_committers":5,"mean_commits":5.6,"dds":0.5,"last_synced_commit":"aa0b2a9cbf96f87a172e999670be79c4bb5d67dd"},"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tauri-apps%2Ftauri-plugin-window-state","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tauri-apps%2Ftauri-plugin-window-state/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tauri-apps%2Ftauri-plugin-window-state/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tauri-apps%2Ftauri-plugin-window-state/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tauri-apps","download_url":"https://codeload.github.com/tauri-apps/tauri-plugin-window-state/tar.gz/refs/heads/v1","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247305933,"owners_count":20917208,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["tauri-plugin"],"created_at":"2024-08-04T00:01:15.152Z","updated_at":"2025-04-05T08:05:28.605Z","avatar_url":"https://github.com/tauri-apps.png","language":"Rust","funding_links":["https://opencollective.com/tauri"],"categories":["Development"],"sub_categories":["Plugins"],"readme":"![plugin-window-state](https://github.com/tauri-apps/plugins-workspace/raw/v1/plugins/window-state/banner.png)\n\nSave window positions and sizes and restore them when the app is reopened.\n\n## Install\n\n_This plugin requires a Rust version of at least **1.67**_\n\nThere are three general methods of installation that we can recommend.\n\n1. Use crates.io and npm (easiest, and requires you to trust that our publishing pipeline worked)\n2. Pull sources directly from Github using git tags / revision hashes (most secure)\n3. Git submodule install this repo in your tauri project and then use file protocol to ingest the source (most secure, but inconvenient to use)\n\nInstall the Core plugin by adding the following to your `Cargo.toml` file:\n\n`src-tauri/Cargo.toml`\n\n```toml\n[dependencies]\ntauri-plugin-window-state = { git = \"https://github.com/tauri-apps/plugins-workspace\", branch = \"v1\" }\n```\n\nYou can install the JavaScript Guest bindings using your preferred JavaScript package manager:\n\n\u003e Note: Since most JavaScript package managers are unable to install packages from git monorepos we provide read-only mirrors of each plugin. This makes installation option 2 more ergonomic to use.\n\n```sh\npnpm add https://github.com/tauri-apps/tauri-plugin-window-state#v1\n# or\nnpm add https://github.com/tauri-apps/tauri-plugin-window-state#v1\n# or\nyarn add https://github.com/tauri-apps/tauri-plugin-window-state#v1\n```\n\n## Usage\n\nFirst you need to register the core plugin with Tauri:\n\n`src-tauri/src/main.rs`\n\n```rust\nfn main() {\n    tauri::Builder::default()\n        .plugin(tauri_plugin_window_state::Builder::default().build())\n        .run(tauri::generate_context!())\n        .expect(\"error while running tauri application\");\n}\n```\n\nAfterwards all windows will remember their state when the app is being closed and will restore to their previous state on the next launch.\n\nOptionally you can also tell the plugin to save the state of all open window to disk by using the `save_window_state()` method exposed by the `AppHandleExt` trait:\n\n```rust\nuse tauri_plugin_window_state::{AppHandleExt, StateFlags};\n\n// `tauri::AppHandle` now has the following additional method\napp.save_window_state(StateFlags::all()); // will save the state of all open windows to disk\n```\n\nor through Javascript\n\n```javascript\nimport { saveWindowState, StateFlags } from \"tauri-plugin-window-state-api\";\n\nsaveWindowState(StateFlags.ALL);\n```\n\nTo manually restore a windows state from disk you can call the `restore_state()` method exposed by the `WindowExt` trait:\n\n```rust\nuse tauri_plugin_window_state::{WindowExt, StateFlags};\n\n// all `Window` types now have the following additional method\nwindow.restore_state(StateFlags::all()); // will restore the windows state from disk\n```\n\nor through Javascript\n\n```javascript\nimport { restoreStateCurrent, StateFlags } from \"tauri-plugin-window-state-api\";\n\nrestoreStateCurrent(StateFlags.ALL);\n```\n\n## Contributing\n\nPRs accepted. Please make sure to read the Contributing Guide before making a pull request.\n\n## Partners\n\n\u003ctable\u003e\n  \u003ctbody\u003e\n    \u003ctr\u003e\n      \u003ctd align=\"center\" valign=\"middle\"\u003e\n        \u003ca href=\"https://crabnebula.dev\" target=\"_blank\"\u003e\n          \u003cimg src=\"https://github.com/tauri-apps/plugins-workspace/raw/v1/.github/sponsors/crabnebula.svg\" alt=\"CrabNebula\" width=\"283\"\u003e\n        \u003c/a\u003e\n      \u003c/td\u003e\n    \u003c/tr\u003e\n  \u003c/tbody\u003e\n\u003c/table\u003e\n\nFor the complete list of sponsors please visit our [website](https://tauri.app#sponsors) and [Open Collective](https://opencollective.com/tauri).\n\n## License\n\nCode: (c) 2015 - Present - The Tauri Programme within The Commons Conservancy.\n\nMIT or MIT/Apache 2.0 where applicable.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftauri-apps%2Ftauri-plugin-window-state","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftauri-apps%2Ftauri-plugin-window-state","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftauri-apps%2Ftauri-plugin-window-state/lists"}