artin/tauri
1
0
Fork 0
mirror of https://github.com/tauri-apps/tauri.git synced 2026-02-06 15:56:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: update WebviewWindow doc comment (#3730)

Browse Source
This commit is contained in:
Jonas Kruckenberg 2022-03-20 03:05:44 +01:00 committed by GitHub
parent f0db3f9b83
commit 393f4b3d79
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
tooling/api/src/window.ts
View File

@ -1096,6 +1096,10 @@ class WindowManager extends WebviewWindowHandle {
/**
* Create new webview windows and get a handle to existing ones.
*
* Windows are identified by a *label* a unique identifier that can be used to reference it later.
* It may only contain alphanumeric characters `a-zA-Z` plus the following special characters `-`, `/`, `:` and `_`.
*
* @example
* ```typescript
* // loading embedded asset:
@ -1124,7 +1128,7 @@ class WindowManager extends WebviewWindowHandle {
class WebviewWindow extends WindowManager {
/**
* Creates a new WebviewWindow.
* * @param label The webview window label, a unique identifier that can be used to reference it later. It must be alphanumeric.
* * @param label The unique webview window label. Must be alphanumeric: `a-zA-Z-/:_`.
* @returns The WebviewWindow instance to communicate with the webview.
*/
constructor(label: WindowLabel, options: WindowOptions = {}) {