You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
tauri-plugins-workspace/plugins/persisted-scope
Lucas Fernandes Nogueira d5a7c77a8d
fix(docs): enable `tauri/dox` feature on docs.rs build (#545)
2 years ago
..
src Merge v1 into v2 (#468) 2 years ago
CHANGELOG.md Merge v1 into v2 (#468) 2 years ago
Cargo.toml fix(docs): enable `tauri/dox` feature on docs.rs build (#545) 2 years ago
LICENSE.spdx add licenses 3 years ago
LICENSE_APACHE-2.0 add licenses 3 years ago
LICENSE_MIT add licenses 3 years ago
README.md chore: change readme banners urls (#523) 2 years ago
banner.png template readmes and banners 3 years ago

README.md

plugin-persisted-scope

Save filesystem and asset scopes and restore them when the app is reopened.

Install

This plugin requires a Rust version of at least 1.65

There are three general methods of installation that we can recommend.

  1. Use crates.io and npm (easiest, and requires you to trust that our publishing pipeline worked)
  2. Pull sources directly from Github using git tags / revision hashes (most secure)
  3. Git submodule install this repo in your tauri project and then use file protocol to ingest the source (most secure, but inconvenient to use)

Install the Core plugin by adding the following to your Cargo.toml file:

src-tauri/Cargo.toml

[dependencies]
tauri-plugin-persisted-scope = "2.0.0-alpha"
# alternatively with Git:
tauri-plugin-persisted-scope = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "v2" }

Usage

First you need to register the core plugin with Tauri:

src-tauri/src/main.rs

fn main() {
    tauri::Builder::default()
        .plugin(tauri_plugin_persisted_scope::init())
        .run(tauri::generate_context!())
        .expect("error while running tauri application");
}

Afterwards the plugin will automatically save and restore filesystem and asset scopes.

Contributing

PRs accepted. Please make sure to read the Contributing Guide before making a pull request.

License

Code: (c) 2015 - Present - The Tauri Programme within The Commons Conservancy.

MIT or MIT/Apache 2.0 where applicable.