From 2e9b312795cae20621fd94e261b722cb96c99512 Mon Sep 17 00:00:00 2001 From: lixingchi1 Date: Fri, 11 Mar 2022 12:12:50 +0800 Subject: [PATCH] fix the web ref doc. Signed-off-by: lixingchi1 --- .../arkui-ts/ts-basic-components-web.md | 200 +++++++++--------- 1 file changed, 100 insertions(+), 100 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 3373cce20b1..b20b7023c43 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,10 +21,10 @@ ohos.permission.READ_USER_STORAGE 表1 options参数说明 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | ---------- | ------------------------------- | ---- | ---- | ------- | - | src | string | 是 | - | 网页资源地址。 | - | controller | [WebController](#WebController) | 否 | - | 控制器。 | + | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | + | ---------- | ------------- | ---- | ---- | ------- | + | src | string | 是 | - | 网页资源地址。 | + | controller | WebController | 否 | - | 控制器。 | > ![icon-note.gif](public_sys-resources/icon-note.gif)**说明：** @@ -34,21 +34,21 @@ ohos.permission.READ_USER_STORAGE > - 不支持横竖屏事件。 ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | -| ----------------- | ------------------------------------------------------------ | -------------- | ------------------------------------------------------------ | -| domStorageAccess | boolean | false | 设置是否开启DOM Storage API权限，默认未开启。 | -| fileAccess | boolean | true | 设置是否开启Web中通过FILE方式访问应用中的本地文件， 默认启用。 | -| geolocationAccess | boolean | true | 设置是否允许访问地理位置， 默认允许访问。 | -| imageAccess | boolean | true | 设置是否允许自动加载图片资源，默认允许。 | -| javaScriptAccess | boolean | true | 设置是否允许执行JavaScript脚本，默认允许执行。 | -| mixedMode | MixedMode | MixedMode.None | 设置是否允许加载HTTP和HTTPS混合内容，默认不允许加载HTTP和HTTPS混合内容。 | -| onlineImageAccess | boolean | true | 设置是否允许从网络加载图片资源（通过HTTP和HTTPS访问的资源），默认允许访问。 | -| zoomAccess | boolean | true | 设置是否支持使用屏幕控件或手势进行缩放，默认允许执行缩放。 | -| javaScriptProxy | {
obj: object,
name: string,
methodList: Array,
controller: [WebController](#WebController)
} | - | 注入ArkUI对象到HTML中，并在HTML中调用该对象的方法，参数不支持更新。
-obj: 参与注册的对象。
-name: 注册对象的名称，与HTML中调用的对象名一致。
-methodList: 参与注册的方法。
-controller: 控制器。 | +| 名称 | 参数类型 | 默认值 | 描述 | +| ----------------- | ---------------------------------------- | -------------- | ---------------------------------------- | +| domStorageAccess | boolean | false | 设置是否开启文档对象模型存储接口（DOM Storage API）权限，默认未开启。 | +| fileAccess | boolean | true | 设置是否开启Web中通过本地文件传输（FILE）协议方式访问应用中的本地文件， 默认启用。 | +| geolocationAccess | boolean | true | 设置是否允许访问地理位置， 默认允许访问。 | +| imageAccess | boolean | true | 设置是否允许自动加载图片资源，默认允许。 | +| javaScriptProxy | {
obj: object,
name: string,
methodList: Array\,
controller: WebController
} | - | 注入JavaScript对象到超文本标记语言（HTML）中，并在HTML中调用该对象的方法，参数不支持更新。
obj: 参与注册的对象。
name: 注册对象的名称，与HTML中调用的对象名一致。
methodList: 参与注册的方法。
controller: 控制器。 | +| javaScriptAccess | boolean | true | 设置是否允许执行JavaScript脚本，默认允许执行。 | +| mixedMode | MixedMode | MixedMode.None | 设置是否允许加载超文本传输协议（HTTP）和超文本传输安全协议（HTTPS）混合内容，默认不允许加载HTTP和HTTPS混合内容。 | +| onlineImageAccess | boolean | true | 设置是否允许从网络加载图片资源（通过HTTP和HTTPS访问的资源），默认允许访问。 | +| zoomAccess | boolean | true | 设置是否支持使用屏幕控件或手势进行缩放，默认允许执行缩放。 | > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > -> 通用属性仅支持width、height、padding、margin、border。 +> 通用属性仅支持[width](ts-universal-attributes-size.md#属性)、[height](ts-universal-attributes-size.md#属性)、[padding](ts-universal-attributes-size.md#属性)、[margin](ts-universal-attributes-size.md#属性)、[border](ts-universal-attributes-border.md#属性)。 - MixedMode枚举说明 | 名称 | 描述 | @@ -59,34 +59,44 @@ ohos.permission.READ_USER_STORAGE ## 事件 -通用事件仅支持onFocus。 +通用事件仅支持[onFocus](ts-universal-focus-event.md#事件)。 -| 名称 | 功能描述 | -| ------------------------------------------------------------ | ------------------------------------------------------------ | -| onDownloadStart(callback: (event?: { url: string, userAgent: string, contentDisposition: string, mimetype: string, contentLength: number }) => void) |

下载开始时触发该回调。
url：Web引擎返回的下载URL。
userAgent：Web引擎返回的用户代理名称。
contentDisposition：Web引擎返回的响应头。
mimetype：Web引擎返回的mimetype信息。
contentLength：Web引擎返回的内容长度。

| -| onGeolocationHide(callback: () => void) |

调用onGeolocationShow时发出的地理位置权限请求被取消后触发该回调。

| -| onGeolocationShow(callback: (event?: { origin: string, geolocation: JsGeolocation }) => void) |

应用尝试使用地理位置时触发该回调，并向用户请求权限。
origin：尝试获取地理位置的Web内容的来源。
geolocation：用于请求地理位置权限。

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

网页加载时触发该回调。
url：Web引擎返回的URL。

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

网页加载结束时触发该回调。
url：Web引擎返回的URL。

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

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

| -| onTitleReceive(callback: (event?: { title: string }) => void) |

网页主页面标题更改时触发该回调。
title：标题内容。

| +| 名称 | 功能描述 | +| ---------------------------------------- | ---------------------------------------- | +| onAlert(callback: (event?: { url: string; message: string; result: JsResult }) => boolean) |

网页触发alert()告警弹窗时触发。
url：Web组件返回的下载URL。
message：Web组件返回的信息。
JsResult：Web组件返回的弹窗确认或弹窗取消功能对象。

| +| onBeforeUnload(callback: (event?: { url: string; message: string; result: JsResult }) => boolean) |

即将离开当前页面（刷新或关闭）时触发。
url：Web组件返回的下载URL。
message：Web组件返回的信息。
JsResult：Web组件返回的弹窗确认或弹窗取消功能对象。

| +| onConfirm(callback: (event?: { url: string; message: string; result: JsResult }) => boolean) |

网页触发confirm()确认弹窗时触发。
url：Web组件返回的下载URL。
message：Web组件返回的信息。
JsResult：Web组件返回的弹窗确认或弹窗取消功能对象。

| +| onConsole(callback: (event?: { message: ConsoleMessage }) => boolean) |

向主应用报告JavaScript控制台消息时触发该回调。
message：触发的控制台信息。

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

下载开始时触发该回调。
url：Web组件返回的下载URL。
userAgent：Web组件返回的用户代理名称。
contentDisposition：Web组件返回的响应头。
mimetype：Web组件返回的媒体类型（MIME）信息。
contentLength：Web组件返回的内容长度。

| | onErrorReceive(callback: (event?: { request: WebResourceRequest, error: WebResourceError }) => void) |

网页加载错误时触发该回调。
request：网页的请求信息。
error：网页的错误信息 。

| +| onGeolocationHide(callback: () => void) |

调用onGeolocationShow时发出的地理位置权限请求被取消后触发该回调。

| +| onGeolocationShow(callback: (event?: { origin: string, geolocation: JsGeolocation }) => void) |

应用尝试使用地理位置时触发该回调，并向用户请求权限。
origin：尝试获取地理位置的Web内容的来源。
geolocation：用于请求地理位置权限。

| | onHttpErrorReceive(callback: (event?: { request: WebResourceRequest, response: WebResourceResponse }) => void) |

网页加载出现网络错误时触发该回调。
request：网页的请求信息。
response：网页的响应信息

| -| onConsole(callback: (event?: { message: ConsoleMessage }) => boolean) |

向主应用报告JavaScript控制台消息时触发该回调。
message：触发的控制台信息。

| -| onAlert(callback: (event?: { url: string; message: string; result: JsResult }) => boolean) |

网页触发alert()告警弹窗时触发。
url：Web引擎返回的下载URL。
message：Web引擎返回的信息。
JsResult：Web引擎返回的弹窗确认或弹窗取消功能对象。

| -| onBeforeUnload(callback: (event?: { url: string; message: string; result: JsResult }) => boolean) |

网页重新加载或关闭时触发。
url：Web引擎返回的下载URL。
message：Web引擎返回的信息。
JsResult：Web引擎返回的弹窗确认或弹窗取消功能对象。

| -| onConfirm(callback: (event?: { url: string; message: string; result: JsResult }) => boolean) |

即将离开当前页面（刷新或关闭）时触发。
url：Web引擎返回的下载URL。
message：Web引擎返回的信息。
JsResult：Web引擎返回的弹窗确认或弹窗取消功能对象。

| - -### JsResult 对象说明 +| onPageBegin(callback: (event?: { url: string }) => void) |

网页加载时触发该回调。
url：Web组件返回的URL。

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

网页加载结束时触发该回调。
url：Web组件返回的URL。

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

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

| +| onTitleReceive(callback: (event?: { title: string }) => void) |

网页主页面标题更改时触发该回调。
title：标题内容。

| -Web引擎返回的弹窗确认或弹窗取消功能对象。 +### ConsoleMessage对象说明 - 接口 - | 接口名称 | 功能描述 | - | --------------------- | ----------------- | - | handleCancel(): void |

取消弹窗。

| - | handleConfirm(): void |

确认弹窗。

| + | 接口名称 | 功能描述 | + | ------------------------------- | ---------------------- | + | getLineNumber(): number | 获取ConsoleMessage的行数。 | + | getMessage(): string | 获取ConsoleMessage的日志信息。 | + | getMessageLevel(): MessageLevel | 获取ConsoleMessage的信息级别。 | + | getSourceId(): string | 获取ConsoleMessage的源的Id。 | + +- MessageLevel枚举说明 + + | 名称 | 描述 | + | ----- | :---- | + | Debug | 调试级别。 | + | Error | 错误级别。 | + | Info | 消息级别。 | + | Log | 日志级别。 | + | Warn | 警告级别。 | ### JsGeolocation 对象说明 @@ -94,64 +104,54 @@ Web引擎返回的弹窗确认或弹窗取消功能对象。 - 接口 - | 接口名称 | 功能描述 | - | ------------------------------------------------------------ | ------------------------------------------------------------ | + | 接口名称 | 功能描述 | + | ---------------------------------------- | ---------------------------------------- | | invoke(origin: string, allow: boolean, retain: boolean): void |

通知系统用户是否批准该应用使用地理位置权限。
origin：尝试获取地理位置的Web内容的来源。
allow：用户是否批准该应用使用地理位置权限。true: 允许访问，false: 不允许访问。
retain：是否允许将地理位置权限状态保存到系统中。true: 允许，false: 不允许。

| -### WebResourceRequest对象说明 +### JsResult 对象说明 + +Web组件返回的弹窗确认或弹窗取消功能对象。 - 接口 - | 接口名称 | 功能描述 | - | --------------------------------- | ------------------------------------ | - | getRequestUrl(): string | 获取请求的url信息。 | - | isRequestGesture(): boolean | 获取请求是否与手势关联。 | - | isMainFrame(): boolean | 获取请求是否时为了获取主窗口的信息。 | - | isRedirect(): boolean | 获取请求是否重定向。 | - | getRequestHeader(): Array
| 获取请求头信息。 | + | 接口名称 | 功能描述 | + | --------------------- | ------------ | + | handleCancel(): void |

取消弹窗。

| + | handleConfirm(): void |

确认弹窗。

| ### WebResourceError对象说明 - 接口 - | 接口名称 | 功能描述 | - | ---------------------- | ------------------------ | + | 接口名称 | 功能描述 | + | ---------------------- | ------------ | + | getErrorCode(): number | 获取加载资源的错误码。 | | getErrorInfo(): string | 获取加载资源的错误信息。 | - | getErrorCode(): number | 获取加载资源的错误码。 | -### WebResourceResponse对象说明 +### WebResourceRequest对象说明 - 接口 - | 接口名称 | 功能描述 | - | ---------------------------------- | ---------------------- | - | getResponseData(): string | 获取响应数据。 | - | getResponseEncoding(): string | 获取响应的编码。 | - | getResponseMimeType(): string | 获取响应的MIME类型。 | - | getResponseCode(): number | 获取响应的状态码。 | - | getReasonMessage(): string | 获取响应的状态码描述。 | - | getResponseHeader(): Array
| 获取响应头信息。 | + | 接口名称 | 功能描述 | + | ----------------------------------- | ------------------ | + | getRequestHeader(): Array\ | 获取请求头信息。 | + | getRequestUrl(): string | 获取请求的url信息。 | + | isMainFrame(): boolean | 获取请求是否时为了获取主窗口的信息。 | + | isRedirect(): boolean | 获取请求是否重定向。 | + | isRequestGesture(): boolean | 获取请求是否与手势关联。 | -### ConsoleMessage对象说明 +### WebResourceResponse对象说明 - 接口 - | 接口名称 | 功能描述 | - | ------------------------------- | ------------------------------ | - | getMessage(): string | 获取ConsoleMessage的日志信息。 | - | getSourceId(): string | 获取ConsoleMessage的源的Id。 | - | getLineNumber(): number | 获取ConsoleMessage的行数。 | - | getMessageLevel(): MessageLevel | 获取ConsoleMessage的信息级别。 | - -- MessageLevel枚举说明 - - | 名称 | 描述 | - | ----- | :--------- | - | Debug | 调试级别。 | - | Error | 错误级别。 | - | Info | 消息级别。 | - | Log | 日志级别。 | - | Warn | 警告级别。 | + | 接口名称 | 功能描述 | + | ------------------------------------ | ----------- | + | getReasonMessage(): string | 获取响应的状态码描述。 | + | getResponseCode(): number | 获取响应的状态码。 | + | getResponseData(): string | 获取响应数据。 | + | getResponseEncoding(): string | 获取响应的编码。 | + | getResponseHeader(): Array\ | 获取响应头信息。 | + | getResponseMimeType(): string | 获取响应的媒体类型。 | ## WebController @@ -187,6 +187,12 @@ accessStep(step: number): boolean | ---- | ------ | ---- | ---- | --------------------- | | step | number | 是 | - | 要跳转的步数，正数代表前进，负数代表后退。 | +### backward + +backward(): void + +页面后退。 + ### deleteJavaScriptRegister deleteJavaScriptRegister(name: string): void @@ -199,12 +205,6 @@ deleteJavaScriptRegister(name: string): void | ---- | ------ | ---- | ---- | ----------------------- | | name | string | 是 | - | 注册对象的名称，与HTML中调用的对象名一致。 | -### backward - -backward(): void - -页面后退。 - ### forward forward(): void @@ -238,13 +238,13 @@ loadData(options: { data: string, mimeType: string, encoding: string, baseUrl?: - options参数说明 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | ---------- | ------ | ---- | ---- | ------------------ | - | data | string | 是 | - | 需要加载的数据。 | - | mimeType | string | 是 | - | 媒体类型，格式为''\*/\*''。 | - | encoding | string | 是 | - | 编码类型。 | - | baseUrl | string | 否 | - | 基础URL。 | - | historyUrl | string | 否 | - | 历史URL。 | + | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | + | ---------- | ------ | ---- | ---- | -------- | + | data | string | 是 | - | 需要加载的数据。 | + | mimeType | string | 是 | - | 媒体类型。 | + | encoding | string | 是 | - | 编码类型。 | + | baseUrl | string | 否 | - | 基础URL。 | + | historyUrl | string | 否 | - | 历史URL。 | ### loadUrl @@ -254,10 +254,10 @@ loadUrl(options:{ url: string, headers?: Array<{ key: string, value: string }> } - options参数说明 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | --------------------- | ------------------------------------- | ---- | ---- | ---------- | - | url | string | 是 | - | 需要加载的 URL。 | - | additionalHttpHeaders | Array<{ key: string, value: string }> | 否 | [] | HTTP附加信息。 | + | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | + | ------- | ------------------------------------- | ---- | ---- | ---------- | + | url | string | 是 | - | 需要加载的 URL。 | + | headers | Array<{ key: string, value: string }> | 否 | [] | HTTP附加信息。 | ### onActive @@ -279,17 +279,17 @@ refresh(): void ### registerJavaScriptProxy -registerJavaScriptProxy(options: { obj: object, name: string, methodList: string[] }): void +registerJavaScriptProxy(options: { obj: object, name: string, methodList: Array\ }): void 将JavaScript对象与方法注册到Web内核，可被已加载的HTML直接调用。注册后，须调用refresh接口生效。 - options 参数说明 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | ---------- | -------- | ---- | ---- | ----------------------- | - | obj | object | 是 | - | 参与注册的对象。 | - | name | string | 是 | - | 注册对象的名称，与HTML中调用的对象名一致。 | - | methodList | string[] | 是 | - | 参与注册的方法。 | + | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | + | ---------- | --------------- | ---- | ---- | ----------------------- | + | obj | object | 是 | - | 参与注册的对象。 | + | name | string | 是 | - | 注册对象的名称，与HTML中调用的对象名一致。 | + | methodList | Array\ | 是 | - | 参与注册的方法。 | ### runJavaScript @@ -333,7 +333,7 @@ struct WebComponent { .fileAccess(this.fileAccess) .onPageEnd(e => { // test() 在 index.html 中已定义 - this.controller.runJavaScript('test()'); + this.controller.runJavaScript({ script: 'test()' }); console.log("url: ", e.url); }) } -- Gitee