Skip to content

docs(persisted-scope): document the protocol-asset feature #3443

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
rumitvn wants to merge 1 commit into from
Closed

docs(persisted-scope): document the protocol-asset feature #3443

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion plugins/persisted-scope/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,20 @@ fn main() {
}
```

Afterwards the plugin will automatically save and restore filesystem and asset scopes.
Afterwards the plugin will automatically save and restore the filesystem scope (provided by the [`fs`](../fs) plugin). The scope is persisted to a `.persisted-scope` file in the app's data directory.

## Persisting the asset protocol scope

By default only the filesystem scope is persisted. To **also** save and restore the asset protocol scope — the scope used by Tauri's [`asset:` protocol / `convertFileSrc`](https://tauri.app/reference/javascript/api/namespacecore/#convertfilesrc), i.e. files you allow at runtime so the webview can load them — enable the `protocol-asset` feature on the plugin:

`src-tauri/Cargo.toml`

```toml
[dependencies]
tauri-plugin-persisted-scope = { version = "2.0.0", features = ["protocol-asset"] }
```

This feature enables `tauri/protocol-asset` and makes the plugin persist the asset scope to a separate `.persisted-scope-asset` file alongside the filesystem scope. No code changes are required — registering the plugin as shown above is enough.

## Contributing

Expand Down