tauri-apps/tauri
1
1
Fork 0
mirror of https://github.com/tauri-apps/tauri.git synced 2024-11-28 12:27:16 +03:00
Code Issues Packages Projects Releases Wiki Activity

docs(api): convertFileSrc example

Browse Source
This commit is contained in:
Lucas Nogueira 2022-02-11 14:02:58 -03:00
parent c50fbc22e7
commit 49c1970fae
No known key found for this signature in database
GPG Key ID: C54D79C4018F1D19
1 changed files with 14 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
tooling/api/src/tauri.ts
View File

@ -88,12 +88,25 @@ async function invoke<T>(cmd: string, args: InvokeArgs = {}): Promise<T> {
/**
* Convert a device file path to an URL that can be loaded by the webview.
* Note that `asset:` and `https://asset.localhost` must be allowed on the `csp` value configured on `tauri.conf.json > tauri > security`.
* Example CSP value: `"csp": "default-src 'self'; img-src 'self' asset: https://asset.localhost"`.
* Example CSP value: `"csp": "default-src 'self'; img-src 'self' asset: https://asset.localhost"` to use the asset protocol on image sources.
*
* Additionally, the `asset` must be allowlisted under `tauri.conf.json > tauri > allowlist > protocol`,
* and its access scope must be defined on the `assetScope` array on the same `protocol` object.
*
* @param filePath the file path.
* @example
* ```typescript
* import { appDir, join } from '@tauri-apps/api/path'
* import { convertFileSrc } from '@tauri-apps/api/tauri'
* const appDirPath = await appDir()
* const filePath = await join(appDir, 'assets/video.mp4')
* const assetUrl = convertFileSrc(filePath)
*
* const video = document.getElementById('video_source')
* const sources = video.getElementsByTagName('source')
* sources[0].src = assetUrl
* video.load()
* ```
*
* @return the URL that can be used as source on the webview.
*/