属性
通用属性仅支持aspectRatio、backdropBlur、backgroundColor、bindContentCover、bindContextMenu、bindMenu 、bindSheet、borderColor、borderRadius、borderStyle、borderWidth、clip、constraintSize、defaultFocus、focusable、tabIndex、groupDefaultFocus、displayPriority、enabled、flexBasis、flexShrink、layoutWeight、id、gridOffset、gridSpan、useSizeType、height、touchable、margin、markAnchor、offset、width、zIndex、visibility、scale、translate、responseRegion、size、opacity、shadow、sharedTransition、transition、position、direction。
说明:
该组件首批接口从API version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
示例效果请以真机运行为准。
domStorageAccess
domStorageAccess(domStorageAccess: boolean)
设置是否开启文档对象模型存储接口(DOM Storage API)权限,当属性没有显式调用时,默认不开启文档对象模型存储接口(DOM Storage API)权限。
系统能力: SystemCapability.Web.Webview.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| domStorageAccess | boolean | 是 | 设置是否开启文档对象模型存储接口(DOM Storage API)权限。 true表示开启文档对象模型存储接口权限,false表示不开启文档对象模型存储接口权限。 传入undefined或null时为false。 |
说明:
- 网页中使用到文档对象模型存储接口(DOM Storage API),需将其设置为true,才可正常加载网页。
示例:
// xxx.ets
import { webview } from '@kit.ArkWeb';
@Entry
@Component
struct WebComponent {
controller: webview.WebviewController = new webview.WebviewController();
build() {
Column() {
Web({ src: 'www.example.com', controller: this.controller })
.domStorageAccess(true)
}
}
}
fileAccess
fileAccess(fileAccess: boolean)
设置是否开启应用中文件系统的访问。$rawfile(filepath/filename)中的文件不受该属性影响而被限制访问。API version 11及以前,当属性没有显式调用时,默认开启应用中文件系统的访问。API version 12及以后,当属性没有显式调用时,默认不开启应用中文件系统的访问。
系统能力: SystemCapability.Web.Webview.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| fileAccess | boolean | 是 | 设置是否开启应用中文件系统的访问。 true表示开启应用中文件系统的访问。false表示不开启应用中文件系统的访问。 同时,当fileAccess为false的时候,仅只读资源目录 /data/storage/el1/bundle/entry/resources/resfile里面的资源依然可以通过file协议访问,不受fileAccess管控。API version 11及以前,传入undefined或null时为true,API version 12及以后传入undefined或null时为false。 |
示例:
// xxx.ets
import { webview } from '@kit.ArkWeb';
@Entry
@Component
struct WebComponent {
controller: webview.WebviewController = new webview.WebviewController();
build() {
Column() {
Web({ src: 'www.example.com', controller: this.controller })
.fileAccess(true)
}
}
}
imageAccess
imageAccess(imageAccess: boolean)
设置是否允许自动加载图片资源。当属性没有显式调用时,允许自动加载图片资源。
系统能力: SystemCapability.Web.Webview.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| imageAccess | boolean | 是 | 设置是否允许自动加载图片资源。 true表示设置允许自动加载图片资源,false表示设置不允许自动加载图片资源。 传入undefined或null时为false。 |
示例:
// xxx.ets
import { webview } from '@kit.ArkWeb';
@Entry
@Component
struct WebComponent {
controller: webview.WebviewController = new webview.WebviewController();
build() {
Column() {
Web({ src: 'www.example.com', controller: this.controller })
.imageAccess(true)
}
}
}
javaScriptProxy
javaScriptProxy(javaScriptProxy: JavaScriptProxy)
将javaScriptProxy中的ArkTS对象注册到Web组件中,该对象将使用JavaScriptProxy中指定的名称注册到网页的所有框架中,包括所有iframe,这使得JavaScript可以调用javaScriptProxy中ArkTS对象的方法。当属性没有显式调用时,默认不将javaScriptProxy中的ArkTS对象注册到Web组件中。
说明:
javaScriptProxy接口需要和deleteJavaScriptRegister9+接口配合使用,防止内存泄漏。 javaScriptProxy对象的所有参数不支持更新。 注册javaScriptProxy对象时,同步与异步列表请至少选择一项不为空,可同时注册两类方法。 此接口只支持注册一个对象,若需要注册多个对象请使用registerJavaScriptProxy9+。
系统能力: SystemCapability.Web.Webview.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| javaScriptProxy | JavaScriptProxy | 是 | 参与注册的对象。只能声明方法,不能声明属性。 传入undefined或null时不将javaScriptProxy中的ArkTS对象注册到Web组件中。 |
示例:
// xxx.ets
import { webview } from '@kit.ArkWeb';
import { BusinessError } from '@kit.BasicServicesKit';
class TestObj {
constructor() {
}
test(data1: string, data2: string, data3: string): string {
console.info("data1:" + data1);
console.info("data2:" + data2);
console.info("data3:" + data3);
return "AceString";
}
asyncTest(data: string): void {
console.info("async data:" + data);
}
toString(): void {
console.info('toString' + "interface instead.");
}
}
@Entry
@Component
struct WebComponent {
controller: webview.WebviewController = new webview.WebviewController();
testObj = new TestObj();
build() {
Column() {
Button('deleteJavaScriptRegister')
.onClick(() => {
try {
this.controller.deleteJavaScriptRegister("objName");
} catch (error) {
console.error(`ErrorCode: ${(error as BusinessError).code}, Message: ${(error as BusinessError).message}`);
}
})
Web({ src: 'www.example.com', controller: this.controller })
.javaScriptAccess(true)
.javaScriptProxy({
object: this.testObj,
name: "objName",
methodList: ["test", "toString"],
asyncMethodList: ["asyncTest"],
controller: this.controller,
})
}
}
}
javaScriptAccess
javaScriptAccess(javaScriptAccess: boolean)
设置是否允许执行JavaScript脚本。当属性没有显式调用时,默认允许执行JavaScript脚本。
系统能力: SystemCapability.Web.Webview.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| javaScriptAccess | boolean | 是 | 是否允许执行JavaScript脚本。 true表示允许执行JavaScript脚本,false表示不允许执行JavaScript脚本。 传入undefined或null时为false。 |
示例:
// xxx.ets
import { webview } from '@kit.ArkWeb';
@Entry
@Component
struct WebComponent {
controller: webview.WebviewController = new webview.WebviewController();
build() {
Column() {
Web({ src: 'www.example.com', controller: this.controller })
.javaScriptAccess(true)
}
}
}
overScrollMode11+
overScrollMode(mode: OverScrollMode)
设置Web过滚动模式。当过滚动模式开启时,当用户在Web根页面上滑动到边缘时,Web会通过弹性动画弹回界面,根页面上的内部页面不会触发回弹。该属性没有显式调用时,默认关闭过滚动模式。
系统能力: SystemCapability.Web.Webview.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| mode | OverScrollMode | 是 | 设置Web的过滚动模式为关闭或开启。 传入undefined或null时为OverScrollMode.NEVER。 |
示例:
// xxx.ets
import { webview } from '@kit.ArkWeb';
@Entry
@Component
struct WebComponent {
controller: webview.WebviewController = new webview.WebviewController();
@State mode: OverScrollMode = OverScrollMode.ALWAYS;
build() {
Column() {
Web({ src: 'www.example.com', controller: this.controller })
.overScrollMode(this.mode)
}
}
}
mixedMode
mixedMode(mixedMode: MixedMode)
设定当安全源尝试从非安全源加载资源时的行为。当属性没有显式调用时,默认值为MixedMode.None,即禁止安全源从非安全源加载内容。
系统能力: SystemCapability.Web.Webview.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| mixedMode | MixedMode | 是 | 要设置的混合内容模式。 传入undefined或null时为MixedMode.All。 |
示例:
// xxx.ets
import { webview } from '@kit.ArkWeb';
@Entry
@Component
struct WebComponent {
controller: webview.WebviewController = new webview.WebviewController();
@State mode: MixedMode = MixedMode.All;
build() {
Column() {
Web({ src: 'www.example.com', controller: this.controller })
.mixedMode(this.mode)
}
}
}
onlineImageAccess
onlineImageAccess(onlineImageAccess: boolean)
设置是否允许从网络加载图片资源(通过HTTP和HTTPS访问的资源)。当属性没有显式调用时,默认允许从网络加载图片资源。
系统能力: SystemCapability.Web.Webview.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| onlineImageAccess | boolean | 是 | 设置是否允许从网络加载图片资源。 true表示设置允许从网络加载图片资源,false表示设置不允许从网络加载图片资源。 传入undefined或null时为false。 |
示例:
// xxx.ets
import { webview } from '@kit.ArkWeb';
@Entry
@Component
struct WebComponent {
controller: webview.WebviewController = new webview.WebviewController();
build() {
Column() {
Web({ src: 'www.example.com', controller: this.controller })
.onlineImageAccess(true)
}
}
}
zoomAccess
zoomAccess(zoomAccess: boolean)
设置是否支持手势进行缩放。该属性没有显式调用时,默认支持手势进行缩放。
系统能力: SystemCapability.Web.Webview.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| zoomAccess | boolean | 是 | 设置是否支持手势进行缩放。 true表示设置支持手势进行缩放,false表示设置不支持手势进行缩放。 传入undefined或null时为false。 |
示例:
// xxx.ets
import { webview } from '@kit.ArkWeb';
@Entry
@Component
struct WebComponent {
controller: webview.WebviewController = new webview.WebviewController();
build() {
Column() {
Web({ src: 'www.example.com', controller: this.controller })
.zoomAccess(true)
}
}
}
overviewModeAccess
overviewModeAccess(overviewModeAccess: boolean)
设置是否使用概览模式加载网页,即缩小内容以适应屏幕宽度。当属性没有显式调用时,默认允许使用概览模式加载网页。
系统能力: SystemCapability.Web.Webview.Core
设备行为差异: 该接口在PC/2in1设备中无效果,在其他设备中可正常调用。
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| overviewModeAccess | boolean | 是 | 设置是否使用概览模式加载网页。 true表示设置使用概览模式加载网页,false表示设置不使用概览模式加载网页。 传入undefined或null时为false。 |
示例:
// xxx.ets
import { webview } from '@kit.ArkWeb';
@Entry
@Component
struct WebComponent {
controller: webview.WebviewController = new webview.WebviewController();
build() {
Column() {
Web({ src: 'www.example.com', controller: this.controller })
.overviewModeAccess(true)
}
}
}
databaseAccess
databaseAccess(databaseAccess: boolean)
设置Web SQL数据库存储API权限,若未显式调用,此权限默认关闭。
说明:
- 本接口在ArkWeb内核升级到M132版本后因内核废弃Web SQL,对Web SQL数据库的控制失效。ArkWeb内核版本参考ArkWeb简介约束与限制。
系统能力: SystemCapability.Web.Webview.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| databaseAccess | boolean | 是 | 设置是否开启Web SQL数据库存储API权限。 true表示开启,false表示关闭。 传入undefined或null时为false。 |
示例:
// xxx.ets
import { webview } from '@kit.ArkWeb';
@Entry
@Component
struct WebComponent {
controller: webview.WebviewController = new webview.WebviewController();
build() {
Column() {
Web({ src: 'www.example.com', controller: this.controller })
.databaseAccess(true)
}
}
}
geolocationAccess
geolocationAccess(geolocationAccess: boolean)
设置是否开启获取地理位置权限。当属性没有显式调用时,默认开启获取地理位置权限。具体使用方式参考管理位置权限。
系统能力: SystemCapability.Web.Webview.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| geolocationAccess | boolean | 是 | 设置是否开启获取地理位置权限。 true表示设置开启获取地理位置权限,false表示设置不开启获取地理位置权限。 传入undefined或null时为false。 |
示例:
// xxx.ets
import { webview } from '@kit.ArkWeb';
@Entry
@Component
struct WebComponent {
controller: webview.WebviewController = new webview.WebviewController();
build() {
Column() {
Web({ src: 'www.example.com', controller: this.controller })
.geolocationAccess(true)
}
}
}
mediaPlayGestureAccess9+
mediaPlayGestureAccess(access: boolean)
设置有声视频的自动播放是否需要用户手动点击,静音视频播放不受该接口管控。当该属性未显式设置时,默认有声视频的自动播放需要用户手动点击。
系统能力: SystemCapability.Web.Webview.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| access | boolean | 是 | 设置有声视频的自动播放是否需要用户手动点击。 true表示设置有声视频的自动播放需要用户手动点击,false表示设置有声视频的自动播放不需要用户手动点击,能自动播放。 传入undefined或null时为false。 |
示例:
// xxx.ets
import { webview } from '@kit.ArkWeb';
@Entry
@Component
struct WebComponent {
controller: webview.WebviewController = new webview.WebviewController();
@State access: boolean = true;
build() {
Column() {
Web({ src: $rawfile('index.html'), controller: this.controller })
.mediaPlayGestureAccess(this.access)
}
}
}
加载的html文件。
<!--index.html-->
<!DOCTYPE html>
<html>
<head>
<title>视频播放页面</title>
</head>
<body>
<h1>视频播放</h1>
<video id="testVideo" controls autoplay>
// 需要在video标签中配置autoplay属性,允许视频自动播放
// 在resources的rawfile目录放置任意一个mp4媒体文件,并将其命名为example.mp4
<source src="example.mp4" type="video/mp4">
</video>
</body>
</html>
multiWindowAccess9+
multiWindowAccess(multiWindow: boolean)
设置是否开启多窗口权限。当属性没有显式调用时,默认不开启多窗口权限。
使能多窗口权限时,需要实现onWindowNew事件,示例代码参考onWindowNew。
系统能力: SystemCapability.Web.Webview.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| multiWindow | boolean | 是 | 设置是否开启多窗口权限。 true表示设置开启多窗口权限,false表示设置不开启多窗口权限。 |
horizontalScrollBarAccess9+
horizontalScrollBarAccess(horizontalScrollBar: boolean)
设置是否显示横向滚动条,包括系统默认滚动条和用户自定义滚动条。该属性没有显式调用时,默认显示横向滚动条。
说明:
- 通过@State变量控制横向滚动条的隐藏/显示后,需要调用controller.refresh()生效。
- 通过@State变量频繁动态改变时,建议切换开关变量和Web组件一一对应。
系统能力: SystemCapability.Web.Webview.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| horizontalScrollBar | boolean | 是 | 设置是否显示横向滚动条。 true表示设置显示横向滚动条,false表示设置不显示横向滚动条。 传入undefined或null时为false。 |
示例:
// xxx.ets
import { webview } from '@kit.ArkWeb';
import { BusinessError } from '@kit.BasicServicesKit';
@Entry
@Component
struct WebComponent {
controller: webview.WebviewController = new webview.WebviewController();
@State isShow: boolean = true;
@State btnMsg: string ="隐藏滚动条";
build() {
Column() {
// 通过@State变量改变横向滚动条的隐藏/显示后,需调用this.controller.refresh()后生效
Button('refresh')
.onClick(() => {
if(this.isShow){
this.isShow = false;
this.btnMsg="显示滚动条";
}else{
this.isShow = true;
this.btnMsg="隐藏滚动条";
}
try {
this.controller.refresh();
} catch (error) {
console.error(`ErrorCode: ${(error as BusinessError).code}, Message: ${(error as BusinessError).message}`);
}
}).height("10%").width("40%")
Web({ src: $rawfile('index.html'), controller: this.controller }).height("90%")
.horizontalScrollBarAccess(this.isShow)
}
}
}
加载的html文件。
<!--index.html-->
<!DOCTYPE html>
<html>
<head>
<meta name="viewport" id="viewport" content="width=device-width,initial-scale=1.0">
<title>Demo</title>
<style>
body {
width:3000px;
height:6000px;
padding-right:170px;
padding-left:170px;
border:5px solid blueviolet;
}
</style>
</head>
<body>
Scroll Test
</body>
</html>
verticalScrollBarAccess9+
verticalScrollBarAccess(verticalScrollBar: boolean)
设置是否显示纵向滚动条,包括系统默认滚动条和用户自定义滚动条。该属性没有显式调用时,默认显示纵向滚动条。
说明:
- 通过@State变量控制纵向滚动条的隐藏/显示后,需要调用controller.refresh()生效。
- 通过@State变量频繁动态改变时,建议切换开关变量和Web组件一一对应。
系统能力: SystemCapability.Web.Webview.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| verticalScrollBar | boolean | 是 | 设置是否显示纵向滚动条。 true表示设置显示纵向滚动条,false表示设置不显示纵向滚动条。 传入undefined或null时为false。 |
示例:
// xxx.ets
import { webview } from '@kit.ArkWeb';
import { BusinessError } from '@kit.BasicServicesKit';
@Entry
@Component
struct WebComponent {
controller: webview.WebviewController = new webview.WebviewController();
@State isShow: boolean = true;
@State btnMsg: string ="隐藏滚动条";
build() {
Column() {
// 通过@State变量改变纵向滚动条的隐藏/显示后,需调用this.controller.refresh()后生效
Button(this.btnMsg)
.onClick(() => {
if(this.isShow){
this.isShow = false;
this.btnMsg="显示滚动条";
}else{
this.isShow = true;
this.btnMsg="隐藏滚动条";
}
try {
this.controller.refresh();
} catch (error) {
console.error(`ErrorCode: ${(error as BusinessError).code}, Message: ${(error as BusinessError).message}`);
}
}).height("10%").width("40%")
Web({ src: $rawfile('index.html'), controller: this.controller }).height("90%")
.verticalScrollBarAccess(this.isShow)
}
}
}
加载的html文件。
<!--index.html-->
<!DOCTYPE html>
<html>
<head>
<meta name="viewport" id="viewport" content="width=device-width,initial-scale=1.0">
<title>Demo</title>
<style>
body {
width:3000px;
height:6000px;
padding-right:170px;
padding-left:170px;
border:5px solid blueviolet;
}
</style>
</head>
<body>
Scroll Test
</body>
</html>
cacheMode
cacheMode(cacheMode: CacheMode)
设置缓存模式。当属性没有显式调用时,默认为CacheMode.Default。
系统能力: SystemCapability.Web.Webview.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| cacheMode | CacheMode | 是 | 要设置的缓存模式。 传入undefined或null时为CacheMode.Default。 |
示例:
// xxx.ets
import { webview } from '@kit.ArkWeb';
@Entry
@Component
struct WebComponent {
controller: webview.WebviewController = new webview.WebviewController();
@State mode: CacheMode = CacheMode.None;
build() {
Column() {
Web({ src: 'www.example.com', controller: this.controller })
.cacheMode(this.mode)
}
}
}
copyOptions11+
copyOptions(value: CopyOptions)
设置剪贴板复制范围选项。该属性没有显式调用时,默认支持复制后在当前设备内所有应用内粘贴。
系统能力: SystemCapability.Web.Webview.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| value | CopyOptions | 是 | 要设置的剪贴板复制范围选项。 传入undefined或null时为CopyOptions.None。 |
示例:
// xxx.ets
import { webview } from '@kit.ArkWeb';
@Entry
@Component
struct WebComponent {
controller: webview.WebviewController = new webview.WebviewController();
build() {
Column() {
Web({ src: 'www.example.com', controller: this.controller })
.copyOptions(CopyOptions.None)
}
}
}
textZoomRatio9+
textZoomRatio(textZoomRatio: number)
设置页面的文本缩放百分比。当属性没有显式调用时,默认缩放百分比为100%。
系统能力: SystemCapability.Web.Webview.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| textZoomRatio | number | 是 | 要设置的页面的文本缩放百分比。 取值为整数,范围为(0, 2147483647]。 |
示例:
// xxx.ets
import { webview } from '@kit.ArkWeb';
@Entry
@Component
struct WebComponent {
controller: webview.WebviewController = new webview.WebviewController();
@State ratio: number = 150;
build() {
Column() {
Web({ src: 'www.example.com', controller: this.controller })
.textZoomRatio(this.ratio)
}
}
}
initialScale9+
initialScale(percent: number)
设置整体页面的缩放百分比。该属性没有显式调用时,默认缩放百分比为100。
系统能力: SystemCapability.Web.Webview.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| percent | number | 是 | 要设置的整体页面的缩放百分比。 取值范围:(0, 1000]。 传入undefined或null时属性设置不生效。 |
示例:
// xxx.ets
import { webview } from '@kit.ArkWeb';
@Entry
@Component
struct WebComponent {
controller: webview.WebviewController = new webview.WebviewController();
@State percent: number = 100;
build() {
Column() {
Web({ src: 'www.example.com', controller: this.controller })
.initialScale(this.percent)
}
}
}
blockNetwork9+
blockNetwork(block: boolean)
设置Web组件是否阻止从网络加载资源。当属性没有显式调用时,默认允许从网络加载资源。
系统能力: SystemCapability.Web.Webview.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| block | boolean | 是 | 设置Web组件是否允许从网络加载资源。 true表示不允许从网络加载资源,false表示允许从网络加载资源。 传入undefined或null时为false。 |
示例:
// xxx.ets
import { webview } from '@kit.ArkWeb';
@Entry
@Component
struct WebComponent {
controller: webview.WebviewController = new webview.WebviewController();
@State block: boolean = true;
build() {
Column() {
Web({ src: 'www.example.com', controller: this.controller })
.blockNetwork(this.block)
}
}
}
defaultFixedFontSize9+
defaultFixedFontSize(size: number)
设置网页的默认等宽字体大小。对于html前端使用monospace字体且未指定font-size样式的元素,将按此值渲染字体大小。
当属性没有显式调用时,默认等宽字体大小为13。
系统能力: SystemCapability.Web.Webview.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| size | number | 是 | 设置网页的默认等宽字体大小,单位px。 输入值的范围为[-2^31, 2^31-1],实际渲染时超过72px的值按照72px进行渲染,低于1px的值按照1px进行渲染。 传入null或undefined时为13。 |
示例:
// xxx.ets
import { webview } from '@kit.ArkWeb';
@Entry
@Component
struct WebComponent {
controller: webview.WebviewController = new webview.WebviewController();
@State fontSize: number = 16;
build() {
Column() {
Web({ src: 'www.example.com', controller: this.controller })
.defaultFixedFontSize(this.fontSize)
}
}
}
defaultFontSize9+
defaultFontSize(size: number)
设置网页的默认字体大小。对于html前端使用非monospace字体且未指定font-size样式的元素,将按此值渲染字体大小。
当属性没有显式调用时,网页的默认字体大小为16。
系统能力: SystemCapability.Web.Webview.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| size | number | 是 | 设置网页的默认字体大小,单位px。 输入值的范围为[-2^31, 2^31-1],实际渲染时超过72px的值按照72px进行渲染,低于1px的值按照1px进行渲染。 传入null或undefined时为16。 |
示例:
// xxx.ets
import { webview } from '@kit.ArkWeb';
@Entry
@Component
struct WebComponent {
controller: webview.WebviewController = new webview.WebviewController();
@State fontSize: number = 13;
build() {
Column() {
Web({ src: 'www.example.com', controller: this.controller })
.defaultFontSize(this.fontSize)
}
}
}
minFontSize9+
minFontSize(size: number)
设置网页字体大小最小值。对于html前端元素,若元素字体大小低于该接口设置值,将采用接口设置值渲染字体大小。
当属性没有显式调用时,默认网页字体大小最小值为8。
系统能力: SystemCapability.Web.Webview.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| size | number | 是 | 设置网页字体大小最小值,单位px。 输入值的范围为[-2^31, 2^31-1],实际渲染时超过72px的值按照72px进行渲染,低于1px的值按照1px进行渲染。 传入null或undefined时为8。 |
示例:
// xxx.ets
import { webview } from '@kit.ArkWeb';
@Entry
@Component
struct WebComponent {
controller: webview.WebviewController = new webview.WebviewController();
@State fontSize: number = 13;
build() {
Column() {
Web({ src: 'www.example.com', controller: this.controller })
.minFontSize(this.fontSize)
}
}
}
minLogicalFontSize9+
minLogicalFontSize(size: number)
设置网页逻辑字体大小最小值。
对于html前端未指定font-size样式的元素:
- 若元素字体大小低于该接口设置值,将采用接口设置值渲染字体大小。
- 若minLogicalFontSize和minFontSize同时设置时,对于未指定font-size样式元素,将采用两者中的较大值。
当属性没有显式调用时,默认网页逻辑字体大小最小值为8。
系统能力: SystemCapability.Web.Webview.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| size | number | 是 | 设置网页逻辑字体大小最小值,单位px。 输入值的范围为[-2^31, 2^31-1],实际渲染时超过72px的值按照72px进行渲染,低于1px的值按照1px进行渲染。 传入null或undefined时为18。 |
示例:
// xxx.ets
import { webview } from '@kit.ArkWeb';
@Entry
@Component
struct WebComponent {
controller: webview.WebviewController = new webview.WebviewController();
@State fontSize: number = 13;
build() {
Column() {
Web({ src: 'www.example.com', controller: this.controller })
.minLogicalFontSize(this.fontSize)
}
}
}
webFixedFont9+
webFixedFont(family: string)
设置网页的fixed font字体库,用于渲染html前端使用monospace字体的元素。
当属性没有显式调用时,默认网页的fixed font字体库为monospace。
系统能力: SystemCapability.Web.Webview.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| family | string | 是 | 设置网页的fixed font字体库。 传入null或undefined时为monospace。 |
示例:
// xxx.ets
import { webview } from '@kit.ArkWeb';
@Entry
@Component
struct WebComponent {
controller: webview.WebviewController = new webview.WebviewController();
@State family: string = "monospace";
build() {
Column() {
Web({ src: 'www.example.com', controller: this.controller })
.webFixedFont(this.family)
}
}
}
webSansSerifFont9+
webSansSerifFont(family: string)
设置网页的sans-serif font字体库,用于渲染html前端使用sans-serif字体的元素。
当属性没有显式调用时,默认网页的sans-serif font字体库为sans-serif。
系统能力: SystemCapability.Web.Webview.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| family | string | 是 | 设置网页的sans-serif font字体库。 传入null或undefined时为sans-serif。 |
示例:
// xxx.ets
import { webview } from '@kit.ArkWeb';
@Entry
@Component
struct WebComponent {
controller: webview.WebviewController = new webview.WebviewController();
@State family: string = "sans-serif";
build() {
Column() {
Web({ src: 'www.example.com', controller: this.controller })
.webSansSerifFont(this.family)
}
}
}
webSerifFont9+
webSerifFont(family: string)
设置网页的serif font字体库,用于渲染html前端使用serif字体的元素。
当属性没有显式调用时,默认网页的serif font字体库为serif。
系统能力: SystemCapability.Web.Webview.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| family | string | 是 | 设置网页的serif font字体库。 传入null或undefined时为serif。 |
示例:
// xxx.ets
import { webview } from '@kit.ArkWeb';
@Entry
@Component
struct WebComponent {
controller: webview.WebviewController = new webview.WebviewController();
@State family: string = "serif";
build() {
Column() {
Web({ src: 'www.example.com', controller: this.controller })
.webSerifFont(this.family)
}
}
}
webStandardFont9+
webStandardFont(family: string)
设置网页的standard font字体库,用于渲染html前端未指定字体样式的元素。
当属性没有显式调用时,默认网页的standard font字体库为sans-serif。
系统能力: SystemCapability.Web.Webview.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| family | string | 是 | 设置网页的standard font字体库。 传入null或undefined时为sans-serif。 |
示例:
// xxx.ets
import { webview } from '@kit.ArkWeb';
@Entry
@Component
struct WebComponent {
controller: webview.WebviewController = new webview.WebviewController();
@State family: string = "sans-serif";
build() {
Column() {
Web({ src: 'www.example.com', controller: this.controller })
.webStandardFont(this.family)
}
}
}
webFantasyFont9+
webFantasyFont(family: string)
设置网页的fantasy font字体库,用于渲染html前端使用fantasy字体的元素。
当属性没有显式调用时,默认网页的fantasy font字体库为fantasy。
系统能力: SystemCapability.Web.Webview.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| family | string | 是 | 设置网页的fantasy font字体库。 传入null或undefined时为fantasy。 |
示例:
// xxx.ets
import { webview } from '@kit.ArkWeb';
@Entry
@Component
struct WebComponent {
controller: webview.WebviewController = new webview.WebviewController();
@State family: string = "fantasy";
build() {
Column() {
Web({ src: 'www.example.com', controller: this.controller })
.webFantasyFont(this.family)
}
}
}
webCursiveFont9+
webCursiveFont(family: string)
设置网页的cursive font字体库,用于渲染html前端使用cursive字体的元素。
当属性没有显式调用时,默认网页的cursive font字体库为cursive。
系统能力: SystemCapability.Web.Webview.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| family | string | 是 | 设置网页的cursive font字体库。 传入null或undefined时为cursive。 |
示例:
// xxx.ets
import { webview } from '@kit.ArkWeb';
@Entry
@Component
struct WebComponent {
controller: webview.WebviewController = new webview.WebviewController();
@State family: string = "cursive";
build() {
Column() {
Web({ src: 'www.example.com', controller: this.controller })
.webCursiveFont(this.family)
}
}
}
darkMode9+
darkMode(mode: WebDarkMode)
设置Web深色模式。当属性没有显式调用时,默认Web深色模式关闭。
当深色模式开启时,Web将启用媒体查询prefers-color-scheme中网页所定义的深色样式,若网页未定义深色样式,则保持原状。如需开启强制深色模式,建议配合forceDarkAccess使用。深色模式具体用法可参考Web深色模式适配。
系统能力: SystemCapability.Web.Webview.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| mode | WebDarkMode | 是 | 设置Web的深色模式为关闭、开启或跟随系统。 传入null或undefined时为 WebDarkMode.Off。 |
示例:
// xxx.ets
import { webview } from '@kit.ArkWeb';
@Entry
@Component
struct WebComponent {
controller: webview.WebviewController = new webview.WebviewController();
@State mode: WebDarkMode = WebDarkMode.On;
build() {
Column() {
Web({ src: 'www.example.com', controller: this.controller })
.darkMode(this.mode)
}
}
}
forceDarkAccess9+
forceDarkAccess(access: boolean)
设置网页是否开启强制深色模式。该属性仅在darkMode开启深色模式时生效。当属性没有显式调用时,默认网页不开启强制深色模式。
系统能力: SystemCapability.Web.Webview.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| access | boolean | 是 | 设置网页是否开启强制深色模式。 true表示设置网页开启强制深色模式,false表示设置网页不开启强制深色模式。 传入null或undefined时为false。 |
示例:
// xxx.ets
import { webview } from '@kit.ArkWeb';
@Entry
@Component
struct WebComponent {
controller: webview.WebviewController = new webview.WebviewController();
@State mode: WebDarkMode = WebDarkMode.On;
@State access: boolean = true;
build() {
Column() {
Web({ src: 'www.example.com', controller: this.controller })
.darkMode(this.mode)
.forceDarkAccess(this.access)
}
}
}
pinchSmooth9+
pinchSmooth(isEnabled: boolean)
设置网页是否开启捏合流畅模式。该属性没有显式调用时,默认不开启捏合流畅模式。
系统能力: SystemCapability.Web.Webview.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| isEnabled | boolean | 是 | 网页是否开启捏合流畅模式。 true表示设置网页开启捏合流畅模式,false表示设置网页不开启捏合流畅模式。 传入undefined或null时为false。 |
示例:
// xxx.ets
import { webview } from '@kit.ArkWeb';
@Entry
@Component
struct WebComponent {
controller: webview.WebviewController = new webview.WebviewController();
build() {
Column() {
Web({ src: 'www.example.com', controller: this.controller })
.pinchSmooth(true)
}
}
}
allowWindowOpenMethod10+
allowWindowOpenMethod(flag: boolean)
设置网页是否可以通过JavaScript自动打开新窗口。
说明:
- 该属性仅在javaScriptAccess开启时生效。
- 该属性在multiWindowAccess开启时打开新窗口,关闭时打开本地窗口。
- 该属性的默认值与系统属性
persist.web.allowWindowOpenMethod.enabled保持一致,如果未设置系统属性则默认值为false。- 通过
hdc shell param get persist.web.allowWindowOpenMethod.enabled检查是否开启系统属性persist.web.allowWindowOpenMethod.enabled。若属性值为1代表开启系统属性;若属性值为0或不存在,代表未开启系统属性,可通过命令hdc shell param set persist.web.allowWindowOpenMethod.enabled 1开启系统属性。
系统能力: SystemCapability.Web.Webview.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| flag | boolean | 是 | true表示网页可以通过JavaScript自动打开新窗口,该属性为false时,用户行为仍可通过JavaScript自动打开新窗口,但非用户行为不能通过JavaScript自动打开新窗口。 此处的用户行为是指,在用户对Web组件进行点击等操作后,同时在5秒内请求打开新窗口(window.open)的行为。 默认值与系统属性关联,当系统属性 persist.web.allowWindowOpenMethod.enabled为true时,默认值为true,如果未设置系统属性则默认值为false。 |
示例:
// xxx.ets
import { webview } from '@kit.ArkWeb';
// 在同一界面有两个Web组件。在WebComponent新开窗口时,会跳转到NewWebViewComp。
@CustomDialog
struct NewWebViewComp {
controller?: CustomDialogController;
webviewController1: webview.WebviewController = new webview.WebviewController();
build() {
Column() {
Web({ src: "", controller: this.webviewController1 })
.javaScriptAccess(true)
.multiWindowAccess(false)
.onWindowExit(() => {
console.info("NewWebViewComp onWindowExit");
if (this.controller) {
this.controller.close();
}
})
.onActivateContent(() => {
// 该Web需要展示到前台,建议应用在这里进行tab或window切换的动作
console.info("NewWebViewComp onActivateContent")
})
}
}
}
@Entry
@Component
struct WebComponent {
controller: webview.WebviewController = new webview.WebviewController();
dialogController: CustomDialogController | null = null;
build() {
Column() {
Web({ src: $rawfile("index.html"), controller: this.controller })
.javaScriptAccess(true)
// 需要使能multiWindowAccess
.multiWindowAccess(true)
.allowWindowOpenMethod(true)
.onWindowNew((event) => {
if (this.dialogController) {
this.dialogController.close()
}
let popController: webview.WebviewController = new webview.WebviewController();
this.dialogController = new CustomDialogController({
builder: NewWebViewComp({ webviewController1: popController }),
// isModal设置为false,防止新窗口被销毁而无法触发onActivateContent回调
isModal: false
})
this.dialogController.open();
// 将新窗口对应WebviewController返回给Web内核。
// 若不调用event.handler.setWebController接口,会造成render进程阻塞。
// 如果没有创建新窗口,调用event.handler.setWebController接口时设置成null,通知Web没有创建新窗口。
event.handler.setWebController(popController);
})
}
}
}
HTML示例:
<!-- index.html -->
<!DOCTYPE html>
<html>
<body>
<div>
<button type="button" onclick="delayOpenwindow(5000)">delayOpenwindow_5s</button>
</div>
<script>
function openwindowAll(){
open("https://www.example.com","_blank","height=400,width=600,top=100,left=100,scrollbars=no")
}
function delayOpenwindow(t){
setTimeout(openwindowAll, t);
}
</script>
</body>
</html>
mediaOptions10+
mediaOptions(options: WebMediaOptions)
设置Web媒体播放的策略,其中包括:Web中的音频在重新获焦后能够自动续播的有效期、应用内多个Web实例的音频是否独占。当该属性未显式设置时,默认Web中的音频重新获焦后无法自动续播、应用内多个Web实例的音频是独占的。
说明:
- 同一Web实例中的多个音频均视为同一音频。
- 该媒体播放策略将同时管控有声视频。
- 建议为所有Web组件设置相同的audioExclusive值。
- 音视频互相打断在应用内和应用间生效,续播只在应用间生效。
系统能力: SystemCapability.Web.Webview.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| options | WebMediaOptions | 是 | 设置Web的媒体策略。 属性参数更新后需重新播放音频方可生效。 传入undefined或null时为 {resumeInterval: 0, audioExclusive: true} |
示例:
// xxx.ets
import { webview } from '@kit.ArkWeb';
@Entry
@Component
struct WebComponent {
controller: webview.WebviewController = new webview.WebviewController();
@State options: WebMediaOptions = {resumeInterval: 10, audioExclusive: true};
build() {
Column() {
Web({ src: 'www.example.com', controller: this.controller })
.mediaOptions(this.options)
}
}
}
javaScriptOnDocumentStart11+
javaScriptOnDocumentStart(scripts: Array<ScriptItem>)
将JavaScript脚本注入到Web组件中,当指定页面或者文档开始加载时,该脚本将在其来源与scriptRules匹配的任何页面中执行。当属性没有显式调用时,默认不将JavaScript脚本注入到Web组件中。
说明:
网页文档根元素(HTML Element)创建后、但尚未加载任何其他内容之前注入脚本。
该脚本按照字典序执行,非数组本身顺序,若需数组本身顺序,建议使用runJavaScriptOnDocumentStart接口。
不建议与runJavaScriptOnDocumentStart同时使用。
内容相同的脚本多次注入时将被静默去重,不展示,不提醒,使用首次注入时的scriptRules。
系统能力: SystemCapability.Web.Webview.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| scripts | Array<ScriptItem> | 是 | 需要注入的ScriptItem数组。 传入undefined或null时不将JavaScript脚本注入到Web组件中。 |
ets示例:
// xxx.ets
import { webview } from '@kit.ArkWeb';
@Entry
@Component
struct Index {
controller: webview.WebviewController = new webview.WebviewController();
private localStorage: string =
"if (typeof(Storage) !== 'undefined') {" +
" localStorage.setItem('color', 'Red');" +
"}";
@State scripts: Array<ScriptItem> = [
{ script: this.localStorage, scriptRules: ["*"] }
];
build() {
Column({ space: 20 }) {
Web({ src: $rawfile('index.html'), controller: this.controller })
.javaScriptAccess(true)
.domStorageAccess(true)
.backgroundColor(Color.Grey)
.javaScriptOnDocumentStart(this.scripts)
.width('100%')
.height('100%')
}
}
}
HTML示例:
<!-- index.html -->
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
</head>
<body style="font-size: 30px;" onload='bodyOnLoadLocalStorage()'>
Hello world!
<div id="result"></div>
</body>
<script type="text/javascript">
function bodyOnLoadLocalStorage() {
if (typeof(Storage) !== 'undefined') {
document.getElementById('result').innerHTML = localStorage.getItem('color');
} else {
document.getElementById('result').innerHTML = 'Your browser does not support localStorage.';
}
}
</script>
</html>
javaScriptOnDocumentEnd11+
javaScriptOnDocumentEnd(scripts: Array<ScriptItem>)
将JavaScript脚本注入到Web组件中,当指定页面或者文档加载完成时,该脚本将在其来源与scriptRules匹配的任何页面中执行。当属性没有显式调用时,默认不将JavaScript脚本注入到Web组件中。
说明:
该脚本将在页面的任何JavaScript代码之后运行,并且DOM树此时已经加载、渲染完毕。
该脚本按照字典序执行,非数组本身顺序。
不建议与runJavaScriptOnDocumentEnd同时使用。
内容相同的脚本多次注入时将被静默去重,不展示,不提醒,使用首次注入时的scriptRules。
系统能力: SystemCapability.Web.Webview.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| scripts | Array<ScriptItem> | 是 | 需要注入的ScriptItem数组。 传入undefined或null时不将JavaScript脚本注入到Web组件中。 |
示例:
// xxx.ets
import { webview } from '@kit.ArkWeb';
@Entry
@Component
struct Index {
controller: webview.WebviewController = new webview.WebviewController();
private jsStr: string =
"window.document.getElementById(\"result\").innerHTML = 'this is msg from javaScriptOnDocumentEnd'";
@State scripts: Array<ScriptItem> = [
{ script: this.jsStr, scriptRules: ["*"] }
];
build() {
Column({ space: 20 }) {
Web({ src: $rawfile('index.html'), controller: this.controller })
.javaScriptAccess(true)
.domStorageAccess(true)
.backgroundColor(Color.Grey)
.javaScriptOnDocumentEnd(this.scripts)
.width('100%')
.height('100%')
}
}
}
<!--index.html-->
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
</head>
<body style="font-size: 30px;">
Hello world!
<div id="result">test msg</div>
</body>
</html>
runJavaScriptOnDocumentStart15+
runJavaScriptOnDocumentStart(scripts: Array<ScriptItem>)
将JavaScript脚本注入到Web组件中,当指定页面或者文档开始加载时,该脚本将在其来源与scriptRules匹配的任何页面中执行。当属性没有显式调用时,默认不将JavaScript脚本注入到Web组件中。
说明:
网页文档根元素(HTML Element)创建后、但尚未加载任何其他内容之前注入脚本。
该脚本按照数组本身顺序执行。
不建议与javaScriptOnDocumentStart同时使用。
内容相同的脚本多次注入时将被静默去重,不展示,不提醒,使用首次注入时的scriptRules。
系统能力: SystemCapability.Web.Webview.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| scripts | Array<ScriptItem> | 是 | 需要注入的ScriptItem数组。 传入undefined或null时不将JavaScript脚本注入到Web组件中。 |
ets示例:
// xxx.ets
import { webview } from '@kit.ArkWeb';
@Entry
@Component
struct Index {
controller: webview.WebviewController = new webview.WebviewController();
private localStorage: string =
"if (typeof(Storage) !== 'undefined') {" +
" localStorage.setItem('color', 'Red');" +
"}";
private localStorage2: string =
"console.info('runJavaScriptOnDocumentStart urlRegexRules Matching succeeded.')";
@State scripts: Array<ScriptItem> = [
{ script: this.localStorage, scriptRules: ["*"] },
{ script: this.localStorage2, scriptRules: [], urlRegexRules: [{secondLevelDomain: "", rule: ".*index.html"}] }
];
build() {
Column({ space: 20 }) {
Web({ src: $rawfile('index.html'), controller: this.controller })
.javaScriptAccess(true)
.domStorageAccess(true)
.backgroundColor(Color.Grey)
.runJavaScriptOnDocumentStart(this.scripts)
.width('100%')
.height('100%')
}
}
}
HTML示例:
<!-- index.html -->
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
</head>
<body style="font-size: 30px;" onload='bodyOnLoadLocalStorage()'>
Hello world!
<div id="result"></div>
</body>
<script type="text/javascript">
function bodyOnLoadLocalStorage() {
if (typeof(Storage) !== 'undefined') {
document.getElementById('result').innerHTML = localStorage.getItem('color');
} else {
document.getElementById('result').innerHTML = 'Your browser does not support localStorage.';
}
}
</script>
</html>
runJavaScriptOnDocumentEnd15+
runJavaScriptOnDocumentEnd(scripts: Array<ScriptItem>)
将JavaScript脚本注入到Web组件中,当指定页面或者文档加载完成时,该脚本将在其来源与scriptRules匹配的任何页面中执行。当属性没有显式调用时,默认不将JavaScript脚本注入到Web组件中。
说明:
该脚本将在页面的任何JavaScript代码之后运行,并且DOM树此时已经加载、渲染完毕。
该脚本按照数组本身顺序执行。
不建议与javaScriptOnDocumentEnd同时使用。
内容相同的脚本多次注入时将被静默去重,不展示,不提醒,使用首次注入时的scriptRules。
系统能力: SystemCapability.Web.Webview.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| scripts | Array<ScriptItem> | 是 | 需要注入的ScriptItem数组。 传入undefined或null时不将JavaScript脚本注入到Web组件中。 |
示例:
// xxx.ets
import { webview } from '@kit.ArkWeb';
@Entry
@Component
struct Index {
controller: webview.WebviewController = new webview.WebviewController();
private jsStr: string =
"window.document.getElementById(\"result\").innerHTML = 'this is msg from runJavaScriptOnDocumentEnd'";
private jsStr2: string = "console.info('runJavaScriptOnDocumentEnd urlRegexRules Matching succeeded.')";
@State scripts: Array<ScriptItem> = [
{ script: this.jsStr, scriptRules: ["*"] },
{ script: this.jsStr2, scriptRules: [], urlRegexRules: [{secondLevelDomain: "", rule: ".*index.html"}] }
];
build() {
Column({ space: 20 }) {
Web({ src: $rawfile('index.html'), controller: this.controller })
.javaScriptAccess(true)
.domStorageAccess(true)
.backgroundColor(Color.Grey)
.runJavaScriptOnDocumentEnd(this.scripts)
.width('100%')
.height('100%')
}
}
}
<!--index.html-->
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
</head>
<body style="font-size: 30px;">
Hello world!
<div id="result">test msg</div>
</body>
</html>
runJavaScriptOnHeadEnd15+
runJavaScriptOnHeadEnd(scripts: Array<ScriptItem>)
将JavaScript脚本注入到Web组件中,当页面DOM树head标签解析完成时,该脚本将在其来源与scriptRules匹配的任何页面中执行。当属性没有显式调用时,默认不将JavaScript脚本注入到Web组件中。
说明:
该脚本按照数组本身顺序执行。
内容相同的脚本多次注入时将被静默去重,不展示,不提醒,使用首次注入时的scriptRules。
系统能力: SystemCapability.Web.Webview.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| scripts | Array<ScriptItem> | 是 | 需要注入的ScriptItem数组。 传入undefined或null时不将JavaScript脚本注入到Web组件中。 |
示例:
// xxx.ets
import { webview } from '@kit.ArkWeb';
@Entry
@Component
struct Index {
controller: webview.WebviewController = new webview.WebviewController();
private jsStr: string =
"window.document.getElementById(\"result\").innerHTML = 'this is msg from runJavaScriptOnHeadEnd'";
private jsStr2: string = "console.info('runJavaScriptOnHeadEnd urlRegexRules Matching succeeded.')";
@State scripts: Array<ScriptItem> = [
{ script: this.jsStr, scriptRules: ["*"] },
{ script: this.jsStr2, scriptRules: [], urlRegexRules: [{secondLevelDomain: "", rule: ".*index.html"}] }
];
build() {
Column({ space: 20 }) {
Web({ src: $rawfile('index.html'), controller: this.controller })
.javaScriptAccess(true)
.domStorageAccess(true)
.backgroundColor(Color.Grey)
.runJavaScriptOnHeadEnd(this.scripts)
.width('100%')
.height('100%')
}
}
}
<!--index.html-->
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
</head>
<body style="font-size: 30px;">
Hello world!
<div id="result">test msg</div>
</body>
</html>
layoutMode11+
layoutMode(mode: WebLayoutMode)
设置Web布局模式。当属性没有显式调用时,默认Web布局跟随系统模式。常见问题请参考Web组件大小自适应页面内容布局。
说明:
目前只支持两种Web布局模式,分别为Web布局跟随系统(
WebLayoutMode.NONE)和Web组件高度基于前端页面高度的自适应网页布局(WebLayoutMode.FIT_CONTENT)。Web组件高度基于前端页面自适应布局有如下限制:
- 如果Web组件宽或长度超过7680px,请在Web组件创建的时候指定
RenderMode.SYNC_RENDER模式,否则会整个白屏。- Web组件创建后不支持动态切换layoutMode模式。
- Web组件宽高规格:指定
RenderMode.ASYNC_RENDER模式时,分别不超过7680px。- 频繁更改页面宽高会触发Web组件重新布局,影响体验。
- 不支持瀑布流网页(下拉到底部加载更多)。
- 不支持宽度自适应,仅支持高度自适应。
- 由于高度自适应网页高度,您无法通过修改组件高度属性来修改组件高度。
系统能力: SystemCapability.Web.Webview.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| mode | WebLayoutMode | 是 | 设置web布局模式,跟随系统或自适应布局。 传入null或undefined时为 WebLayoutMode.NONE |
示例:
1、指明layoutMode为WebLayoutMode.FIT_CONTENT模式,为避免默认渲染模式下(RenderMode.ASYNC_RENDER)视口高度超过7680px导致页面渲染出错,需要显式指明渲染模式(RenderMode.SYNC_RENDER)。
// xxx.ets
import { webview } from '@kit.ArkWeb';
@Entry
@Component
struct WebComponent {
controller: webview.WebviewController = new webview.WebviewController();
mode: WebLayoutMode = WebLayoutMode.FIT_CONTENT;
build() {
Column() {
Web({ src: 'www.example.com', controller: this.controller, renderMode: RenderMode.SYNC_RENDER })
.layoutMode(this.mode)
}
}
}
2、指明layoutMode为WebLayoutMode.FIT_CONTENT模式,为避免嵌套滚动场景下,Web滚动到边缘时会优先触发过滚动的过界回弹效果影响用户体验,建议指定overScrollMode为OverScrollMode.NEVER。
// xxx.ets
import { webview } from '@kit.ArkWeb';
@Entry
@Component
struct WebComponent {
controller: webview.WebviewController = new webview.WebviewController();
layoutMode: WebLayoutMode = WebLayoutMode.FIT_CONTENT;
@State overScrollMode: OverScrollMode = OverScrollMode.NEVER;
build() {
Column() {
Web({ src: 'www.example.com', controller: this.controller, renderMode: RenderMode.SYNC_RENDER })
.layoutMode(this.layoutMode)
.overScrollMode(this.overScrollMode)
}
}
}
nestedScroll11+
nestedScroll(value: NestedScrollOptions | NestedScrollOptionsExt)
调用以设置嵌套滚动选项。
说明:
系统能力: SystemCapability.Web.Webview.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| value | NestedScrollOptions | NestedScrollOptionsExt14+ | 是 | 可滚动组件滚动时的嵌套滚动选项。 value为NestedScrollOptions(向前、向后两个方向)类型时,scrollForward、scrollBackward默认滚动选项为NestedScrollMode.SELF_FIRST。 value为NestedScrollOptionsExt(上下左右四个方向)类型时,scrollUp、scrollDown、scrollLeft、scrollRight默认滚动选项为NestedScrollMode.SELF_FIRST。 |
示例:
// xxx.ets
import { webview } from '@kit.ArkWeb';
@Entry
@Component
struct WebComponent {
controller: webview.WebviewController = new webview.WebviewController();
build() {
Column() {
Web({ src: 'www.example.com', controller: this.controller })
.nestedScroll({
scrollForward: NestedScrollMode.SELF_FIRST,
scrollBackward: NestedScrollMode.SELF_FIRST,
})
}
}
}
// xxx.ets
import { webview } from '@kit.ArkWeb';
@Entry
@Component
struct WebComponent {
controller: webview.WebviewController = new webview.WebviewController()
build() {
Scroll(){
Column() {
Text("嵌套Web")
.height("25%")
.width("100%")
.fontSize(30)
.backgroundColor(Color.Yellow)
Web({ src: $rawfile('index.html'),
controller: this.controller })
.nestedScroll({
scrollUp: NestedScrollMode.SELF_FIRST,
scrollDown: NestedScrollMode.PARENT_FIRST,
scrollLeft: NestedScrollMode.SELF_FIRST,
scrollRight: NestedScrollMode.SELF_FIRST,
})
}
}
}
}
加载的html文件。
<!-- index.html -->
<!DOCTYPE html>
<html>
<head>
<meta name="viewport" id="viewport" content="width=device-width, initial-scale=1.0">
<style>
.blue {
background-color: lightblue;
}
.green {
background-color: lightgreen;
}
.blue, .green {
font-size:16px;
height:200px;
text-align: center; /* 水平居中 */
line-height: 200px; /* 垂直居中(值等于容器高度) */
}
</style>
</head>
<body>
<div class="blue" >webArea</div>
<div class="green">webArea</div>
<div class="blue">webArea</div>
<div class="green">webArea</div>
<div class="blue">webArea</div>
<div class="green">webArea</div>
<div class="blue">webArea</div>
</body>
</html>
enableScrollDirectionalLock
enableScrollDirectionalLock(value: boolean, type: ScrollDirectionalLockType)
设置Web组件滑动方向锁定。不调用该方法设置时,默认在嵌套滚动场景下支持滑动方向锁定。
系统能力: SystemCapability.Web.Webview.Core
起始版本: 26.0.0
模型约束: 此接口仅可在Stage模型下使用。
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| value | boolean | 是 | 是否支持滑动方向锁定。true 表示滑动方向锁定,滚动视图会根据用户初始滑动的方向来锁定滚动轴,false 表示不锁定。 |
| type | ScrollDirectionalLockType | 是 | 设置Web组件在哪些场景下希望滑动方向锁定。ALL表示所有场景都支持滑动锁定,NESTED_SCROLL表示在嵌套滚动场景下支持滑动锁定。 |
示例:
// xxx.ets
import { webview } from '@kit.ArkWeb';
@Entry
@Component
struct WebComponent {
controller: webview.WebviewController = new webview.WebviewController();
build() {
Column() {
Web({ src: 'www.example.com', controller: this.controller })
.width('100%')
.height('100%')
// 在所有场景下支持滑动方向的锁定
.enableScrollDirectionalLock(true, ScrollDirectionalLockType.ALL)
}
}
}
bypassVsyncCondition20+
bypassVsyncCondition(condition: WebBypassVsyncCondition)
当开发者调用scrollBy接口进行页面滚动时,可以通过bypassVsyncCondition接口设置渲染流程跳过vsync(垂直同步)调度,直接触发绘制。该属性没有显式调用时,默认不跳过vsync调度。
系统能力: SystemCapability.Web.Webview.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| condition | WebBypassVsyncCondition | 是 | 触发渲染流程跳过vsync调度的条件。 传入undefined或null时为NONE。 |
示例:
// xxx.ets
import { webview } from '@kit.ArkWeb';
@Entry
@Component
struct WebComponent {
controller: webview.WebviewController = new webview.WebviewController();
condition: WebBypassVsyncCondition = WebBypassVsyncCondition.SCROLLBY_FROM_ZERO_OFFSET;
build() {
Column() {
Button('scrollBy')
.onClick(() => {
this.controller.scrollBy(0, 5);
})
Web({ src: 'www.example.com', controller: this.controller })
.bypassVsyncCondition(this.condition)
}
}
}
enableNativeEmbedMode11+
enableNativeEmbedMode(enabled: boolean)
设置是否开启同层渲染功能。当该方法没有显式调用时,默认不开启同层渲染功能。
系统能力: SystemCapability.Web.Webview.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| enabled | boolean | 是 | 是否开启同层渲染功能。 true表示开启同层渲染功能,false表示不开启同层渲染功能。 传入undefined或null时为false。 |
示例:
// xxx.ets
import { webview } from '@kit.ArkWeb';
@Entry
@Component
struct WebComponent {
controller: webview.WebviewController = new webview.WebviewController();
build() {
Column() {
Web({ src: 'www.example.com', controller: this.controller })
.enableNativeEmbedMode(true)
}
}
}
forceDisplayScrollBar14+
forceDisplayScrollBar(enabled: boolean)
设置滚动条是否常驻。在常驻状态下,当页面大小超过一页时,滚动条出现且不消失。该属性没有显式调用时,默认设置滚动条不常驻。
全量展开模式下不支持滚动条常驻,即layoutMode为WebLayoutMode.FIT_CONTENT模式时,参数enabled为false。
系统能力: SystemCapability.Web.Webview.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| enabled | boolean | 是 | 滚动条是否常驻。 true表示滚动条常驻,false表示滚动条不常驻。 传入undefined或null时属性设置不生效。 |
示例:
// xxx.ets
import { webview } from '@kit.ArkWeb';
@Entry
@Component
struct WebComponent {
controller: webview.WebviewController = new webview.WebviewController();
build() {
Column() {
Web({ src: $rawfile('index.html'), controller: this.controller })
.forceDisplayScrollBar(true)
}
}
}
加载的html文件。
<!--index.html-->
<!DOCTYPE html>
<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Demo</title>
<style>
body {
width:2560px;
height:2560px;
padding-right:170px;
padding-left:170px;
border:5px solid blueviolet;
}
</style>
</head>
<body>
Scroll Test
</body>
</html>
registerNativeEmbedRule12+
registerNativeEmbedRule(tag: string, type: string)
注册使用同层渲染的HTML标签名和类型。标签名仅支持使用<object>和<embed>。标签类型只能使用ASCII可显示字符。
若指定类型与W3C定义的<object>或<embed>标准类型重合,ArkWeb内核将其识别为非同层标签。
本接口同样受enableNativeEmbedMode接口控制,在未使能同层渲染时本接口无效。在不使用本接口的情况下,ArkWeb内核默认将"native/"前缀类型的<embed>标签识别为同层标签。
具体使用详情请参考同层渲染指南。
系统能力: SystemCapability.Web.Webview.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| tag | string | 是 | 标签名。 |
| type | string | 是 | 标签类型,内核使用前缀匹配此参数。 |
示例:
// xxx.ets
import { webview } from '@kit.ArkWeb';
import { NodeController, BuilderNode, NodeRenderType, FrameNode, UIContext } from '@kit.ArkUI';
declare class Params {
text: string;
width: number;
height: number;
}
declare class NodeControllerParams {
surfaceId: string;
renderType: NodeRenderType;
width: number;
height: number;
}
class MyNodeController extends NodeController {
private rootNode: BuilderNode<[Params]> | undefined | null;
private surfaceId_: string = "";
private renderType_: NodeRenderType = NodeRenderType.RENDER_TYPE_DISPLAY;
private width_: number = 0;
private height_: number = 0;
setRenderOption(params: NodeControllerParams) {
this.surfaceId_ = params.surfaceId;
this.renderType_ = params.renderType;
this.width_ = params.width;
this.height_ = params.height;
}
makeNode(uiContext: UIContext): FrameNode | null {
this.rootNode = new BuilderNode(uiContext, { surfaceId: this.surfaceId_, type: this.renderType_ });
this.rootNode.build(wrapBuilder(ButtonBuilder), { text: "myButton", width: this.width_, height: this.height_ });
return this.rootNode.getFrameNode();
}
postInputEvent(event: TouchEvent | MouseEvent | undefined): boolean {
return this.rootNode?.postInputEvent(event) as boolean;
}
}
@Component
struct ButtonComponent {
@Prop params: Params;
@State bkColor: Color = Color.Red;
build() {
Column() {
Button(this.params.text)
.height(50)
.width(200)
.border({ width: 2, color: Color.Red })
.backgroundColor(this.bkColor)
}
.width(this.params.width)
.height(this.params.height)
}
}
@Builder
function ButtonBuilder(params: Params) {
ButtonComponent({ params: params })
.backgroundColor(Color.Green)
}
@Entry
@Component
struct WebComponent {
controller: webview.WebviewController = new webview.WebviewController();
private nodeController: MyNodeController = new MyNodeController();
uiContext: UIContext = this.getUIContext();
build() {
Column() {
Stack() {
NodeContainer(this.nodeController)
Web({ src: $rawfile('index.html'), controller: this.controller })
// 配置同层渲染开关开启。
.enableNativeEmbedMode(true)
// 注册同层标签为<object>,类型为"native"前缀。
.registerNativeEmbedRule("object", "native")
// 获取<object>标签的生命周期变化数据。
.onNativeEmbedLifecycleChange((object) => {
if (object.status == NativeEmbedStatus.CREATE) {
this.nodeController.setRenderOption({
surfaceId: object.surfaceId as string,
renderType: NodeRenderType.RENDER_TYPE_TEXTURE,
width: this.uiContext!.px2vp(object.info?.width),
height: this.uiContext!.px2vp(object.info?.height)
});
this.nodeController.rebuild();
}
})
}
}
}
}
加载的html文件。
<!--index.html-->
<!DOCTYPE html>
<html>
<head>
<title>同层渲染测试</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
</head>
<body>
<div>
<div id="bodyId">
<object id="nativeButton" type ="native/button" width="300" height="300" style="background-color:red">
</object>
</div>
</div>
</body>
</html>
defaultTextEncodingFormat12+
defaultTextEncodingFormat(textEncodingFormat: string)
设置网页的默认字符编码。当属性没有显式调用时,网页的默认字符编码为"UTF-8"。
系统能力: SystemCapability.Web.Webview.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| textEncodingFormat | string | 是 | 默认字符编码。 传入null或undefined时为"UTF-8"。 |
示例:
// xxx.ets
import { webview } from '@kit.ArkWeb';
@Entry
@Component
struct WebComponent {
controller: webview.WebviewController = new webview.WebviewController();
build() {
Column() {
Web({ src: $rawfile('index.html'), controller: this.controller })
// 设置高
.height(500)
.defaultTextEncodingFormat("UTF-8")
.javaScriptAccess(true)
}
}
}
加载的html文件。
<!--index.html-->
<!DOCTYPE html>
<html>
<head>
<meta name="viewport" content="width=device-width" />
<title>My test html5 page</title>
</head>
<body>
<p>hello world, 你好世界!</p>
</body>
</html>
metaViewport12+
metaViewport(enabled: boolean)
设置meta标签的viewport属性是否可用。当属性没有显式调用时,默认支持meta标签的viewport属性。
说明:
- 当前通过User-Agent中是否含有"Mobile"字段来判断是否开启前端HTML页面中meta标签的viewport属性。当User-Agent中不含有"Mobile"字段时,meta标签中viewport属性默认关闭,此时可通过显性设置metaViewport属性为true来覆盖关闭状态。
系统能力: SystemCapability.Web.Webview.Core
设备行为差异: 该接口在Phone、Wearable、TV设备中可正常调用,在PC/2in1设备中无效果,在Tablet设备中,设置为true或false均会解析meta标签viewport-fit属性。当viewport-fit=cover时,可通过CSS属性获取安全区域大小。
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| enabled | boolean | 是 | 是否支持meta标签的viewport属性。 true表示支持meta标签的viewport属性,将解析viewport属性,并根据viewport属性布局。 false表示不支持meta标签的viewport属性,将不解析viewport属性,进行默认布局。 传入null或undefined时为true。 |
示例:
// xxx.ets
import { webview } from '@kit.ArkWeb';
@Entry
@Component
struct WebComponent {
controller: webview.WebviewController = new webview.WebviewController();
build() {
Column() {
Web({ src: $rawfile('index.html'), controller: this.controller })
.metaViewport(true)
}
}
}
加载的html文件。
<!--index.html-->
<!DOCTYPE html>
<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
</head>
<body>
<p>hello world, 你好世界!</p>
</body>
</html>
textAutosizing12+
textAutosizing(textAutosizing: boolean)
设置Web组件是否开启文本字体大小自动调整。当属性没有显式调用时,Web组件默认开启文本字体大小自动调整。
文本字体大小自动调整生效后,对于字号过小的文本将自动加大字号至16px~32px,避免屏幕较小(默认视口宽度 < 980px)的设备因为缺少移动端适配出现字体过小的可读性问题。
说明:
- 文本字体大小自动调整生效需要满足的前置条件:
- 设备形态为:Phone、Tablet、Wearable、TV。
- Web组件视口宽度 < 980px。
- 页面文本量大,页面文本的字号*字符数 ≥ 3920。
- 前端无metaViewport设置,或metaViewport设置中无"width"和"initial-scale"属性。
系统能力: SystemCapability.Web.Webview.Core
设备行为差异: 该接口在PC/2in1设备中无效果,在其他设备中可正常调用。
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| textAutosizing | boolean | 是 | 文本自动调整大小。 true表示文本自动调整大小,false表示文本不自动调整大小。 传入undefined或null时为true。 |
示例:
// xxx.ets
import { webview } from '@kit.ArkWeb';
@Entry
@Component
struct WebComponent {
controller: webview.WebviewController = new webview.WebviewController();
build() {
Column() {
Web({ src: 'www.example.com', controller: this.controller })
.textAutosizing(false)
}
}
}
enableNativeMediaPlayer12+
enableNativeMediaPlayer(config: NativeMediaPlayerConfig)
开启应用接管网页媒体播放功能。当属性没有显式调用时,默认不开启接管网页媒体播放功能。
系统能力: SystemCapability.Web.Webview.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| config | NativeMediaPlayerConfig | 是 | enable: 是否开启该功能。 shouldOverlay: 该功能开启后, 应用接管网页视频的播放器画面是否覆盖网页内容。 传入undefined或null时为 {enable: false, shouldOverlay: false}。 |
示例:
// xxx.ets
import { webview } from '@kit.ArkWeb';
@Entry
@Component
struct WebComponent {
controller: webview.WebviewController = new webview.WebviewController();
build() {
Column() {
Web({ src: 'www.example.com', controller: this.controller })
.enableNativeMediaPlayer({enable: true, shouldOverlay: false})
}
}
}
onAdsBlocked12+
onAdsBlocked(callback: OnAdsBlockedCallback)
一个页面发生广告过滤后,通过此回调接口通知过滤的详细信息。由于页面可能随时发生变化并不断产生网络请求,为了减少通知频次、降低对页面加载过程的影响,仅在页面加载完成时进行首次通知,此后发生的过滤将间隔1秒钟上报,无广告过滤则无通知。
系统能力: SystemCapability.Web.Webview.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| callback | OnAdsBlockedCallback | 是 | 广告过滤的回调。 |
示例:
// xxx.ets
import { webview } from '@kit.ArkWeb';
@Entry
@Component
struct WebComponent {
@State totalAdsBlockCounts: number = 0;
controller: webview.WebviewController = new webview.WebviewController();
build() {
Column() {
Web({ src: 'https://www.example.com', controller: this.controller })
.onAdsBlocked((details: AdsBlockedDetails) => {
if (details) {
console.info(' Blocked ' + details.adsBlocked.length + ' in ' + details.url);
let adList: Array<string> = Array.from(new Set(details.adsBlocked));
this.totalAdsBlockCounts += adList.length;
console.info('Total blocked counts :' + this.totalAdsBlockCounts);
}
})
}
}
}
keyboardAvoidMode12+
keyboardAvoidMode(mode: WebKeyboardAvoidMode)
Web组件自定义软件键盘避让模式。
当UIContext设置的键盘避让模式为KeyboardAvoidMode.RESIZE模式时,该接口功能不生效。
系统能力: SystemCapability.Web.Webview.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| mode | WebKeyboardAvoidMode | 是 | Web软键盘避让模式。 嵌套滚动场景下不推荐使用web软键盘避让,包括RESIZE_VISUAL与RESIZE_CONTENT。 默认值: WebKeyboardAvoidMode.RESIZE_CONTENT避让行为。 |
示例:
// xxx.ets
import { webview } from '@kit.ArkWeb';
@Entry
@Component
struct WebComponent {
controller: webview.WebviewController = new webview.WebviewController();
@State avoidMode: WebKeyboardAvoidMode = WebKeyboardAvoidMode.RESIZE_VISUAL;
build() {
Column() {
Web({ src: $rawfile("index.html"), controller: this.controller })
.keyboardAvoidMode(this.avoidMode)
}
}
}
加载的html文件。
<!--index.html-->
<!DOCTYPE html>
<html>
<head>
<title>测试网页</title>
</head>
<body>
<input type="text" placeholder="Text">
</body>
</html>
editMenuOptions12+
editMenuOptions(editMenu: EditMenuOptions)
设置Web组件自定义文本选择菜单。
用户可以通过该属性设置自定义的文本菜单。
在onCreateMenu中,可以修改、增加、删除菜单选项,如果希望不显示文本菜单,需要返回空数组。
在onMenuItemClick中,可以自定义菜单选项的回调函数。该函数在菜单选项被点击后触发,并根据返回值决定是否执行系统默认的回调。返回true不执行系统回调,返回false继续执行系统回调。
在onPrepareMenu20+中,当文本选择区域变化后显示菜单之前触发该回调,可在该回调中进行修改、增加、删除菜单选项,实现动态更新菜单。
本接口在与selectionMenuOptions(deprecated)同时使用时,会使selectionMenuOptions(deprecated)不生效。
系统能力: SystemCapability.Web.Webview.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| editMenu | EditMenuOptions | 是 | Web自定义文本菜单选项。 菜单项数量,及菜单的content大小、icon图标尺寸,与ArkUI Menu组件保持一致。 菜单中系统自带的id枚举值(TextMenuItemId)在Web中仅支持CUT、COPY、PASTE、SELECT_ALL、TRANSLATE、SEARCH、AI_WRITER七项。 onMenuItemClick函数中textRange参数在web中无意义,传入值为-1。 |
示例
// xxx.ets
import { webview } from '@kit.ArkWeb';
let selectText:string = '';
class TestClass {
setSelectText(param: String) {
selectText = param.toString();
}
}
@Entry
@Component
struct WebComponent {
controller: webview.WebviewController = new webview.WebviewController();
@State testObj: TestClass = new TestClass();
onCreateMenu(menuItems: Array<TextMenuItem>): Array<TextMenuItem> {
let items = menuItems.filter((menuItem) => {
// 过滤用户需要的系统按键
return (
menuItem.id.equals(TextMenuItemId.CUT) ||
menuItem.id.equals(TextMenuItemId.COPY) ||
menuItem.id.equals((TextMenuItemId.PASTE)) ||
menuItem.id.equals((TextMenuItemId.TRANSLATE)) ||
menuItem.id.equals((TextMenuItemId.SEARCH)) ||
menuItem.id.equals((TextMenuItemId.AI_WRITER))
)
});
let customItem1: TextMenuItem = {
content: 'customItem1',
id: TextMenuItemId.of('customItem1'),
icon: $r('app.media.icon')
};
let customItem2: TextMenuItem = {
content: $r('app.string.customItem2'),
id: TextMenuItemId.of('customItem2'),
icon: $r('app.media.icon')
};
items.push(customItem1);// 在选项列表后添加新选项
items.unshift(customItem2);// 在选项列表前添加选项
return items;
}
onMenuItemClick(menuItem: TextMenuItem, textRange: TextRange): boolean {
if (menuItem.id.equals(TextMenuItemId.CUT)) {
// 用户自定义行为
console.info("拦截 id:CUT")
return true; // 返回true不执行系统回调
} else if (menuItem.id.equals(TextMenuItemId.COPY)) {
// 用户自定义行为
console.info("不拦截 id:COPY")
return false; // 返回false执行系统回调
} else if (menuItem.id.equals(TextMenuItemId.of('customItem1'))) {
// 用户自定义行为
console.info("拦截 id:customItem1")
return true;// 用户自定义菜单选项返回true时点击后不关闭菜单,返回false时关闭菜单
} else if (menuItem.id.equals((TextMenuItemId.of($r('app.string.customItem2'))))){
// 用户自定义行为
console.info("拦截 id:app.string.customItem2")
return true;
}
return false;// 返回默认值false
}
onPrepareMenu = (menuItems: Array<TextMenuItem>) => {
let item1: TextMenuItem = {
content: 'prepare1',
id: TextMenuItemId.of('prepareMenu1'),
};
let item2: TextMenuItem = {
content: 'prepare2' + selectText,
id: TextMenuItemId.of('prepareMenu2'),
};
menuItems.push(item1);// 在选项列表后添加新选项
menuItems.unshift(item2);// 在选项列表前添加选项
return menuItems;
}
@State EditMenuOptions: EditMenuOptions =
{ onCreateMenu: this.onCreateMenu, onMenuItemClick: this.onMenuItemClick, onPrepareMenu:this.onPrepareMenu }
build() {
Column() {
Web({ src: $rawfile("index.html"), controller: this.controller })
.editMenuOptions(this.EditMenuOptions)
.javaScriptProxy({
object: this.testObj,
name: "testObjName",
methodList: ["setSelectText"],
controller: this.controller,
})
}
}
}
加载的html文件。
<!--index.html-->
<!DOCTYPE html>
<html>
<head>
<title>测试网页</title>
</head>
<body>
<h1>editMenuOptions Demo</h1>
<span>edit menu options</span>
<script>
document.addEventListener('selectionchange', () => {
var selection = window.getSelection();
if (selection.rangeCount > 0) {
var selectedText = selection.toString();
testObjName.setSelectText(selectedText);
}
});
</script>
</body>
</html>
enableHapticFeedback13+
enableHapticFeedback(enabled: boolean)
设置Web组件长按文本选择是否开启振动。需配置"ohos.permission.VIBRATE"。该属性没有显式调用时,默认开启振动。
系统能力: SystemCapability.Web.Webview.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| enabled | boolean | 是 | 是否开启振动。 true表示开启振动,false表示不开启振动。 传入undefined或null时属性设置不生效。 |
示例:
// xxx.ets
import { webview } from '@kit.ArkWeb';
@Entry
@Component
struct WebComponent {
controller: webview.WebviewController = new webview.WebviewController();
build() {
Column() {
Web({ src: $rawfile("index.html"), controller: this.controller })
.enableHapticFeedback(true)
}
}
}
加载的html文件。
<!--index.html-->
<!DOCTYPE html>
<html>
<head>
<title>测试网页</title>
</head>
<body>
<h1>enableHapticFeedback Demo</h1>
<span>enable haptic feedback</span>
</body>
</html>
bindSelectionMenu13+
bindSelectionMenu(elementType: WebElementType, content: CustomBuilder, responseType: WebResponseType, options?: SelectionMenuOptionsExt)
设置自定义选择菜单。
系统能力: SystemCapability.Web.Webview.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| elementType | WebElementType | 是 | 菜单的类型。 |
| content | CustomBuilder | 是 | 菜单的内容。 |
| responseType | WebResponseType | 是 | 菜单的响应类型。 |
| options | SelectionMenuOptionsExt | 否 | 菜单的选项。 |
示例:
// xxx.ets
import { webview } from '@kit.ArkWeb';
import { pasteboard } from '@kit.BasicServicesKit';
import { BusinessError } from '@kit.BasicServicesKit';
interface PreviewBuilderParam {
width: number;
height: number;
url:Resource | string | undefined;
}
interface PreviewBuilderParamForImage {
previewImage: Resource | string | undefined;
width: number;
height: number;
}
@Builder function PreviewBuilderGlobalForImage($$: PreviewBuilderParamForImage) {
Column() {
Image($$.previewImage)
.objectFit(ImageFit.Fill)
.autoResize(true)
}.width($$.width).height($$.height)
}
@Entry
@Component
struct SelectionMenuLongPress {
controller: webview.WebviewController = new webview.WebviewController();
previewController: webview.WebviewController = new webview.WebviewController();
@Builder PreviewBuilder($$: PreviewBuilderParam){
Column() {
Stack(){
Text("") // 可选择是否展示url
.padding(5)
.width('100%')
.textAlign(TextAlign.Start)
.backgroundColor(Color.White)
.copyOption(CopyOptions.LocalDevice)
.maxLines(1)
.textOverflow({overflow:TextOverflow.Ellipsis})
Progress({ value: this.progressValue, total: 100, type: ProgressType.Linear }) // 展示进度条
.style({ strokeWidth: 3, enableSmoothEffect: true })
.backgroundColor(Color.White)
.opacity(this.progressVisible?1:0)
.backgroundColor(Color.White)
}.alignContent(Alignment.Bottom)
Web({src:$$.url,controller: new webview.WebviewController()})
.javaScriptAccess(true)
.fileAccess(true)
.onlineImageAccess(true)
.imageAccess(true)
.domStorageAccess(true)
.onPageBegin(()=>{
this.progressValue = 0;
this.progressVisible = true;
})
.onProgressChange((event)=>{
this.progressValue = event.newProgress;
})
.onPageEnd(()=>{
this.progressVisible = false;
})
.hitTestBehavior(HitTestMode.None) // 使预览Web不响应手势
}.width($$.width).height($$.height) // 设置预览宽高
}
private result: WebContextMenuResult | undefined = undefined;
@State previewImage: Resource | string | undefined = undefined;
@State previewWidth: number = 1;
@State previewHeight: number = 1;
@State previewWidthImage: number = 1;
@State previewHeightImage: number = 1;
@State linkURL:string = "";
@State progressValue:number = 0;
@State progressVisible:boolean = true;
uiContext: UIContext = this.getUIContext();
enablePaste = false;
clearSelection() {
try {
this.controller.runJavaScript(
'clearSelection()',
(error, result) => {
if (error) {
console.error(`run clearSelection JavaScript error, ErrorCode: ${(error as BusinessError).code}, Message: ${(error as BusinessError).message}`);
return;
}
if (result) {
console.info(`The clearSelection() return value is: ${result}`);
}
});
} catch (error) {
console.error(`ErrorCode: ${(error as BusinessError).code}, Message: ${(error as BusinessError).message}`);
}
}
@Builder
LinkMenuBuilder() {
Menu() {
MenuItem({ content: '复制链接', })
.onClick(() => {
const pasteboardData = pasteboard.createData(pasteboard.MIMETYPE_TEXT_PLAIN, this.linkURL);
const systemPasteboard = pasteboard.getSystemPasteboard();
systemPasteboard.setData(pasteboardData);
})
MenuItem({content:'打开链接'})
.onClick(()=>{
this.controller.loadUrl(this.linkURL);
})
}
}
@Builder
ImageMenuBuilder() {
Menu() {
MenuItem({ content: '复制图片', })
.onClick(() => {
this.result?.copyImage();
this.result?.closeContextMenu();
})
}
}
@Builder
TextMenuBuilder() {
Menu() {
MenuItem({ content: '复制', })
.onClick(() => {
try {
this.controller.runJavaScript(
'copySelectedText()',
(error, result) => {
if (error) {
console.error(`run copySelectedText JavaScript error, ErrorCode: ${(error as BusinessError).code}, Message: ${(error as BusinessError).message}`);
return;
}
if (result) {
console.info(`The copySelectedText() return value is: ${result}`);
}
});
} catch (error) {
console.error(`ErrorCode: ${(error as BusinessError).code}, Message: ${(error as BusinessError).message}`);
}
this.clearSelection()
}).backgroundColor(Color.Pink)
}
}
build() {
Column() {
Web({ src: $rawfile("index.html"), controller: this.controller })
.javaScriptAccess(true)
.fileAccess(true)
.onlineImageAccess(true)
.imageAccess(true)
.domStorageAccess(true)
.bindSelectionMenu(WebElementType.TEXT, this.TextMenuBuilder, WebResponseType.LONG_PRESS,
{
onAppear: () => {},
onDisappear: () => {},
menuType: MenuType.SELECTION_MENU,
})
.bindSelectionMenu(WebElementType.LINK, this.LinkMenuBuilder, WebResponseType.LONG_PRESS,
{
onAppear: () => {},
onDisappear: () => {
this.result?.closeContextMenu();
},
preview: this.PreviewBuilder({
width: 500,
height: 400,
url:this.linkURL
}),
menuType: MenuType.PREVIEW_MENU
})
.bindSelectionMenu(WebElementType.IMAGE, this.ImageMenuBuilder, WebResponseType.LONG_PRESS,
{
onAppear: () => {},
onDisappear: () => {
this.result?.closeContextMenu();
},
preview: PreviewBuilderGlobalForImage({
previewImage: this.previewImage,
width: this.previewWidthImage,
height: this.previewHeightImage,
}),
menuType: MenuType.PREVIEW_MENU,
})
.zoomAccess(true)
.onContextMenuShow((event) => {
if (event) {
this.result = event.result;
this.previewWidthImage = this.uiContext!.px2vp(event.param.getPreviewWidth());
this.previewHeightImage = this.uiContext!.px2vp(event.param.getPreviewHeight());
if (event.param.getSourceUrl().indexOf("resource://rawfile/") == 0) {
this.previewImage = $rawfile(event.param.getSourceUrl().substring(19));
} else {
this.previewImage = event.param.getSourceUrl();
}
this.linkURL = event.param.getLinkUrl()
return true;
}
return false;
})
}
}
// 侧滑返回
onBackPress(): boolean | void {
if (this.controller.accessStep(-1)) {
this.controller.backward();
return true;
} else {
return false;
}
}
}
加载的html文件。
<!--index.html-->
<!DOCTYPE html>
<html lang="zh-CN">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>长按复制文本</title>
<style>
.container {
background-color: white;
padding: 30px;
margin: 20px 0;
}
.context {
line-height: 1.8;
font-size: 18px;
}
.context span {
border-radius: 8px;
background-color: #f8f9fa;
}
.context a {
color: #3498db;
text-decoration: none;
font-size: 18px;
font-weight: 600;
padding: 12px 24px;
border: 2px solid #3498db;
border-radius: 30px;
display: inline-block;
position: relative;
overflow: hidden;
margin-bottom: 20px;
}
.context img {
max-width: 100%;
height: auto;
display: block;
margin-bottom: 20px;
}
.context:hover img {
transform: scale(1.05);
}
</style>
</head>
<body>
<div class="container">
<div class="context">
<!--img.png为html同目录下图片-->
<img src="img.png">
</div>
<div class="context">
<a href="https://www.example.com">长按链接唤起菜单</a>
</div>
<div class="context">
<span>在这个数字时代,文本复制功能变得日益重要。无论是引用名言、保存重要信息,还是分享有趣的内容,复制文本都是我们日常操作的一部分。</span>
</div>
</div>
<br>
<script>
function copySelectedText() {
const selectedText = window.getSelection().toString();
if (selectedText.length > 0) {
// 使用Clipboard API复制文本
navigator.clipboard.writeText(selectedText)
.then(() => {
showNotification();
})
.catch(err => {
console.error('复制失败:', err);
});
}
}
function clearSelection() {
if (window.getSelection) {
window.getSelection().removeAllRanges();
}
}
</script>
</body>
</html>
blurOnKeyboardHideMode14+
blurOnKeyboardHideMode(mode: BlurOnKeyboardHideMode)
设置当软键盘收起时Web元素失焦模式。
系统能力: SystemCapability.Web.Webview.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| mode | BlurOnKeyboardHideMode | 是 | 设置当软键盘收起时Web元素失焦关闭或开启。默认值:BlurOnKeyboardHideMode.SILENT。 |
示例:
// xxx.ets
import { webview } from '@kit.ArkWeb';
@Entry
@Component
struct WebComponent {
controller: webview.WebviewController = new webview.WebviewController();
@State blurMode: BlurOnKeyboardHideMode = BlurOnKeyboardHideMode.BLUR;
build() {
Column() {
Web({ src: $rawfile("index.html"), controller: this.controller })
.blurOnKeyboardHideMode(this.blurMode)
}
}
}
加载的html文件。
<!--index.html-->
<!DOCTYPE html>
<html>
<head>
<title>测试网页</title>
</head>
<body>
<h1>blurOnKeyboardHideMode Demo</h1>
<input type="text" id="input_a">
<script>
const inputElement = document.getElementById('input_a');
inputElement.addEventListener('blur', function() {
console.info('Input has lost focus');
});
</script>
</body>
</html>
enableFollowSystemFontWeight18+
enableFollowSystemFontWeight(follow: boolean)
设置Web组件是否开启字重跟随系统设置变化。当属性没有显式调用时,Web组件默认开启字重跟随系统设置变化。
说明:
目前该能力只支持前端文本元素跟随变化,暂不支持canvas元素、内嵌docx和pdf格式中的文本跟随变化。
系统能力: SystemCapability.Web.Webview.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| follow | boolean | 是 | 设置Web组件是否开启字重跟随系统设置变化。 true表示字重跟随系统设置中的字体粗细变化,系统设置改变时字重跟随变化。false表示字重不再跟随系统设置中的字体粗细变化,系统设置改变时维持当前字重不变。 传入undefined或null时为true。 |
示例:
// xxx.ets
import { webview } from '@kit.ArkWeb';
@Entry
@Component
struct WebComponent {
controller: webview.WebviewController = new webview.WebviewController();
build() {
Column() {
Web({ src: "www.example.com", controller: this.controller })
.enableFollowSystemFontWeight(true)
}
}
}
optimizeParserBudget15+
optimizeParserBudget(optimizeParserBudget: boolean)
设置是否开启分段解析HTML优化。当属性没有显式调用时,默认使用解析时间作为HTML分段解析的分段点。
ArkWeb内核在解析HTML文档结构时采取分段解析策略,旨在避免过多占用主线程资源,并使网页具有渐进式加载能力。ArkWeb内核默认使用解析时间作为分段点,当单次解析时间超过阈值时,会中断解析,随后进行布局和渲染操作。
开启优化后,ArkWeb内核将不仅检查解析时间是否超出限制,还会额外判断解析的Token(HTML文档的最小解析单位,例如<div>、attr="xxx"等)数量是否超过内核规定的阈值,并下调此阈值。当页面的FCP(First Contentful Paint 首次内容绘制)触发时会恢复成默认的中断判断逻辑。这将使得网页在FCP到来之前的解析操作更频繁,从而提高首帧内容被提前解析完成并进入渲染阶段的可能性,同时有效缩减首帧渲染的工作量,最终实现FCP时间提前。
由于页面的FCP触发时会恢复成默认分段解析逻辑,因此分段解析HTML优化仅对每个Web组件加载的首个页面生效。
系统能力: SystemCapability.Web.Webview.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| optimizeParserBudget | boolean | 是 | 设置开启分段解析HTML优化。 true表示使用解析个数代替解析时间作为HTML分段解析的分段点,并减少每段解析的个数上限。false表示使用解析时间作为HTML分段解析的分段点。 传入undefined或null时为false。 |
示例:
// xxx.ets
import { webview } from '@kit.ArkWeb';
@Entry
@Component
struct WebComponent {
controller: webview.WebviewController = new webview.WebviewController()
build() {
Column() {
Web({ src: 'www.example.com', controller: this.controller })
.optimizeParserBudget(true)
}
}
}
enableWebAVSession18+
enableWebAVSession(enabled: boolean)
设置是否支持应用对接到播控中心。当属性没有显式设置时,默认支持应用对接到播控中心。
系统能力: SystemCapability.Web.Webview.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| enabled | boolean | 是 | 设置是否支持应用对接到播控中心。 true表示支持应用对接到播控中心,false表示不支持应用对接到播控中心。 传入undefined或null时为true。 |
示例:
// xxx.ets
import { webview } from '@kit.ArkWeb';
@Entry
@Component
struct WebComponent {
controller: webview.WebviewController = new webview.WebviewController();
build() {
Column() {
Web({ src: $rawfile('index.html'), controller: this.controller })
.enableWebAVSession(true)
}
}
}
加载的html文件。
<!--index.html-->
<!DOCTYPE html>
<html>
<head>
<title>视频播放页面</title>
</head>
<body>
<h1>视频播放</h1>
<video id="testVideo" controls>
<!--在resources的rawfile目录中放置任意一个mp4媒体文件,并将其命名为example.mp4-->
<source src="example.mp4" type="video/mp4">
</video>
</body>
</html>
nativeEmbedOptions16+
nativeEmbedOptions(options?: EmbedOptions)
设置同层渲染相关配置,该属性仅在enableNativeEmbedMode开启时生效,不支持动态修改。当属性没有显式调用时,默认为{supportDefaultIntrinsicSize: false}。
系统能力: SystemCapability.Web.Webview.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| options | EmbedOptions | 否 | 同层渲染相关配置。 传入undefined或null时为 {supportDefaultIntrinsicSize: false}。 |
示例:
// xxx.ets
import { webview } from '@kit.ArkWeb';
@Entry
@Component
struct WebComponent {
controller: webview.WebviewController = new webview.WebviewController();
options: EmbedOptions = {supportDefaultIntrinsicSize: true};
build() {
Column() {
Web({ src: $rawfile("index.html"), controller: this.controller })
.enableNativeEmbedMode(true)
.nativeEmbedOptions(this.options)
}
}
}
加载的html文件
<!-- index.html -->
<!DOCTYPE html>
<html>
<head>
<title>同层渲染固定大小测试html</title>
</head>
<body>
<div>
<embed id="input" type = "native/view" style = "background-color:red"/>
</div>
</body>
</html>
enableDataDetector20+
enableDataDetector(enable: boolean)
设置是否识别网页文本特殊实体,如邮件、电话、网址等。该接口依赖设备底层具备文本识别能力,否则设置无效。该属性没有显式调用时,默认不启用。
当enableDataDetector设置为true,同时不设置dataDetectorConfig属性时,默认识别所有类型的实体,所识别实体的color和decoration会被更改为如下样式:
color: '#ff0a59f7',
decoration:{
type: TextDecorationType.Underline,
color: '#ff0a59f7',
style: TextDecorationStyle.SOLID
}
当enableDataDetector设置为true且copyOptions设置为CopyOptions.LocalDevice时,AI菜单功能将被激活。此时,在网页中选中文本后,文本选择菜单能够展示对应的AI菜单项,包括TextMenuItemId中的url(打开链接)、email(新建邮件)、phoneNumber(呼叫)、address(导航至该位置)、dateTime(新建日程提醒)。
AI菜单生效时,需在选中范围内,包括一个完整的AI实体,才能展示对应的选项。该菜单项与TextMenuItemId中的askAI菜单项不同时出现。
示例使用场景详见使用Web组件的智能分词能力。
系统能力: SystemCapability.Web.Webview.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| enable | boolean | 是 | 是否启用Web文本识别,true表示启用,false表示不启用。 传入undefined或null时属性设置不生效。 |
说明:
动态更新enableDataDetector的启用状态不会即时影响当前页面,需通过刷新页面来使新配置生效。
示例:
// xxx.ets
import { webview } from '@kit.ArkWeb';
@Entry
@Component
struct WebComponent {
controller: webview.WebviewController = new webview.WebviewController();
build() {
Column() {
Web({ src: $rawfile("index.html"), controller: this.controller })
.enableDataDetector(true)
}
}
}
加载的html文件
<!-- index.html -->
<!DOCTYPE html>
<html>
<head>
<title>enableDataDetector示例</title>
</head>
<body>
<p> 电话:400-123-4567 </p>
<p> 邮箱:example@example.com </p>
</body>
</html>
dataDetectorConfig20+
dataDetectorConfig(config: TextDataDetectorConfig)
设置文本识别配置。
需配合enableDataDetector一起使用,设置enableDataDetector为true时,dataDetectorConfig的配置才能生效。
当两个实体A、B重叠时,按以下规则保留实体:
-
若A ⊂ B,则保留B,反之则保留A。
-
当A ⊄ B且B ⊄ A时,若A.start < B.start,则保留A,反之则保留B。
系统能力: SystemCapability.Web.Webview.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| config | TextDataDetectorConfig | 是 | 文本识别配置。 |
说明:
TextDataDetectorConfig中的onDetectResultUpdate在Web组件中不支持,设置的回调不会调用。
copyOptions设置为CopyOptions.None时,TextDataDetectorConfig中的enablePreviewMenu配置项无效。
动态更新TextDataDetectorConfig的配置不会即时影响当前页面,需通过刷新页面来使新配置生效。
示例:
// xxx.ets
import { webview } from '@kit.ArkWeb';
@Entry
@Component
struct WebComponent {
controller: webview.WebviewController = new webview.WebviewController();
build() {
Column() {
Web({ src: $rawfile("index.html"), controller: this.controller })
.enableDataDetector(true)
.dataDetectorConfig({
types: [
TextDataDetectorType.PHONE_NUMBER,
TextDataDetectorType.EMAIL
],
color: Color.Red,
decoration: {
type: TextDecorationType.LineThrough,
color: Color.Green,
style: TextDecorationStyle.WAVY
}
})
}
}
}
加载的html文件
<!-- index.html -->
<!DOCTYPE html>
<html>
<head>
<title>dataDetectorConfig示例</title>
</head>
<body>
<p> 电话:400-123-4567 </p>
<p> 邮箱:12345678901@example.com </p>
<p> 网址:www.example.com(此项不识别)</p>
</body>
</html>
enableSelectedDataDetector22+
enableSelectedDataDetector(enable: boolean)
设置是否启用文本选择的AI菜单功能,启用后可识别选区中的邮件、电话、网址、日期、地址等,并在文本选择菜单中展示对应的AI菜单项。默认启用AI菜单功能。
AI菜单功能启用时,在网页中选中文本后,文本选择菜单能够展示对应的AI菜单项,包括TextMenuItemId中的url(打开链接)、email(新建邮件)、phoneNumber(呼叫)、address(导航前往)、dateTime(新建日程)。
AI菜单生效时,需在选中范围内,包括一个完整的AI实体,才能展示对应的选项。该菜单项与TextMenuItemId中的askAI菜单项不同时出现。
示例使用场景详见使用Web组件的智能分词能力。
系统能力: SystemCapability.Web.Webview.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| enable | boolean | 是 | 是否启用Web文本识别,true表示启用,false表示不启用。 传入undefined或null时属性重置为默认值。 |
说明:
当enableSelectedDataDetector未配置或设置为true时,将遵循dataDetectorConfig中types的配置;若dataDetectorConfig也未配置,则默认识别所有类型。
当enableSelectedDataDetector设置为false时,不激活实体文本选择AI菜单项。
示例:
// xxx.ets
import { webview } from '@kit.ArkWeb';
@Entry
@Component
struct WebComponent {
controller: webview.WebviewController = new webview.WebviewController();
build() {
Column() {
Web({ src: $rawfile("index.html"), controller: this.controller })
.enableSelectedDataDetector(true)
}
}
}
加载的html文件
<!-- index.html -->
<!DOCTYPE html>
<html>
<head>
<title>enableSelectedDataDetector示例</title>
</head>
<body>
<p> 电话:400-123-4567 </p>
<p> 邮箱:example@example.com </p>
</body>
</html>
gestureFocusMode20+
gestureFocusMode(mode: GestureFocusMode)
设置Web组件手势获焦模式。该属性没有显式调用时,默认表示手势按下时,任何手势均会使Web组件获焦。
系统能力: SystemCapability.Web.Webview.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| mode | GestureFocusMode | 是 | 设置Web组件手势获焦模式。传入undefined或null时为GestureFocusMode.DEFAULT。 |
示例:
// xxx.ets
import { webview } from '@kit.ArkWeb';
@Entry
@Component
struct WebComponent {
controller: webview.WebviewController = new webview.WebviewController();
@State mode: GestureFocusMode = GestureFocusMode.DEFAULT;
build() {
Column() {
Web({ src: $rawfile("index.html"), controller: this.controller })
.gestureFocusMode(this.mode)
}
}
}
加载的html文件。
<!--index.html-->
<!DOCTYPE html>
<html>
<head>
<title>测试网页</title>
</head>
<body>
<input type="text" placeholder="Text">
</body>
</html>
rotateRenderEffect22+
rotateRenderEffect(effect: WebRotateEffect)
设置Web组件旋转时,宽高动画过程中组件内容的填充方式。若未显式调用属性,默认保持动画终态的内容大小,内容始终与组件左上角对齐。
系统能力: SystemCapability.Web.Webview.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| effect | WebRotateEffect | 是 | 设置Web组件旋转时,宽高动画过程中组件内容的填充方式。 |
示例:
// xxx.ets
import { webview } from '@kit.ArkWeb';
@Entry
@Component
struct WebComponent {
controller: webview.WebviewController = new webview.WebviewController();
@State effect: WebRotateEffect = WebRotateEffect.TOPLEFT_EFFECT;
build() {
Column() {
Web({ src: $rawfile("index.html"), controller: this.controller })
.rotateRenderEffect(this.effect)
}
}
}
加载的html文件。
<!--index.html-->
<!DOCTYPE html>
<html>
<head>
<title>测试网页</title>
</head>
<body>
<p>测试网页</p>
</body>
</html>
forceEnableZoom21+
forceEnableZoom(enable: boolean)
设置Web组件是否启用强制缩放功能。
系统能力: SystemCapability.Web.Webview.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| enable | boolean | 是 | 设置是否遵从网页中<meta name="viewport">标签设置的缩放限制。设置为 true时,不遵从网页缩放限制;设置为false时,遵从网页缩放限制。传入 undefined与null时属性设置不生效。 |
示例:
// xxx.ets
import { webview } from '@kit.ArkWeb';
@Entry
@Component
struct WebComponent {
controller: webview.WebviewController = new webview.WebviewController();
build() {
Column() {
Web({ src: $rawfile("index.html"), controller: this.controller })
.forceEnableZoom(true)
}
}
}
加载的html文件。
<!--index.html-->
<!DOCTYPE html>
<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0, user-scalable=no">
<title>测试网页</title>
</head>
<body>
<h1>forceEnableZoom Demo</h1>
<span>You can scale page when forceEnableZoom is true.</span>
</body>
</html>
backToTop22+
backToTop(backToTop: boolean)
设置Web组件是否启用点击状态栏网页回到顶部功能。当属性没有显式调用时,默认开启状态栏网页回到顶部功能。
系统能力: SystemCapability.Web.Webview.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| backToTop | boolean | 是 | 是否启用Web点击状态栏回顶,true表示启用,false表示不启用。 传入undefined或null时为true。 |
示例:
// xxx.ets
import { webview } from '@kit.ArkWeb';
@Entry
@Component
struct WebComponent {
controller: webview.WebviewController = new webview.WebviewController();
build() {
Column() {
Web({ src: $rawfile("index.html"), controller: this.controller })
.backToTop(true)
}
}
}
加载的html文件:
<!-- index.html -->
<!DOCTYPE html>
<html>
<head>
<meta name="viewport" id="viewport" content="width=device-width, initial-scale=1.0">
<style>
.blue {
background-color: lightblue;
}
.green {
background-color: lightgreen;
}
.blue, .green {
font-size:16px;
height:200px;
text-align: center; /* 水平居中 */
line-height: 200px; /* 垂直居中(值等于容器高度) */
}
</style>
</head>
<body>
<div class="blue" >webArea</div>
<div class="green">webArea</div>
<div class="blue">webArea</div>
<div class="green">webArea</div>
<div class="blue">webArea</div>
<div class="green">webArea</div>
<div class="blue">webArea</div>
<div class="green">webArea</div>
<div class="blue">webArea</div>
</body>
</html>
blankScreenDetectionConfig22+
blankScreenDetectionConfig(detectConfig: BlankScreenDetectionConfig)
设置白屏检测的策略配置,如使能开关、检测时间和检测策略等。当属性没有显式调用时,默认关闭白屏检测。
说明:
- 根据detectConfig的配置,在网页加载后检测到白屏或者近似白屏现象,可触发回调onDetectedBlankScreen。
- 设置后下次导航生效。
- 当用户与网页发生交互后,不再会继续检查是否白屏。
- 不支持layoutMode为WebLayoutMode.FIT_CONTENT的场景。
系统能力: SystemCapability.Web.Webview.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| detectConfig | BlankScreenDetectionConfig | 是 | 白屏检测的策略配置。 |
示例:
// blankScreenDetectionConfig.ets
import { webview } from '@kit.ArkWeb';
@Entry
@Component
struct WebComponent {
controller: webview.WebviewController = new webview.WebviewController();
build() {
Column() {
Web({ src: 'www.example.com', controller: this.controller })
.blankScreenDetectionConfig({
enable: true,
detectionTiming: [2, 4, 6, 8],
contentfulNodesCountThreshold: 4,
detectionMethods:[BlankScreenDetectionMethod.DETECTION_CONTENTFUL_NODES_SEVENTEEN]
})
.onDetectedBlankScreen((event: BlankScreenDetectionEventInfo)=>{
console.info(`Found blank screen on ${event.url}.`);
console.info(`The blank screen reason is ${event.blankScreenReason}.`);
console.info(`The blank screen detail is ${event.blankScreenDetails?.detectedContentfulNodesCount}.`);
})
}
}
}
enableImageAnalyzer23+
enableImageAnalyzer(enable: boolean)
设置是否启用网页图片AI分析,当前支持图片文字识别功能。属性未显式调用时,该功能默认开启。
说明:
长按或鼠标悬停在图片文字上时,触发图片AI分析,可以选中图片中的文字。能够触发分析的图片规格如下。
图片的原始长宽均不小于100px。
在设备类型不为2in1的设备上,需要图片渲染宽度超过网页宽度的80%。
系统能力: SystemCapability.Web.Webview.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| enable | boolean | 是 | 是否启用网页图片AI分析,true表示启用,false表示不启用。 传入undefined或null时重置为true。 |
示例:
// xxx.ets
import { webview } from '@kit.ArkWeb';
@Entry
@Component
struct WebComponent {
controller: webview.WebviewController = new webview.WebviewController();
build() {
Column() {
Web({ src: $rawfile("index.html"), controller: this.controller })
.enableImageAnalyzer(true) // 如果需要关闭图片分析能力,需要显式设置为false
}
}
}
加载的html文件:
<!-- index.html -->
<!DOCTYPE html>
<head>
<meta charset="UTF-8">
<meta name="viewport" id="viewport" content="width=device-width, initial-scale=1.0">
<style>
.image-container {
width: 90%;
}
.image-container img {
width: 100%;
height: auto;
}
</style>
</head>
<body>
<div class="image-container">
<!--example.jpg为html同目录下图片-->
<img src="example.jpg" alt="待AI分析的图片">
</div>
</body>
</html>
enableAutoFill23+
enableAutoFill(value: boolean)
设置是否启用网页自动填充,默认开启。
说明:
本接口的自动填充功能,依赖“智能填充服务”和“密码填充服务”的支持。
系统能力: SystemCapability.Web.Webview.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| value | boolean | 是 | 是否启用网页自动填充,true表示启用,false表示不启用。 传入undefined或null时为true。 |
示例:
// xxx.ets
import { webview } from '@kit.ArkWeb';
@Entry
@Component
struct WebComponent {
controller: webview.WebviewController = new webview.WebviewController();
build() {
Column() {
Web({ src: $rawfile("index.html"), controller: this.controller })
.enableAutoFill(true)
}
}
}
加载的html文件:
<!-- index.html -->
<!DOCTYPE html>
<html>
<head>
<meta content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0;" name="viewport"/>
<title>自动填充测试</title>
</head>
<body>
<h4 align="center">自动填充测试</h4>
<form method="post" action="">
<div align="center">
<label for="name" style="width: 120px; display: inline-block; text-align: end;">姓名:</label>
<input type="text" id="name" autocomplete="name"/><br/><br/>
<label for="tel-national" style="width: 120px; display: inline-block; text-align: end;">手机号:</label>
<input type="text" id="tel-national" autocomplete="tel-national"/><br/><br/>
</div>
<div align="center">
<button type="submit" style="width: 80px">提交</button>
</div>
</form>
</body>
</html>
enableDefaultContextMenu24+
enableDefaultContextMenu(enable: boolean)
设置是否启用默认右键上下文菜单。不调用该方法时,默认不启用。默认菜单仅支持CUT、COPY、PASTE、SELECT_ALL菜单项。
说明:
- 当设置了onContextMenuShow回调并在回调中返回true时,本接口的设置不生效。
- 默认菜单项会受editMenuOptions控制,通过该属性可以自定义菜单选项。
模型约束: 此接口仅可在Stage模型下使用。
系统能力: SystemCapability.Web.Webview.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| enable | boolean | 是 | 是否启用默认右键上下文菜单,true表示启用,false表示不启用。 传入undefined或null时为false。 |
示例:
// xxx.ets
import { webview } from '@kit.ArkWeb';
@Entry
@Component
struct WebComponent {
controller: webview.WebviewController = new webview.WebviewController();
build() {
Column() {
Web({ src: 'www.example.com', controller: this.controller })
.enableDefaultContextMenu(true)
}
}
}
enableDrag
enableDrag(value: boolean)
设置是否启用拖拽功能。不调用该属性时,默认启用网页拖拽功能。
起始版本: 26.0.0
模型约束: 此接口仅可在Stage模型下使用。
系统能力: SystemCapability.Web.Webview.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| value | boolean | 是 | 是否启用网页拖拽功能,true表示启用,false表示不启用。 |
| 示例: |
// xxx.ets
import { webview } from '@kit.ArkWeb';
@Entry
@Component
struct Index {
private controller: webview.WebviewController = new webview.WebviewController();
build() {
Column() {
Web({ src: $rawfile('test.html'), controller: this.controller })
.enableDrag(false)
}
}
}
加载的html文件。
<!--test.html-->
<!DOCTYPE html>
<html>
<head><meta charset="UTF-8"><title>拖拽测试</title></head>
<body>
<div id="drag" draggable="true" style="width:100px;height:100px;background:red;margin:20px;"></div>
<div id="drop" style="width:200px;height:200px;background:gray;margin:20px;"></div>
<script>
drag.ondragstart=e=>e.dataTransfer.setData('text/plain','');
drop.ondragover=e=>e.preventDefault();
drop.ondrop=e=>{e.preventDefault(); drop.style.background='green';};
drag.ondragend=()=>{drop.style.background='gray';};
</script>
</body>
</html>
password(deprecated)
password(password: boolean)
设置是否应保存密码。该接口为空接口。
说明:
从API version 8开始支持,从API version 10开始废弃,建议使用enableAutoFill23+替代。
系统能力: SystemCapability.Web.Webview.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| password | boolean | 是 | 设置为true时,表示允许Web保存密码。 设置为false时,表示不允许Web保存密码。 |
textZoomAtio(deprecated)
textZoomAtio(textZoomAtio: number)
设置页面的文本缩放百分比。
说明:
从API version 8开始支持,从API version 9开始废弃,建议使用textZoomRatio9+代替。
系统能力: SystemCapability.Web.Webview.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| textZoomAtio | number | 是 | 要设置的页面的文本缩放百分比。 取值范围为正整数。 默认值:100。 |
示例:
// xxx.ets
@Entry
@Component
struct WebComponent {
controller: WebController = new WebController()
@State ratio: number = 150
build() {
Column() {
Web({ src: 'www.example.com', controller: this.controller })
.textZoomAtio(this.ratio)
}
}
}
userAgent(deprecated)
userAgent(userAgent: string)
设置用户代理。
说明:
从API version 8开始支持,从API version 10开始废弃。建议使用setCustomUserAgent10+替代。
系统能力: SystemCapability.Web.Webview.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| userAgent | string | 是 | 要设置的用户代理。 |
示例:
// xxx.ets
import { webview } from '@kit.ArkWeb';
@Entry
@Component
struct WebComponent {
controller: webview.WebviewController = new webview.WebviewController();
@State userAgent:string = 'Mozilla/5.0 (Phone; OpenHarmony 5.0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/114.0.0.0 Safari/537.36 ArkWeb/4.1.6.1 Mobile DemoApp';
build() {
Column() {
Web({ src: 'www.example.com', controller: this.controller })
.userAgent(this.userAgent)
}
}
}
tableData(deprecated)
tableData(tableData: boolean)
设置是否应保存表单数据。当属性没有显式调用时,默认允许Web保存表单数据。该接口为空接口。
说明:
从API version 8开始支持,从API version 10开始废弃,建议使用enableAutoFill23+替代。
系统能力: SystemCapability.Web.Webview.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| tableData | boolean | 是 | 设置为true时,表示允许Web保存表单数据。 设置为false时,表示不允许Web保存表单数据。 |
wideViewModeAccess(deprecated)
wideViewModeAccess(wideViewModeAccess: boolean)
设置Web是否支持html中meta标签的viewport属性。该接口为空接口。
说明:
从API version 8开始支持,从API version 10开始废弃,建议使用metaViewport12+替代。
系统能力: SystemCapability.Web.Webview.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| wideViewModeAccess | boolean | 是 | 设置Web是否支持html中meta标签的viewport属性。 true表示支持html中meta标签的viewport属性,false表示不支持html中meta标签的viewport属性。 |
selectionMenuOptions(deprecated)
selectionMenuOptions(expandedMenuOptions: Array<ExpandedMenuItemOptions>)
Web组件自定义菜单扩展项接口,允许用户设置扩展项的文本内容、图标、回调方法。
该接口只支持选中纯文本,当选中内容包含图片及其他非文本内容时,action信息中会显示乱码。
说明:
从API version 12开始支持,从API version 20开始废弃。建议使用editMenuOptions12+替代。
系统能力: SystemCapability.Web.Webview.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| expandedMenuOptions | Array<ExpandedMenuItemOptions> | 是 | 扩展菜单选项。 菜单项数量,及菜单的content大小、startIcon图标尺寸,与ArkUI Menu组件保持一致。 |
示例:
// xxx.ets
import { webview } from '@kit.ArkWeb';
@Entry
@Component
struct WebComponent {
controller: webview.WebviewController = new webview.WebviewController();
@State menuOptionArray: Array<ExpandedMenuItemOptions> = [
{content: 'Apple', startIcon: $r('app.media.icon'), action: (selectedText) => {
console.info('select info ' + selectedText.toString());
}},
{content: '香蕉', startIcon: $r('app.media.icon'), action: (selectedText) => {
console.info('select info ' + selectedText.toString());
}}
];
build() {
Column() {
Web({ src: $rawfile("index.html"), controller: this.controller })
.selectionMenuOptions(this.menuOptionArray)
}
}
}
加载的html文件。
<!--index.html-->
<!DOCTYPE html>
<html>
<head>
<title>测试网页</title>
</head>
<body>
<h1>selectionMenuOptions Demo</h1>
<span>selection menu options</span>
</body>
</html>
zoomControlAccess22+
zoomControlAccess(zoomControlAccess: boolean)
设置是否允许通过组合按键(Ctrl+'-/+'或Ctrl+鼠标滚轮/触摸板)进行缩放。
当属性没有显式调用时,默认允许通过组合按键进行缩放。
系统能力: SystemCapability.Web.Webview.Core
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| zoomControlAccess | boolean | 是 | 设置是否允许通过组合按键进行缩放。true表示支持,false表示不支持。传入null或undefined时为false。 |
示例:
// xxx.ets
import { webview } from '@kit.ArkWeb';
@Entry
@Component
struct WebComponent {
controller: webview.WebviewController = new webview.WebviewController();
build() {
Column() {
Web({ src: $rawfile("index.html"), controller: this.controller })
.zoomControlAccess(true)
}
}
}
加载的html文件。
<!--index.html-->
<!DOCTYPE html>
<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>测试网页</title>
</head>
<body>
<h1>zoomControlAccess Demo</h1>
<span>You can zoom in/out page when zoomControlAccess is true.</span>
</body>
</html>
aiSessionOptions
aiSessionOptions(aiSessions: Array<AISessionEvent>)
自定义Web组件的前端AI会话配置,用于注册多个自定义AI会话。
系统能力: SystemCapability.Web.Webview.Core
起始版本: 26.0.0
模型约束: 此接口仅可在Stage模型下使用。
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| aiSessions | Array<AISessionEvent> | 是 | 前端AI会话配置对象数组,每个对象包含AI会话类型及对应的生命周期回调方法。当前仅支持AISessionType中包含的模型。 |
示例:
// xxx.ets
import { webview } from '@kit.ArkWeb';
@Entry
@Component
struct DemoPage {
private webController: webview.WebviewController = new webview.WebviewController();
sessions: Map<string, string> = new Map<string, string>();
onCreateAISession = (id: string, params: string, result: OnAISessionCallback): boolean => {
this.sessions.set(id, params); // 模拟创建AI会话
console.info(`[AISession]onCreateAISession params: ${params}`);
result(AISessionResultType.SUCCESS, "AISession created");
return true;
}
onExecuteAIAction = (id: string, params: string, result: OnAISessionCallback): void => {
this.sessions.get(id); // 模拟取出会话,并执行动作
console.info(`[AISession]onExecuteAIAction params: ${params}`);
result(AISessionResultType.RUNNING, "AISession chunk 1\n");
result(AISessionResultType.RUNNING, "AISession chunk 2\n");
result(AISessionResultType.SUCCESS, "AISession chunk end\n");
}
onDestroyAISession = (id: string): void => {
this.sessions.delete(id); // 模拟销毁会话并释放资源
}
@State options: AISessionEvent = {
aiSessionType: AISessionType.SUMMARIZER,
onCreateAISession: this.onCreateAISession,
onExecuteAIAction: this.onExecuteAIAction,
onDestroyAISession: this.onDestroyAISession
}
build() {
Column() {
Web({ src: $rawfile('index.html'), controller: this.webController })
.aiSessionOptions([this.options])
}
.width('100%')
.height('100%')
}
}
加载的html文件
<!DOCTYPE html>
<html lang="zh-CN">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width,initial-scale=1.0">
<title>Summarizer API Test</title>
</head>
<body style="max-width:600px;margin:20px auto;padding:0 16px;">
<p id="status">checking...</p>
<button id="initBtn" onclick="init()">Create Session</button>
<br><br>
<textarea id="input" rows="6" style="width:100%;font:inherit" placeholder="paste text to summarize"></textarea>
<br><br>
<button id="btn" onclick="run()" disabled>Summarize</button>
<pre id="result"></pre>
<script>
let s;
(async () => {
const d = document.getElementById('status');
if (!('Summarizer' in self)) { d.textContent = 'API not supported'; return; }
const a = await Summarizer.availability();
d.textContent = 'Summarizer: ' + a;
if (a === 'unavailable') document.getElementById('initBtn').disabled = true;
})();
async function init() {
const d = document.getElementById('status'), ib = document.getElementById('initBtn');
ib.disabled = true;
d.textContent = 'creating...';
try {
s = await Summarizer.create({
type: 'tldr', length: 'medium', format: 'plain-text',
monitor(m) { m.addEventListener('downloadprogress', e => { d.textContent = 'downloading ' + (e.loaded * 100 | 0) + '%' }); }
});
d.textContent = 'ready';
document.getElementById('btn').disabled = false;
} catch (e) { d.textContent = 'Error: ' + e.message; ib.disabled = false; }
}
async function run() {
const t = document.getElementById('input').value.trim();
if (!t || !s) return;
const btn = document.getElementById('btn'), r = document.getElementById('result');
btn.disabled = true;
r.textContent = '...';
try { r.textContent = await s.summarize(t); }
catch (e) { r.textContent = 'Error: ' + e.message; }
btn.disabled = false;
}
</script>
</body>
</html>
scrollbarLayoutPolicy
scrollbarLayoutPolicy(policy: ScrollbarLayoutPolicy)
选择Web组件内垂直滚动条的布局方式。
系统能力: SystemCapability.Web.Webview.Core
模型约束: 此接口仅可在Stage模型下使用。
起始版本: 26.0.0
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| policy | ScrollbarLayoutPolicy | 是 | 设置Web组件内垂直滚动条布局模式,可选择跟随系统语言方向设置或网页css的direction属性设置。入参设置为: CONTENT,表示跟随网页css的direction属性设置。 SYSTEM,滚动条会根据系统语种的左右书写方向进行布局。对于从右向左书写的语言,滚动条将布局在左侧。对于网页内嵌套的多层滚动条均适用。 |
示例:
// xxx.ets
import { webview } from '@kit.ArkWeb';
@Entry
@Component
struct WebComponent {
controller: webview.WebviewController = new webview.WebviewController();
build() {
Column() {
Web({ src: 'www.example.com', controller: this.controller })
.width('100%')
.height('100%')
// 设置为SYSTEM表示跟随系统语言方向布局。设置为CONTENT表示沿用Web样式布局
.scrollbarLayoutPolicy(ScrollbarLayoutPolicy.SYSTEM)
}
}
}
keyboardAppearance
keyboardAppearance(mode: WebKeyboardAppearanceMode)
设置键盘外观。不调用该方法时,默认跟随系统的沉浸式模式。
系统能力: SystemCapability.Web.Webview.Core
模型约束: 此接口仅可在Stage模型下使用。
起始版本: 26.0.0
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| mode | WebKeyboardAppearanceMode | 是 | 键盘外观。传入undefined或null时,跟随系统的沉浸式模式。 |
示例:
// xxx.ets
import { webview } from '@kit.ArkWeb';
@Entry
@Component
struct WebComponent {
controller: webview.WebviewController = new webview.WebviewController();
@State appearanceMode: WebKeyboardAppearanceMode = WebKeyboardAppearanceMode.DARK_IMMERSIVE;
build() {
Column() {
Web({ src: $rawfile("index.html"), controller: this.controller })
.keyboardAppearance(this.appearanceMode)
}
}
}
加载的html文件。
<!--index.html-->
<!DOCTYPE html>
<html>
<head>
<title>测试网页</title>
</head>
<body>
<input type="text" placeholder="Text">
</body>
</html>