fix(docs): deep link platform specific and fs scope (#3504)

* deep link fix Platform Specific heading

* fix fs permission toml

* .changes

* Update change files

Co-authored-by: Tony <68118705+Legend-Master@users.noreply.github.com>

* Update .changes/fs-deny-scope.md

* fix eol

---------

Co-authored-by: Tony <68118705+Legend-Master@users.noreply.github.com>
This commit is contained in:
Vitor Ayres
2026-07-21 14:56:52 +08:00
committed by GitHub
co-authored by Tony
parent 7e45774610
commit 3fb27bf13a
4 changed files with 31 additions and 9 deletions
+6
View File
@@ -0,0 +1,6 @@
---
"deep-link": patch
"deep-link-js": patch
---
adds proper Platform-specific sections to the docs for `register`, `unregister`, `isRegistered`, and `onOpenUrl`
+6
View File
@@ -0,0 +1,6 @@
---
"fs": patch
"fs-js": patch
---
Fixed `deny-webview-data` has no effect
+17 -7
View File
@@ -14,9 +14,11 @@ import { type UnlistenFn, listen } from '@tauri-apps/api/event'
* const urls = await getCurrent(); * const urls = await getCurrent();
* ``` * ```
* *
* #### - **Windows / Linux**: This function reads the command line arguments and checks if there's only one value, which must be an URL with scheme matching one of the configured values. * #### Platform-specific
* Note that you must manually check the arguments when registering deep link schemes dynamically with [`Self::register`]. *
* Additionally, the deep link might have been provided as a CLI argument so you should check if its format matches what you expect.. * - **Windows / Linux:** This function reads the command line arguments and checks if there's only one value, which must be an URL with scheme matching one of the configured values.
* Note that you must manually check the arguments when registering deep link schemes dynamically with [`Self::register`].
* Additionally, the deep link might have been provided as a CLI argument so you should check if its format matches what you expect.
* *
* @since 2.0.0 * @since 2.0.0
*/ */
@@ -35,7 +37,9 @@ export async function getCurrent(): Promise<string[] | null> {
* await register("my-scheme"); * await register("my-scheme");
* ``` * ```
* *
* #### - **macOS / Android / iOS**: Unsupported. * #### Platform-specific
*
* - **macOS / Android / iOS:** Unsupported.
* *
* @since 2.0.0 * @since 2.0.0
*/ */
@@ -54,7 +58,9 @@ export async function register(protocol: string): Promise<null> {
* await unregister("my-scheme"); * await unregister("my-scheme");
* ``` * ```
* *
* #### - **macOS / Linux / Android / iOS**: Unsupported. * #### Platform-specific
*
* - **macOS / Linux / Android / iOS:** Unsupported.
* *
* @since 2.0.0 * @since 2.0.0
*/ */
@@ -73,7 +79,9 @@ export async function unregister(protocol: string): Promise<null> {
* await isRegistered("my-scheme"); * await isRegistered("my-scheme");
* ``` * ```
* *
* #### - **macOS / Android / iOS**: Unsupported. * #### Platform-specific
*
* - **macOS / Android / iOS:** Unsupported.
* *
* @since 2.0.0 * @since 2.0.0
*/ */
@@ -92,7 +100,9 @@ export async function isRegistered(protocol: string): Promise<boolean> {
* await onOpenUrl((urls) => { console.log(urls) }); * await onOpenUrl((urls) => { console.log(urls) });
* ``` * ```
* *
* #### - **Windows / Linux**: Unsupported without the single-instance plugin. The OS will spawn a new app instance passing the URL as a CLI argument. * #### Platform-specific
*
* - **Windows / Linux:** Unsupported without the single-instance plugin. The OS will spawn a new app instance passing the URL as a CLI argument.
* *
* @since 2.0.0 * @since 2.0.0
*/ */
@@ -6,7 +6,7 @@ description = """This denies read access to the
`$APPLOCALDATA` folder on linux as the webview data and configuration values are stored here. `$APPLOCALDATA` folder on linux as the webview data and configuration values are stored here.
Allowing access can lead to sensitive information disclosure and should be well considered.""" Allowing access can lead to sensitive information disclosure and should be well considered."""
[[scope.deny]] [[permission.scope.deny]]
path = "$APPLOCALDATA/**" path = "$APPLOCALDATA/**"
[[permission]] [[permission]]
@@ -15,5 +15,5 @@ description = """This denies read access to the
`$APPLOCALDATA/EBWebView` folder on windows as the webview data and configuration values are stored here. `$APPLOCALDATA/EBWebView` folder on windows as the webview data and configuration values are stored here.
Allowing access can lead to sensitive information disclosure and should be well considered.""" Allowing access can lead to sensitive information disclosure and should be well considered."""
[[scope.deny]] [[permission.scope.deny]]
path = "$APPLOCALDATA/EBWebView/**" path = "$APPLOCALDATA/EBWebView/**"