Skip to content

D
Docs

OpenHarmony / Docs
大约 1 年 前同步成功

通知 159
Star 292
Fork 28
D
Docs

体验新版 GitCode，发现更多精彩内容 >>

未验证 提交 8cac606e 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!1953 fix the web ref doc. 

Merge pull request !1953 from lixingchi1/web_0311
上级 d538f013 2e9b3127
显示空白变更内容
内联 并排
Showing with 100 addition and 100 deletion
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-web.md
浏览文件 @ 8cac606e
......@@ -22,9 +22,9 @@ ohos.permission.READ_USER_STORAGE
表1 options参数说明
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ---------- | ------------------------------- | ---- | ---- | ------- |
| ---------- | ------------- | ---- | ---- | ------- |
| src | string | 是 | - | 网页资源地址。 |
| controller | [WebController](#WebController) | 否 | - | 控制器。 |
| controller | WebController | 否 | - | 控制器。 |
> ![icon-note.gif](public_sys-resources/icon-note.gif)**说明：**
......@@ -35,20 +35,20 @@ ohos.permission.READ_USER_STORAGE
## 属性
| 名称 | 参数类型 | 默认值 | 描述 |
| ----------------- | ------------------------------------------------------------ | -------------- | ------------------------------------------------------------ |
| domStorageAccess | boolean | false | 设置是否开启DOM Storage API权限，默认未开启。 |
| fileAccess | boolean | true | 设置是否开启Web中通过FILE方式访问应用中的本地文件， 默认启用。 |
| ----------------- | ---------------------------------------- | -------------- | ---------------------------------------- |
| domStorageAccess | boolean | false | 设置是否开启文档对象模型存储接口（DOM Storage API）权限，默认未开启。 |
| fileAccess | boolean | true | 设置是否开启Web中通过本地文件传输（FILE）协议方式访问应用中的本地文件， 默认启用。 |
| geolocationAccess | boolean | true | 设置是否允许访问地理位置， 默认允许访问。 |
| imageAccess | boolean | true | 设置是否允许自动加载图片资源，默认允许。 |
| javaScriptProxy | { <br> obj: object, <br/> name: string, <br/> methodList: Array\<string\>, <br/> controller: WebController <br>} | - | 注入JavaScript对象到超文本标记语言（HTML）中，并在HTML中调用该对象的方法，参数不支持更新。 <br> obj: 参与注册的对象。 <br> name: 注册对象的名称，与HTML中调用的对象名一致。<br> methodList: 参与注册的方法。<br> controller: 控制器。 |
| javaScriptAccess | boolean | true | 设置是否允许执行JavaScript脚本，默认允许执行。 |
| mixedMode | MixedMode | MixedMode.None | 设置是否允许加载HTTP和HTTPS混合内容，默认不允许加载HTTP和HTTPS混合内容。 |
| mixedMode | MixedMode | MixedMode.None | 设置是否允许加载超文本传输协议（HTTP）和超文本传输安全协议（HTTPS）混合内容，默认不允许加载HTTP和HTTPS混合内容。 |
| onlineImageAccess | boolean | true | 设置是否允许从网络加载图片资源（通过HTTP和HTTPS访问的资源），默认允许访问。 |
| zoomAccess | boolean | true | 设置是否支持使用屏幕控件或手势进行缩放，默认允许执行缩放。 |
| javaScriptProxy | { <br> obj: object, <br/> name: string, <br/> methodList: Array<string>, <br/> controller: [WebController](#WebController) <br>} | - | 注入ArkUI对象到HTML中，并在HTML中调用该对象的方法，参数不支持更新。 <br> -obj: 参与注册的对象。 <br> -name: 注册对象的名称，与HTML中调用的对象名一致。<br> -methodList: 参与注册的方法。<br> -controller: 控制器。 |
> ![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) | <p>下载开始时触发该回调。<br />url：Web引擎返回的下载URL。<br />userAgent：Web引擎返回的用户代理名称。<br />contentDisposition：Web引擎返回的响应头。<br />mimetype：Web引擎返回的mimetype信息。<br />contentLength：Web引擎返回的内容长度。</p> |
| ---------------------------------------- | ---------------------------------------- |
| onAlert(callback: (event?: { url: string; message: string; result: JsResult }) => boolean) | <p>网页触发alert()告警弹窗时触发。<br />url：Web组件返回的下载URL。<br />message：Web组件返回的信息。<br />JsResult：Web组件返回的弹窗确认或弹窗取消功能对象。</p> |
| onBeforeUnload(callback: (event?: { url: string; message: string; result: JsResult }) => boolean) | <p>即将离开当前页面（刷新或关闭）时触发。<br />url：Web组件返回的下载URL。<br />message：Web组件返回的信息。<br />JsResult：Web组件返回的弹窗确认或弹窗取消功能对象。</p> |
| onConfirm(callback: (event?: { url: string; message: string; result: JsResult }) => boolean) | <p>网页触发confirm()确认弹窗时触发。<br />url：Web组件返回的下载URL。<br />message：Web组件返回的信息。<br />JsResult：Web组件返回的弹窗确认或弹窗取消功能对象。</p> |
| onConsole(callback: (event?: { message: ConsoleMessage }) => boolean) | <p>向主应用报告JavaScript控制台消息时触发该回调。<br/>message：触发的控制台信息。</p> |
| onDownloadStart(callback: (event?: { url: string, userAgent: string, contentDisposition: string, mimetype: string, contentLength: number }) => void) | <p>下载开始时触发该回调。<br />url：Web组件返回的下载URL。<br />userAgent：Web组件返回的用户代理名称。<br />contentDisposition：Web组件返回的响应头。<br />mimetype：Web组件返回的媒体类型（MIME）信息。<br />contentLength：Web组件返回的内容长度。</p> |
| onErrorReceive(callback: (event?: { request: WebResourceRequest, error: WebResourceError }) => void) | <p>网页加载错误时触发该回调。<br/>request：网页的请求信息。<br/>error：网页的错误信息 。</p> |
| onGeolocationHide(callback: () => void) | <p>调用onGeolocationShow时发出的地理位置权限请求被取消后触发该回调。</p> |
| onGeolocationShow(callback: (event?: { origin: string, geolocation: JsGeolocation }) => void) | <p>应用尝试使用地理位置时触发该回调，并向用户请求权限。<br/>origin：尝试获取地理位置的Web内容的来源。<br/>geolocation：用于请求地理位置权限。</p> |
| onPageBegin(callback: (event?: { url: string }) => void) | <p>网页加载时触发该回调。<br/>url：Web引擎返回的URL。</p> |
| onPageEnd(callback: (event?: { url: string }) => void) | <p>网页加载结束时触发该回调。<br/>url：Web引擎返回的URL。</p> |
| onHttpErrorReceive(callback: (event?: { request: WebResourceRequest, response: WebResourceResponse }) => void) | <p>网页加载出现网络错误时触发该回调。<br/>request：网页的请求信息。<br/>response：网页的响应信息</p> |
| onPageBegin(callback: (event?: { url: string }) => void) | <p>网页加载时触发该回调。<br/>url：Web组件返回的URL。</p> |
| onPageEnd(callback: (event?: { url: string }) => void) | <p>网页加载结束时触发该回调。<br/>url：Web组件返回的URL。</p> |
| onProgressChange(callback: (event?: { newProgress: number }) => void) | <p>网页加载进度变化时触发该回调。<br/>newProgress：加载进度，取值范围为0到100的整数。</p> |
| onTitleReceive(callback: (event?: { title: string }) => void) | <p>网页主页面标题更改时触发该回调。<br/>title：标题内容。</p> |
| onErrorReceive(callback: (event?: { request: WebResourceRequest, error: WebResourceError }) => void) | <p>网页加载错误时触发该回调。<br/>request：网页的请求信息。<br/>error：网页的错误信息 。</p> |
| onHttpErrorReceive(callback: (event?: { request: WebResourceRequest, response: WebResourceResponse }) => void) | <p>网页加载出现网络错误时触发该回调。<br/>request：网页的请求信息。<br/>response：网页的响应信息</p> |
| onConsole(callback: (event?: { message: ConsoleMessage }) => boolean) | <p>向主应用报告JavaScript控制台消息时触发该回调。<br/>message：触发的控制台信息。</p> |
| onAlert(callback: (event?: { url: string; message: string; result: JsResult }) => boolean) | <p>网页触发alert()告警弹窗时触发。<br />url：Web引擎返回的下载URL。<br />message：Web引擎返回的信息。<br />JsResult：Web引擎返回的弹窗确认或弹窗取消功能对象。</p> |
| onBeforeUnload(callback: (event?: { url: string; message: string; result: JsResult }) => boolean) | <p>网页重新加载或关闭时触发。<br />url：Web引擎返回的下载URL。<br />message：Web引擎返回的信息。<br />JsResult：Web引擎返回的弹窗确认或弹窗取消功能对象。</p> |
| onConfirm(callback: (event?: { url: string; message: string; result: JsResult }) => boolean) | <p>即将离开当前页面（刷新或关闭）时触发。<br />url：Web引擎返回的下载URL。<br />message：Web引擎返回的信息。<br />JsResult：Web引擎返回的弹窗确认或弹窗取消功能对象。</p> |
### JsResult 对象说明
Web引擎返回的弹窗确认或弹窗取消功能对象。
### ConsoleMessage对象说明
- 接口
| 接口名称 | 功能描述 |
| --------------------- | ----------------- |
| handleCancel(): void | <p>取消弹窗。</p> |
| handleConfirm(): void | <p>确认弹窗。</p> |
| ------------------------------- | ---------------------- |
| getLineNumber(): number | 获取ConsoleMessage的行数。 |
| getMessage(): string | 获取ConsoleMessage的日志信息。 |
| getMessageLevel(): MessageLevel | 获取ConsoleMessage的信息级别。 |
| getSourceId(): string | 获取ConsoleMessage的源的Id。 |
- MessageLevel枚举说明
| 名称 | 描述 |
| ----- | :---- |
| Debug | 调试级别。 |
| Error | 错误级别。 |
| Info | 消息级别。 |
| Log | 日志级别。 |
| Warn | 警告级别。 |
### JsGeolocation 对象说明
......@@ -95,63 +105,53 @@ Web引擎返回的弹窗确认或弹窗取消功能对象。
- 接口
| 接口名称 | 功能描述 |
| ------------------------------------------------------------ | ------------------------------------------------------------ |
| ---------------------------------------- | ---------------------------------------- |
| invoke(origin: string, allow: boolean, retain: boolean): void | <p>通知系统用户是否批准该应用使用地理位置权限。<br/>origin：尝试获取地理位置的Web内容的来源。<br/>allow：用户是否批准该应用使用地理位置权限。true: 允许访问，false: 不允许访问。<br/>retain：是否允许将地理位置权限状态保存到系统中。true: 允许，false: 不允许。</p> |
### WebResourceRequest对象说明
### JsResult 对象说明
Web组件返回的弹窗确认或弹窗取消功能对象。
- 接口
| 接口名称 | 功能描述 |
| --------------------------------- | ------------------------------------ |
| getRequestUrl(): string | 获取请求的url信息。 |
| isRequestGesture(): boolean | 获取请求是否与手势关联。 |
| isMainFrame(): boolean | 获取请求是否时为了获取主窗口的信息。 |
| isRedirect(): boolean | 获取请求是否重定向。 |
| getRequestHeader(): Array<Header> | 获取请求头信息。 |
| --------------------- | ------------ |
| handleCancel(): void | <p>取消弹窗。</p> |
| handleConfirm(): void | <p>确认弹窗。</p> |
### WebResourceError对象说明
- 接口
| 接口名称 | 功能描述 |
| ---------------------- | ------------------------ |
| getErrorInfo(): string | 获取加载资源的错误信息。 |
| ---------------------- | ------------ |
| getErrorCode(): number | 获取加载资源的错误码。 |
| getErrorInfo(): string | 获取加载资源的错误信息。 |
### WebResourceResponse对象说明
### WebResourceRequest对象说明
- 接口
| 接口名称 | 功能描述 |
| ---------------------------------- | ---------------------- |
| getResponseData(): string | 获取响应数据。 |
| getResponseEncoding(): string | 获取响应的编码。 |
| getResponseMimeType(): string | 获取响应的MIME类型。 |
| getResponseCode(): number | 获取响应的状态码。 |
| getReasonMessage(): string | 获取响应的状态码描述。 |
| getResponseHeader(): Array<Header> | 获取响应头信息。 |
| ----------------------------------- | ------------------ |
| getRequestHeader(): Array\<Header\> | 获取请求头信息。 |
| 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\<Header\> | 获取响应头信息。 |
| 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
......@@ -239,9 +239,9 @@ loadData(options: { data: string, mimeType: string, encoding: string, baseUrl?:
- options参数说明
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ---------- | ------ | ---- | ---- | ------------------ |
| ---------- | ------ | ---- | ---- | -------- |
| data | string | 是 | - | 需要加载的数据。 |
| mimeType | string | 是 | - | 媒体类型，格式为''\*/\*''。 |
| mimeType | string | 是 | - | 媒体类型。 |
| encoding | string | 是 | - | 编码类型。 |
| baseUrl | string | 否 | - | 基础URL。 |
| historyUrl | string | 否 | - | 历史URL。 |
......@@ -255,9 +255,9 @@ loadUrl(options:{ url: string, headers?: Array<{ key: string, value: string }> }
- options参数说明
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| --------------------- | ------------------------------------- | ---- | ---- | ---------- |
| ------- | ------------------------------------- | ---- | ---- | ---------- |
| url | string | 是 | - | 需要加载的 URL。 |
| additionalHttpHeaders | Array<{ key: string, value: string }> | 否 | [] | HTTP附加信息。 |
| 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\<string\> }): void
将JavaScript对象与方法注册到Web内核，可被已加载的HTML直接调用。注册后，须调用refresh接口生效。
- options 参数说明
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ---------- | -------- | ---- | ---- | ----------------------- |
| ---------- | --------------- | ---- | ---- | ----------------------- |
| obj | object | 是 | - | 参与注册的对象。 |
| name | string | 是 | - | 注册对象的名称，与HTML中调用的对象名一致。 |
| methodList | string[] | 是 | - | 参与注册的方法。 |
| methodList | Array\<string\> | 是 | - | 参与注册的方法。 |
### 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);
})
}
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或