Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
230a5b04
D
Docs
项目概览
OpenHarmony
/
Docs
1 年多 前同步成功
通知
159
Star
292
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
提交
230a5b04
编写于
2月 25, 2022
作者:
L
lixingchi1
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
add web component js api.
Signed-off-by:
N
lixingchi1
<
lixingchi1@huawei.com
>
上级
77dbbd92
变更
1
显示空白变更内容
内联
并排
Showing
1 changed file
with
178 addition
and
49 deletion
+178
-49
zh-cn/application-dev/reference/arkui-ts/ts-media-components-web.md
...ication-dev/reference/arkui-ts/ts-media-components-web.md
+178
-49
未找到文件。
zh-cn/application-dev/reference/arkui-ts/ts-media-components-web.md
浏览文件 @
230a5b04
# Web
>![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
>该组件从
API Version 8
开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
>该组件从
API Version 8
开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
提供具有网页显示能力的
Web
组件。
提供具有网页显示能力的
Web
组件。
## 权限列表
...
...
@@ -17,57 +17,58 @@ ohos.permission.READ_USER_STORAGE
## 接口
-
Web
\(
options: {
src: string, controller?: WebController
}
\)
-
Web
\(
options: {
src: string, controller?: WebController
}
\)
表1 options
参数说明
表1 options参数说明
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ---------- | ------------------------------- | ---- | ----
-- | -------
------- |
| ---------- | ------------------------------- | ---- | ----
|
------- |
| src | string | 是 | - | 网页资源地址。 |
| controller | [WebController](#WebController) | 否 | - | 控制器。 |
> ![icon-note.gif](public_sys-resources/icon-note.gif)**说明:**
>
> - 一个页面只支持一个 Web 组件,全屏显示,页面中的其他组件会被 Web 组件遮挡;
> - 不支持转场动画;
> - 只支持加载 rawfile 目录下的 html 文件,不支持远程资源。
> - 不支持音视频播放;
> - 不支持横竖屏事件。
## 属性
| 名称 | 参数类型 | 默认值 | 描述 |
| ----------------- | ---------------- | ------------------------------------------ | ------------------------------------------------------------ |
| javaScriptAccess | boolean | true | 是否允许执行 JavaScript 脚本,默认允许执行。 |
| fileAccess | boolean | true | 启用或禁用 Web 中可通过 file 方式访问应用中的本地文件, 默认启用。 |
| onlineImageAccess | boolean | true | 是否允许从网络加载图片 资源(通过http和http访问的资源),默认允许访问。 |
| domStorageAccess | boolean | false | 设置是否开启DOM存储API权限,默认未开启,设置为true时,WebView能够使用DOM storageAPI。 |
| ----------------- | --------- | -------------- | ---------------------------------------- |
| domStorageAccess | boolean | false | 设置是否开启DOM Storage API权限,默认未开启。 |
| fileAccess | boolean | true | 设置是否开启Web中通过FILE方式访问应用中的本地文件, 默认启用。 |
| geolocationAccess | boolean | true | 设置是否允许访问地理位置, 默认允许访问。 |
| imageAccess | boolean | true | 设置是否允许自动加载图片资源,默认允许。 |
| mixedMode | MixedModeContent | MixedModeContent.MIXED_CONTENT_NEVER_ALLOW | 设置是否加载http和https混合内容,默认不允许加载http和https混合内容。 |
| zoomAccess | boolean | true | 设置是否支持使用屏幕控件或手势进行缩放,默认执行缩放。 |
| geolocationAccess | boolean | true | 是否允许访问地理位置, 默认允许。 |
| 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) **说明:**
>
>
不支持通用属性
。
-
MixedMode
Content
枚举说明
>
通用属性仅支持width、height、padding、margin、border
。
-
MixedMode枚举说明
| 名称 | 描述 |
| ----------
---------------------- | --------------------
---------------------------------------- |
|
MIXED_CONTENT_NEVER_ALLOW | 不允许加载http和https混合内容。
|
|
MIXED_CONTENT_ALWAYS_ALLOW | 允许加载http和https混合内容。
|
|
MIXED_CONTENT_COMPATIBILITY_MODE | 混合内容兼容性模式,一些不安全的内容可能被安全来源加载,其他类型的内容将被阻止。
|
| ----------
|
---------------------------------------- |
|
All | 允许加载HTTP和HTTPS混合内容。
|
|
Compatible | 混合内容兼容性模式,一些不安全的内容可能被安全来源加载,其他类型的内容将被阻止。
|
|
None | 不允许加载HTTP和HTTPS混合内容。
|
## 事件
不支持通用事件
。
通用事件仅支持onFocus
。
| 名称 | 功能描述 |
| ------------------------------------------------------------ | ------------------------------------------------------------ |
| onPageEnd(callback: (event?: { url: string }) => void) |
<p>
网页加载结束时触发该回调。
<br/>
url:Web 引擎返回的 URL。
</p>
|
| onPageBegin(callback: (event?: {url: string }) => void) |
<p>
网页加载时触发该回调。
<br/>
url:Web 引擎返回的 URL。
</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引擎返回的mimetype信息。
<br
/>
contentLength:Web引擎返回的内容长度。
</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>
|
| onProgressChange(callback: (event?: { newProgress: number }) => void) |
<p>
网页加载进度变化时触发该回调。
<br/>
newProgress:加载进度,取值范围为0到100的整数。
</p>
|
| onTitleReceive(callback: (event?: { title: string }) => void) |
<p>
网页主页面标题更改时触发该回调。
<br/>
title:标题内容。
</p>
|
| onGeolocationHide(callback: () => void) |
<p>
调用onGeolocationShow()时发出的地理位置权限请求被取消后触发该回调。
<br/>
开发者可以在该回调中实现隐藏相关UI界面的逻辑。
</p>
|
| onGeolocationShow(callback: (event?: { origin: string, geolocation: JsGeolocation }) => void) |
<p>
应用尝试使用地理位置时触发该回调,并向用户请求权限。
<br/>
-origin:尝试获取地理位置的Web内容的来源。
<br/>
-geolocation:用于请求地理位置权限。
</p>
|
### JsGeolocation 对象说明
...
...
@@ -76,8 +77,8 @@ ohos.permission.READ_USER_STORAGE
-
接口
| 接口名称 | 功能描述 |
| ----------------------------------------
-------------------- | --------------------
---------------------------------------- |
| invoke(origin: string, allow: boolean, retain: boolean): void |
<p>
通知系统用户是否批准该应用使用地理位置权限。
<br/>
-origin:尝试获取地理位置的Web内容的来源。
<br/>
-allow:用户是否批准该应用使用地理位置权限。true: 允许访问,false: 不允许访问。
<br/>
-
retain:是否允许将地理位置权限状态保存到系统中。true: 允许,false: 不允许。
</p>
|
| ----------------------------------------
|
---------------------------------------- |
| invoke(origin: string, allow: boolean, retain: boolean): void |
<p>
通知系统用户是否批准该应用使用地理位置权限。
<br/>
origin:尝试获取地理位置的Web内容的来源。
<br/>
allow:用户是否批准该应用使用地理位置权限。true: 允许访问,false: 不允许访问。
<br/>
retain:是否允许将地理位置权限状态保存到系统中。true: 允许,false: 不允许。
</p>
|
## WebController
...
...
@@ -89,30 +90,158 @@ Web 组件的控制器。
webController: WebController = new WebController()
```
### runJavaScript
### accessBackward
accessBackward(): boolean
当前页面是否可后退。
### accessForward
runJavaScript(script: string): void
accessForward(): boolean
执行 JavaScript 脚本。
当前页面是否可前进。
### accessStep
accessStep(step: number): boolean
当前页面是否可前进或者后退step步。
-
参数
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ------ | ------ | ---- | ---- | -------------- |
| script | string | 是 | - | JavaScript 脚本。 |
| ---- | ------ | ---- | ---- | --------------------- |
| step | number | 是 | - | 要跳转的步数,正数代表前进,负数代表后退。 |
### deleteJavaScriptRegister
deleteJavaScriptRegister(options: { name: string }): void
清空指定对象已注册的JavaScript方法。
-
options参数说明
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ---- | ------ | ---- | ---- | ----------------------- |
| name | string | 是 | - | 注册对象的名称,与HTML中调用的对象名一致。 |
### backward
backward(): void
页面后退。
### forward
forward(): void
页面前进。
### getHitTest
getHitTest(): HitTestType
获取当前已点击的对象类型。
-
HitTestType枚举说明
| 名称 | 描述 |
| ------- | -------------------------------- |
| Edit | 可编辑的区域。 |
| Email | 邮件地址。 |
| Http | HTTP网址的HTML
\<
a
\>
标签。 |
| HttpImg | HTTP网址与
\<
img
\>
标签组成的HTML
\<
a
\>
标签。 |
| Img | HTML
\<
img
\>
标签。 |
| Map | 地图地址。 |
| Phone | 电话号码。 |
| Unknown | 未知内容。 |
### loadData
loadData(options: { data: string, mimeType: string, encoding: string, baseUrl?: string, historyUrl?: string }): void
加载数据。
-
options参数说明
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ---------- | ------ | ---- | ---- | ------------------ |
| data | string | 是 | - | 需要加载的数据。 |
| mimeType | string | 是 | - | 媒体类型,格式为''
\*
/
\*
''。 |
| encoding | string | 是 | - | 编码类型。 |
| baseUrl | string | 否 | - | 基础URL。 |
| historyUrl | string | 否 | - | 历史URL。 |
### loadUrl
loadUrl(url: string): void
loadUrl(url: string
, additionalHttpHeaders?: Array
<
{
key:
string
,
value:
string
}
>
): void
加载
URL。
加载URL。
-
参数
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ----
|
------ | ---- | ---- | ---------- |
| ----
----------------- | -------------------------------
------ | ---- | ---- | ---------- |
| url | string | 是 | - | 需要加载的 URL。 |
| additionalHttpHeaders | Array
<
{
key:
string
,
value:
string
}
>
| 否 | [] | HTTP附加信息。 |
### onActive
onActive(): void
页面重新激活。当Web被重新激活为活跃状态时,执行此方法。
### onInactive
onInactive(): void
页面暂停渲染。当Web被切换到后台不可见状态时,执行此方法。
### refresh
refresh(): void
刷新页面。
### registerJavaScriptProxy
registerJavaScriptProxy(options: { obj: object, name: string, methodList: string[] }): void
将JavaScript对象与方法注册到Web内核,可被已加载的HTML直接调用。注册后,须调用refresh接口生效。
-
options 参数说明
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ---------- | -------- | ---- | ---- | ----------------------- |
| obj | object | 是 | - | 参与注册的对象。 |
| name | string | 是 | - | 注册对象的名称,与HTML中调用的对象名一致。 |
| methodList | string[] | 是 | - | 参与注册的方法。 |
### runJavaScript
runJavaScript(script: string, callback?: (result: string) => void): void
执行JavaScript脚本。
-
参数
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | ------------------------ | ---- | ---- | ------------------------------------ |
| script | string | 是 | - | JavaScript脚本。 |
| callback | (result: string) => void | 否 | - | 回调执行JavaScript脚本结果,默认result为null字符串。 |
### requestFocus
requestFocus(): void
Web组件获焦。
### stop
stop(): void
停止页面加载。
## 示例
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录