From 72e581498713fe586c4111bd16bf017fa4c400b8 Mon Sep 17 00:00:00 2001 From: liwenzhen Date: Tue, 29 Mar 2022 09:56:18 +0800 Subject: [PATCH] fixed 94a2061 from https://gitee.com/liwenzhen3/docs/pulls/2690 s[web]add webController description Signed-off-by: liwenzhen Change-Id: I68c04f87957e950c58d35f17c98b8a6e43a7a676 --- .../arkui-ts/ts-basic-components-web.md | 40 +++++++++---------- 1 file changed, 20 insertions(+), 20 deletions(-) diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-web.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-web.md index d424f0c18d..c3fd580ab5 100755 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-web.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-web.md @@ -21,7 +21,7 @@ | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | ---------- | ------------------------------- | ---- | ------ | -------------- | | src | string | 是 | - | 网页资源地址。 | - | controller | [WebController](#WebController) | 否 | - | 控制器。 | + | controller | [WebController](#webcontroller) | 否 | - | 控制器。 | > ![icon-note.gif](public_sys-resources/icon-note.gif)**说明：** @@ -38,7 +38,7 @@ | imageAccess | boolean | true | 设置是否允许自动加载图片资源，默认允许。 | | javaScriptProxy | {
object: object,
name: string,
methodList: Array\,
controller: WebController
} | - | 注入JavaScript对象到window对象中，并在window对象中调用该对象的方法。所有参数不支持更新。
object: 参与注册的对象。只能声明方法，不能声明属性 。其中方法的参数和返回类型只能为string，number，boolean。
name: 注册对象的名称，与window中调用的对象名一致。注册后window对象可以通过此名字访问应用侧JavaScript对象。
methodList: 参与注册的应用侧JavaScript对象的方法。
controller: 控制器。 | | javaScriptAccess | boolean | true | 设置是否允许执行JavaScript脚本，默认允许执行。 | -| mixedMode | [MixedMode](#MixedMode) | MixedMode.None | 设置是否允许加载超文本传输协议（HTTP）和超文本传输安全协议（HTTPS）混合内容，默认不允许加载HTTP和HTTPS混合内容。 | +| mixedMode | MixedMode | MixedMode.None | 设置是否允许加载超文本传输协议（HTTP）和超文本传输安全协议（HTTPS）混合内容，默认不允许加载HTTP和HTTPS混合内容。 | | onlineImageAccess | boolean | true | 设置是否允许从网络加载图片资源（通过HTTP和HTTPS访问的资源），默认允许访问。 | | zoomAccess | boolean | true | 设置是否支持手势进行缩放，默认允许执行缩放。 | @@ -59,13 +59,13 @@ | 名称 | 功能描述 | | ------------------------------------------------------------ | ------------------------------------------------------------ | -| onAlert(callback: (event?: { url: string; message: string; result: [JsResult](#JsResult对象说明) }) => boolean) |

网页触发alert()告警弹窗时触发回调。
当回调返回false时，触发默认弹窗。当回调返回true时，系统应用可以调用系统弹窗能力（只有确认场景），并且根据用户的确认操作调用JsResult通知web组件。
url：当前显示弹窗所在网页的URL。
message：弹窗中显示的信息。
JsResult：通知web组件用户操作行为。

| -| onBeforeUnload(callback: (event?: { url: string; message: string; result: [JsResult](#JsResult对象说明) }) => boolean) |

刷新或关闭场景下，在即将离开当前页面时触发此回调。
当回调返回false时，触发默认弹窗。当回调返回true时，系统应用可以调用系统弹窗能力（包括确认和取消），并且需要根据用户的确认或取消操作调用JsResult通知web组件最终是否离开当前页面。
url：当前显示弹窗所在网页的URL。
message：弹窗中显示的信息。
JsResult：通知web组件用户操作行为。

| -| onConfirm(callback: (event?: { url: string; message: string; result: [JsResult](#JsResult对象说明) }) => boolean) |

网页调用confirm()告警时触发此回调。
当回调返回false时，触发默认弹窗。当回调返回true时，系统应用可以调用系统弹窗能力（包括确认和取消），并且需要根据用户的确认或取消操作调用JsResult通知web组件。
url：当前显示弹窗所在网页的URL。
message：弹窗中显示的信息。
JsResult：通知web组件用户操作行为。

| -| onConsole(callback: (event?: { message: [ConsoleMessage](#ConsoleMessage对象说明) }) => boolean) |

通知宿主应用JavaScript console消息。
message：触发的控制台信息。

| +| onAlert(callback: (event?: { url: string; message: string; result: [JsResult](#jsresult对象说明) }) => boolean) |

网页触发alert()告警弹窗时触发回调。
当回调返回false时，触发默认弹窗。当回调返回true时，系统应用可以调用系统弹窗能力（只有确认场景），并且根据用户的确认操作调用JsResult通知Web组件。
url：当前显示弹窗所在网页的URL。
message：弹窗中显示的信息。
JsResult：通知Web组件用户操作行为。

| +| onBeforeUnload(callback: (event?: { url: string; message: string; result: [JsResult](#jsresult对象说明) }) => boolean) |

刷新或关闭场景下，在即将离开当前页面时触发此回调。
当回调返回false时，触发默认弹窗。当回调返回true时，系统应用可以调用系统弹窗能力（包括确认和取消），并且需要根据用户的确认或取消操作调用JsResult通知Web组件最终是否离开当前页面。
url：当前显示弹窗所在网页的URL。
message：弹窗中显示的信息。
JsResult：通知Web组件用户操作行为。

| +| onConfirm(callback: (event?: { url: string; message: string; result: [JsResult](#jsresult对象说明) }) => boolean) |

网页调用confirm()告警时触发此回调。
当回调返回false时，触发默认弹窗。当回调返回true时，系统应用可以调用系统弹窗能力（包括确认和取消），并且需要根据用户的确认或取消操作调用JsResult通知Web组件。
url：当前显示弹窗所在网页的URL。
message：弹窗中显示的信息。
JsResult：通知Web组件用户操作行为。

| +| onConsole(callback: (event?: { message: [ConsoleMessage](#consolemessage对象说明) }) => boolean) |

通知宿主应用JavaScript console消息。
message：触发的控制台信息。

| | onDownloadStart(callback: (event?: { url: string, userAgent: string, contentDisposition: string, mimetype: string, contentLength: number }) => void) |

网页的下载任务开始时触发该回调。
url：文件下载的URL。
userAgent：下载的用户代理（UA）名称。
contentDisposition：服务器返回的 Content-Disposition响应头，可能为空。
mimetype：服务器返回内容媒体类型（MIME）信息。
contentLength：服务器返回文件的长度。

| -| onErrorReceive(callback: (event?: { request: [WebResourceRequest](#WebResourceError对象说明), error: [WebResourceError](#WebResourceError对象说明) }) => void) |

网页加载遇到错误时触发该回调。
出于性能考虑，建议此回调中尽量执行简单逻辑。
request：网页请求的封装信息。
error：网页加载资源错误的封装信息 。

| -| onHttpErrorReceive(callback: (event?: { request: [WebResourceRequest](#WebResourceError对象说明), response: [WebResourceResponse](#WebResourceResponse对象说明) }) => void) |

网页加载资源遇到的HTTP错误（响应码>=400)时触发该回调。
request：网页请求的封装信息。
response：网页响应的封装信息

| +| onErrorReceive(callback: (event?: { request: [WebResourceRequest](#webresourceerror对象说明), error: [WebResourceError](#webresourceerror对象说明) }) => void) |

网页加载遇到错误时触发该回调。
出于性能考虑，建议此回调中尽量执行简单逻辑。
request：网页请求的封装信息。
error：网页加载资源错误的封装信息 。

| +| onHttpErrorReceive(callback: (event?: { request: [WebResourceRequest](#webresourceerror对象说明), response: [WebResourceResponse](#webresourceresponse对象说明) }) => void) |

网页加载资源遇到的HTTP错误（响应码>=400)时触发该回调。
request：网页请求的封装信息。
response：网页响应的封装信息

| | onPageBegin(callback: (event?: { url: string }) => void) |

网页开始加载时触发该回调，且只在主frame触发，iframe或者frameset的内容加载时不会触发此回调。
url：页面的URL地址。

| | onPageEnd(callback: (event?: { url: string }) => void) |

网页加载完成时触发该回调，且只在主frame触发。
url：页面的URL地址。

| | onProgressChange(callback: (event?: { newProgress: number }) => void) |

网页加载进度变化时触发该回调。
newProgress：新的加载进度，取值范围为0到100的整数。

| @@ -100,8 +100,8 @@ Web组件返回的弹窗确认或弹窗取消功能对象。 | 接口名称 | 功能描述 | | --------------------- | ------------------------------------ | - | handleCancel(): void |

通知web组件用户取消弹窗操作。

| - | handleConfirm(): void |

通知web组件用户确认弹窗操作。

| + | handleCancel(): void |

通知Web组件用户取消弹窗操作。

| + | handleConfirm(): void |

通知Web组件用户确认弹窗操作。

| ### WebResourceError对象说明 @@ -118,7 +118,7 @@ Web组件返回的弹窗确认或弹窗取消功能对象。 | 接口名称 | 功能描述 | | ------------------------------------------------------ | ---------------------------------------- | - | getRequestHeader(): Array\<[Header](#Header对象说明)\> | 获取资源请求头信息。 | + | getRequestHeader(): Array\<[Header](#header对象说明)\> | 获取资源请求头信息。 | | getRequestUrl(): string | 获取资源请求的URL信息。 | | isMainFrame(): boolean | 判断资源请求是否为主frame。 | | isRedirect(): boolean | 判断资源请求是否被服务端重定向。 | @@ -146,12 +146,12 @@ Web组件返回的请求/响应头对象。 | getResponseCode(): number | 获取资源响应的状态码。 | | getResponseData(): string | 获取资源响应数据。 | | getResponseEncoding(): string | 获取资源响应的编码。 | - | getResponseHeader(): Array\<[Header](#Header对象说明)\> | 获取资源响应头。 | + | getResponseHeader(): Array\<[Header](#header对象说明)\> | 获取资源响应头。 | | getResponseMimeType(): string | 获取资源响应的媒体（MIME）类型。 | ## WebController -通过webController可以控制web组件各种行为，或获取web组件的配置信息。 +通过WebController可以控制Web组件各种行为。一个WebController对象只能控制一个Web组件，且必须在Web组件和WebController绑定后，才能调用WebController上的方法。 ### 创建对象 @@ -238,9 +238,9 @@ loadData(options: { data: string, mimeType: string, encoding: string, baseUrl?: baseUrl为空时，通过”data“协议加载指定的一段字符串。 -当baseUrl为”data“协议时，编码后的data字符串将被web组件作为”data"协议加载。 +当baseUrl为”data“协议时，编码后的data字符串将被Web组件作为”data"协议加载。 -当baseUrl为“http/https"协议时，编码后的data字符串将被web组件以类似loadUrl的方式以非编码字符串处理。 +当baseUrl为“http/https"协议时，编码后的data字符串将被Web组件以类似loadUrl的方式以非编码字符串处理。 - options参数说明 @@ -249,7 +249,7 @@ baseUrl为空时，通过”data“协议加载指定的一段字符串。 | data | string | 是 | - | 按照”Base64“或者”URL"编码后的一段字符串。 | | mimeType | string | 是 | - | 媒体类型（MIME）。 | | encoding | string | 是 | - | 编码类型，具体为“Base64"或者”URL编码。 | - | baseUrl | string | 否 | - | 指定的一个URL路径（“http”/“https”/"data"协议），并由web组件赋值给window.origin。 | + | baseUrl | string | 否 | - | 指定的一个URL路径（“http”/“https”/"data"协议），并由Web组件赋值给window.origin。 | | historyUrl | string | 否 | - | 历史记录URL。非空时，可被历史记录管理，实现前后后退功能。当baseUrl为空时，此属性无效。 | ### loadUrl @@ -267,25 +267,25 @@ loadUrl(options:{ url: string, headers?: Array\ }): void | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | ------- | ------------------------------------- | ---- | ------ | --------------------- | | url | string | 是 | - | 需要加载的 URL。 | - | headers | Array\<[Header](#Header对象说明)\> | 否 | [] | URL的附加HTTP请求头。 | + | headers | Array\<[Header](#header对象说明)\> | 否 | [] | URL的附加HTTP请求头。 | ### onActive onActive(): void -调用此接口通知web组件进入前台激活状态。 +调用此接口通知Web组件进入前台激活状态。 ### onInactive onInactive(): void -调用此接口通知web组件进入未激活状态。 +调用此接口通知Web组件进入未激活状态。 ### refresh refresh(): void -调用此接口通知web组件刷新网页。 +调用此接口通知Web组件刷新网页。 ### registerJavaScriptProxy -- GitLab