From 393f4b3d79b77efa388d604d5308efa67b2c9c9d Mon Sep 17 00:00:00 2001 From: Jonas Kruckenberg Date: Sun, 20 Mar 2022 03:05:44 +0100 Subject: [PATCH] docs: update WebviewWindow doc comment (#3730) --- tooling/api/src/window.ts | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/tooling/api/src/window.ts b/tooling/api/src/window.ts index ad71eed75..5d26d55a3 100644 --- a/tooling/api/src/window.ts +++ b/tooling/api/src/window.ts @@ -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 = {}) {