Web

提供具有网页显示能力的Web组件。

说明：

该组件从API Version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。

权限列表

访问在线网页时需添加网络权限：ohos.permission.INTERNET

子组件

无

接口

Web(options: { src: ResourceStr, controller: WebController })

表1 options参数说明

参数：

示例：

// xxx.ets
@Entry
@Component
struct WebComponent {
  controller:WebController = new WebController();
  build() {
    Column() {
      Web({ src:'www.example.com', controller:this.controller })
    }
  }
}

说明：

• 不支持转场动画；
• 不支持多实例；
• 仅支持本地音视频播放。

属性

web组件的网络属性。

domStorageAccess

domStorageAccess(domStorageAccess: boolean)

设置是否开启文档对象模型存储接口（DOM Storage API）权限，默认未开启。

参数：

示例：

// xxx.ets
@Entry
@Component
struct WebComponent {
  controller:WebController = new WebController();
  build() {
    Column() {
      Web({ src:'www.example.com', controller:this.controller })
      .domStorageAccess(true)
    }
  }
}

fileAccess

fileAccess(fileAccess: boolean)

设置是否开启应用中文件系统的访问，默认启用。$rawfile(filepath/filename)中rawfile路径的文件不受该属性影响而限制访问。

参数：

示例：

// xxx.ets
@Entry
@Component
struct WebComponent {
  controller:WebController = new WebController();
  build() {
    Column() {
      Web({ src:'www.example.com', controller:this.controller })
      .fileAccess(true)
    }
  }
}

imageAccess

imageAccess(imageAccess: boolean)

设置是否允许自动加载图片资源，默认允许。

参数：

示例：

// xxx.ets
@Entry
@Component
struct WebComponent {
  controller:WebController = new WebController();
  build() {
    Column() {
      Web({ src:'www.example.com', controller:this.controller })
      .imageAccess(true)
    }
  }
}

javaScriptProxy

javaScriptProxy(javaScriptProxy: { object: object, name: string, methodList: Array<string>, controller: WebController })

注入JavaScript对象到window对象中，并在window对象中调用该对象的方法。所有参数不支持更新。

参数：

示例：

// xxx.ets
@Entry
@Component
struct WebComponent {
  controller:WebController = new WebController();
  testObj = {
    test: (data1, data2, data3) => {
      console.log("data1:" + data1);
      console.log("data2:" + data2);
      console.log("data3:" + data3);
      return "AceString";
    },
    toString: () => {
      console.log('toString' + "interface instead.");
    }
  }
  build() {
    Column() {
      Web({ src:'www.example.com', controller:this.controller })
      .javaScriptAccess(true)
      .javaScriptProxy({
        object: this.testObj,
        name: "objName",
        methodList: ["test", "toString"],
        controller: this.controller,
      })
    }
  }
}

javaScriptAccess

javaScriptAccess(javaScriptAccess: boolean)

设置是否允许执行JavaScript脚本，默认允许执行。

参数：

示例：

// xxx.ets
@Entry
@Component
struct WebComponent {
  controller:WebController = new WebController();
  build() {
    Column() {
      Web({ src:'www.example.com', controller:this.controller })
      .javaScriptAccess(true)
    }
  }
}

mixedMode

mixedMode(mixedMode: MixedMode)

设置是否允许加载超文本传输协议（HTTP）和超文本传输安全协议（HTTPS）混合内容，默认不允许加载HTTP和HTTPS混合内容。

参数：

示例：

// xxx.ets
@Entry
@Component
struct WebComponent {
  controller:WebController = new WebController();
  @State mode:MixedMode = MixedMode.All;
  build() {
    Column() {
      Web({ src:'www.example.com', controller:this.controller })
      .mixedMode(this.mode)
    }
  }
}

onlineImageAccess(onlineImageAccess: boolean)

设置是否允许从网络加载图片资源（通过HTTP和HTTPS访问的资源），默认允许访问。

参数：

示例：

// xxx.ets
@Entry
@Component
struct WebComponent {
  controller:WebController = new WebController();
  build() {
    Column() {
      Web({ src:'www.example.com', controller:this.controller })
      .onlineImageAccess(true)
    }
  }
}

zoomAccess

zoomAccess(zoomAccess: boolean)

设置是否支持手势进行缩放，默认允许执行缩放。

参数：

示例：

// xxx.ets
@Entry
@Component
struct WebComponent {
  controller:WebController = new WebController();
  build() {
    Column() {
      Web({ src:'www.example.com', controller:this.controller })
      .zoomAccess(true)
    }
  }
}

overviewModeAccess

overviewModeAccess(overviewModeAccess: boolean)

设置是否使用概览模式加载网页，默认使用该方式。

参数：

示例：

// xxx.ets
@Entry
@Component
struct WebComponent {
  controller:WebController = new WebController();
  build() {
    Column() {
      Web({ src:'www.example.com', controller:this.controller })
      .overviewModeAccess(true)
    }
  }
}

databaseAccess

databaseAccess(databaseAccess: boolean)

设置是否开启数据库存储API权限，默认不开启。

参数：

示例：

// xxx.ets
@Entry
@Component
struct WebComponent {
  controller:WebController = new WebController();
  build() {
    Column() {
      Web({ src:'www.example.com', controller:this.controller })
      .databaseAccess(true)
    }
  }
}

geolocationAccess

geolocationAccess(geolocationAccess: boolean)

设置是否开启获取地理位置权限，默认开启。

参数：

示例：

// xxx.ets
@Entry
@Component
struct WebComponent {
  controller:WebController = new WebController();
  build() {
    Column() {
      Web({ src:'www.example.com', controller:this.controller })
      .geolocationAccess(true)
    }
  }
}

cacheMode

cacheMode(cacheMode: CacheMode)

设置缓存模式。

参数：

示例：

// xxx.ets
@Entry
@Component
struct WebComponent {
  controller:WebController = new WebController();
  @State mode:CacheMode = CacheMode.None;
  build() {
    Column() {
      Web({ src:'www.example.com', controller:this.controller })
      .cacheMode(this.mode)
    }
  }
}

textZoomAtio

textZoomAtio(textZoomAtio: number)

设置页面的文本缩放百分比，默认为100%。

参数：

示例：

// xxx.ets
@Entry
@Component
struct WebComponent {
  controller:WebController = new WebController();
  @State atio:number = 150;
  build() {
    Column() {
      Web({ src:'www.example.com', controller:this.controller })
      .textZoomAtio(this.atio)
    }
  }
}

userAgent

userAgent(userAgent: string)

设置用户代理。

参数：

示例：

// xxx.ets
@Entry
@Component
struct WebComponent {
  controller:WebController = new WebController();
  @State userAgent:string = 'Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/39.0.2171.71 Safari/537.36';
  build() {
    Column() {
      Web({ src:'www.example.com', controller:this.controller })
      .userAgent(this.userAgent)
    }
  }
}

说明：

通用属性仅支持width、height、padding、margin、border。

事件

不支持通用事件。

onAlert

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

网页触发alert()告警弹窗时触发回调。

参数：

返回值：

示例：

// xxx.ets
@Entry
@Component
struct WebComponent {
  controller:WebController = new WebController();
  build() {
    Column() {
      Web({ src:'www.example.com', controller:this.controller })
        .onAlert((event) => {
          AlertDialog.show({
            title: 'title',
            message: 'text',
            confirm: {
              value: 'onAlert',
              action: () => {
                event.result.handleConfirm()
              }
            },
            cancel: () => {
              event.result.handleCancel()
            }
          })
          return true;
        })
    }
  }
}

onBeforeUnload

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

刷新或关闭场景下，在即将离开当前页面时触发此回调。

参数：

返回值：

示例：

// xxx.ets
@Entry
@Component
struct WebComponent {
  controller: WebController = new WebController();

  build() {
    Column() {
      Web({ src: 'www.example.com', controller: this.controller })
        .onBeforeUnload((event) => {
          console.log("event.url:" + event.url);
          console.log("event.message:" + event.message);
          console.log("event.result:" + event.result);
          return false;
        })
    }
  }
}

onConfirm

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

网页调用confirm()告警时触发此回调。

参数：

返回值：

示例：

// xxx.ets
@Entry
@Component
struct WebComponent {
  controller: WebController = new WebController();

  build() {
    Column() {
      Web({ src: 'www.example.com', controller: this.controller })
        .onConfirm((event) => {
          console.log("event.url:" + event.url);
          console.log("event.message:" + event.message);
          console.log("event.result:" + event.result);
          AlertDialog.show({
            title: 'title',
            message: 'text',
            confirm: {
              value: 'onConfirm',
              action: () => {
                event.result.handleConfirm()
              }
            },
            cancel: () => {
              event.result.handleCancel()
            }
          })
          return true;
        })
    }
  }
}

onConsole

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

通知宿主应用JavaScript console消息。

参数：

返回值：

示例：

// xxx.ets
@Entry
@Component
struct WebComponent {
  controller: WebController = new WebController();

  build() {
    Column() {
      Web({ src: 'www.example.com', controller: this.controller })
        .onConsole((event) => {
          console.log('getMessage:' + event.message.getMessage());
          console.log('getSourceId:' + event.message.getSourceId());
          console.log('getLineNumber:' + event.message.getLineNumber());
          console.log('getMessageLevel:' + event.message.getMessageLevel());
          return false;
        })
    }
  }
}

onDownloadStart

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

参数：

示例：

// xxx.ets
@Entry
@Component
struct WebComponent {
  controller: WebController = new WebController();

  build() {
    Column() {
      Web({ src: 'www.example.com', controller: this.controller })
        .onDownloadStart((event) => {
          console.log('url:' + event.url);
          console.log('userAgent:' + event.userAgent);
          console.log('contentDisposition:' + event.contentDisposition);
          console.log('contentLength:' + event.contentLength);
          console.log('mimetype:' + event.mimetype);
        })
    }
  }
}

onErrorReceive

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

网页加载遇到错误时触发该回调。出于性能考虑，建议此回调中尽量执行简单逻辑。

参数：

示例：

// xxx.ets
@Entry
@Component
struct WebComponent {
  controller: WebController = new WebController();

  build() {
    Column() {
      Web({ src: 'www.example.com', controller: this.controller })
        .onErrorReceive((event) => {
          console.log('getErrorInfo:' + event.error.getErrorInfo());
          console.log('getErrorCode:' + event.error.getErrorCode());
          console.log('url:' + event.request.getRequestUrl());
          console.log('isMainFrame:' + event.request.isMainFrame());
          console.log('isRedirect:' + event.request.isRedirect());
          console.log('isRequestGesture:' + event.request.isRequestGesture());
          console.log('getRequestHeader_headerKey:' + event.request.getRequestHeader().toString());
          let result = event.request.getRequestHeader();
          console.log('The request header result size is ' + result.length);
          for (let i of result) {
            console.log('The request header key is : ' + i.headerKey + ', value is : ' + i.headerValue);
          }
        })
    }
  }
}

onHttpErrorReceive

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

网页加载资源遇到的HTTP错误（响应码>=400)时触发该回调。

参数：

示例：

// xxx.ets
@Entry
@Component
struct WebComponent {
  controller: WebController = new WebController();

  build() {
    Column() {
      Web({ src: 'www.example.com', controller: this.controller })
        .onHttpErrorReceive((event) => {
          console.log('url:' + event.request.getRequestUrl());
          console.log('isMainFrame:' + event.request.isMainFrame());
          console.log('isRedirect:' + event.request.isRedirect());
          console.log('isRequestGesture:' + event.request.isRequestGesture());
          console.log('getResponseData:' + event.response.getResponseData());
          console.log('getResponseEncoding:' + event.response.getResponseEncoding());
          console.log('getResponseMimeType:' + event.response.getResponseMimeType());
          console.log('getResponseCode:' + event.response.getResponseCode());
          console.log('getReasonMessage:' + event.response.getReasonMessage());
          let result = event.request.getRequestHeader();
          console.log('The request header result size is ' + result.length);
          for (let i of result) {
            console.log('The request header key is : ' + i.headerKey + ' , value is : ' + i.headerValue);
          }
          let resph = event.response.getResponseHeader();
          console.log('The response header result size is ' + resph.length);
          for (let i of resph) {
            console.log('The response header key is : ' + i.headerKey + ' , value is : ' + i.headerValue);
          }
        })
    }
  }
}

onPageBegin

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

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

参数：

示例：

// xxx.ets
@Entry
@Component
struct WebComponent {
  controller: WebController = new WebController();

  build() {
    Column() {
      Web({ src: 'www.example.com', controller: this.controller })
        .onPageBegin((event) => {
          console.log('url:' + event.url);
        })
    }
  }
}

onPageEnd

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

网页加载完成时触发该回调，且只在主frame触发。

参数：

示例：

// xxx.ets
@Entry
@Component
struct WebComponent {
  controller: WebController = new WebController();

  build() {
    Column() {
      Web({ src: 'www.example.com', controller: this.controller })
        .onPageEnd((event) => {
          console.log('url:' + event.url);
        })
    }
  }
}

onProgressChange

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

网页加载进度变化时触发该回调。

参数：

示例：

// xxx.ets
@Entry
@Component
struct WebComponent {
  controller: WebController = new WebController();

  build() {
    Column() {
      Web({ src: 'www.example.com', controller: this.controller })
        .onProgressChange((event) => {
          console.log('newProgress:' + event.newProgress)
        })
    }
  }
}

onTitleReceive

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

网页document标题更改时触发该回调。

参数：

示例：

// xxx.ets
@Entry
@Component
struct WebComponent {
  controller: WebController = new WebController();

  build() {
    Column() {
      Web({ src: 'www.example.com', controller: this.controller })
        .onTitleReceive((event) => {
          console.log('title:' + event.title)
        })
    }
  }
}

onRefreshAccessedHistory

onRefreshAccessedHistory(callback: (event?: { url: string, refreshed: boolean }) => void)

加载网页页面完成时触发该回调，用于应用更新其访问的历史链接。

参数：

示例：

// xxx.ets
@Entry
@Component
struct WebComponent {
  controller: WebController = new WebController();

  build() {
    Column() {
      Web({ src: 'www.example.com', controller: this.controller })
        .onRefreshAccessedHistory((event) => {
          console.log('url:' + event.url + ' isReload:' + event.refreshed);
        })
    }
  }
}

onUrlLoadIntercept

onUrlLoadIntercept(callback: (event?: { data:string | WebResourceRequest }) => boolean)

当Web组件加载url之前触发该回调，用于是否阻止此次访问。

参数：

返回值：

示例：

// xxx.ets
@Entry
@Component
struct WebComponent {
  controller: WebController = new WebController();

  build() {
    Column() {
      Web({ src: 'www.example.com', controller: this.controller })
        .onUrlLoadIntercept((event) => {
          console.log('onUrlLoadIntercept ' + event.data.toString())
          return true;
        })
    }
  }
}

ConsoleMessage

Web组件获取控制台信息对象。示例代码参考onConsole事件。

getLineNumber

getLineNumber(): number

获取ConsoleMessage的行数。

返回值：

getMessage

getMessage(): string

获取ConsoleMessage的日志信息。

返回值：

getMessageLevel

getMessageLevel(): MessageLevel

获取ConsoleMessage的信息级别。

返回值：

getSourceId

getSourceId(): string

获取网页源文件路径和名字。

返回值：

JsResult

Web组件返回的弹窗确认或弹窗取消功能对象。示例代码参考onAlert事件。

handleCancel

handleCancel(): void

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

handleConfirm

handleConfirm(): void

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

WebResourceError

web组件资源管理错误信息对象。示例代码参考onErrorReceive事件。

getErrorCode

getErrorCode(): number

获取加载资源的错误码。

返回值：

getErrorInfo

getErrorInfo(): string

获取加载资源的错误信息。

返回值：

WebResourceRequest

web组件获取资源请求对象。示例代码参考onErrorReceive事件。

getRequestHeader

getResponseHeader() : Array<Header>

获取资源请求头信息。

返回值：

getRequestUrl

getRequestUrl(): string

获取资源请求的URL信息。

返回值：

isMainFrame

isMainFrame(): boolean

判断资源请求是否为主frame。

返回值：

isRedirect

isRedirect(): boolean

判断资源请求是否被服务端重定向。

返回值：

isRequestGesture

isRequestGesture(): boolean

获取资源请求是否与手势（如点击）相关联。

返回值：

Header

Web组件返回的请求/响应头对象。

WebResourceResponse

web组件资源响应对象。示例代码参考onHttpErrorReceive事件。

getReasonMessage

getReasonMessage(): string

获取资源响应的状态码描述。

返回值：

getResponseCode

getResponseCode(): number

获取资源响应的状态码。

返回值：

getResponseData

getResponseData(): string

获取资源响应数据。

返回值：

getResponseEncoding

getResponseEncoding(): string

获取资源响应的编码。

返回值：

getResponseHeader

getResponseHeader() : Array<Header>

获取资源响应头。

返回值：

getResponseMimeType

getResponseMimeType(): string

获取资源响应的媒体（MIME）类型。

返回值：

WebController

通过WebController可以控制Web组件各种行为。一个WebController对象只能控制一个Web组件，且必须在Web组件和WebController绑定后，才能调用WebController上的方法。

创建对象

webController: WebController = new WebController()

accessBackward

accessBackward(): boolean

当前页面是否可后退，即当前页面是否有返回历史记录。

返回值：

示例：

// xxx.ets
@Entry
@Component
struct WebComponent {
  controller: WebController = new WebController();

  build() {
    Column() {
      Button('accessBackward')
        .onClick(() => {
          let result = this.controller.accessBackward();
          console.log('result:' + result);
        })
      Web({ src: 'www.example.com', controller: this.controller })
    }
  }
}

accessForward

accessForward(): boolean

当前页面是否可前进，即当前页面是否有前进历史记录。

返回值：

示例：

// xxx.ets
@Entry
@Component
struct WebComponent {
  controller: WebController = new WebController();

  build() {
    Column() {
      Button('accessForward')
        .onClick(() => {
          let result = this.controller.accessForward();
          console.log('result:' + result);
        })
      Web({ src: 'www.example.com', controller: this.controller })
    }
  }
}

accessStep

accessStep(step: number): boolean

当前页面是否可前进或者后退给定的step步。

参数：

返回值：

示例：

// xxx.ets
@Entry
@Component
struct WebComponent {
  controller: WebController = new WebController();
  @State steps: number = 2;

  build() {
    Column() {
      Button('accessStep')
        .onClick(() => {
          let result = this.controller.accessStep(this.steps);
          console.log('result:' + result);
        })
      Web({ src: 'www.example.com', controller: this.controller })
    }
  }
}

backward

backward(): void

按照历史栈，后退一个页面。一般结合accessBackward一起使用。

示例：

// xxx.ets
@Entry
@Component
struct WebComponent {
  controller: WebController = new WebController();

  build() {
    Column() {
      Button('backward')
        .onClick(() => {
          this.controller.backward();
        })
      Web({ src: 'www.example.com', controller: this.controller })
    }
  }
}

forward

forward(): void

按照历史栈，前进一个页面。一般结合accessForward一起使用。

示例：

// xxx.ets
@Entry
@Component
struct WebComponent {
  controller: WebController = new WebController();

  build() {
    Column() {
      Button('forward')
        .onClick(() => {
          this.controller.forward();
        })
      Web({ src: 'www.example.com', controller: this.controller })
    }
  }
}

deleteJavaScriptRegister

deleteJavaScriptRegister(name: string)

删除通过registerJavaScriptProxy注册到window上的指定name的应用侧JavaScript对象。删除后立即生效，无须调用refresh接口。

参数：

示例：

// xxx.ets
@Entry
@Component
struct WebComponent {
  controller: WebController = new WebController();
  @State name: string = 'Object';

  build() {
    Column() {
      Button('deleteJavaScriptRegister')
        .onClick(() => {
          this.controller.deleteJavaScriptRegister(this.name);
        })
      Web({ src: 'www.example.com', controller: this.controller })
    }
  }
}

getHitTest

getHitTest(): HitTestType

获取当前被点击区域的元素类型。

返回值：

示例：

// xxx.ets
@Entry
@Component
struct WebComponent {
  controller: WebController = new WebController();

  build() {
    Column() {
      Button('getHitTest')
        .onClick(() => {
          let hitType = this.controller.getHitTest();
          console.log("hitType: " + hitType);
        })
      Web({ src: 'www.example.com', controller: this.controller })
    }
  }
}

requestFocus

requestFocus()

使当前web页面获取焦点。

示例：

// xxx.ets
@Entry
@Component
struct WebComponent {
  controller: WebController = new WebController();

  build() {
    Column() {
      Button('requestFocus')
        .onClick(() => {
          this.controller.requestFocus();
        })
      Web({ src: 'www.example.com', controller: this.controller })
    }
  }
}

loadData

loadData(options: { data: string, mimeType: string, encoding: string, baseUrl?: string, historyUrl?: string })

baseUrl为空时，通过”data“协议加载指定的一段字符串。

当baseUrl为”data“协议时，编码后的data字符串将被Web组件作为”data"协议加载。

当baseUrl为“http/https"协议时，编码后的data字符串将被Web组件以类似loadUrl的方式以非编码字符串处理。

参数：

示例：

// xxx.ets
@Entry
@Component
struct WebComponent {
  controller: WebController = new WebController();

  build() {
    Column() {
      Button('loadData')
        .onClick(() => {
          this.controller.loadData({
            data: "<html><body bgcolor=\"white\">Source:<pre>source</pre></body></html>",
            mimeType: "text/html",
            encoding: "UTF-8"
          });
        })
      Web({ src: 'www.example.com', controller: this.controller })
    }
  }
}

loadUrl

loadUrl(options: { url: string | Resource, headers?: Array<Header> })

使用指定的http头加载指定的URL。

通过loadUrl注入的对象只在当前document有效，即通过loadUrl导航到新的页面会无效。

而通过registerJavaScriptProxy注入的对象，在loadUrl导航到新的页面也会有效。

参数：

示例：

// xxx.ets
@Entry
@Component
struct WebComponent {
  controller: WebController = new WebController();

  build() {
    Column() {
      Button('loadUrl')
        .onClick(() => {
          this.controller.loadUrl({ url: 'www.example.com' });
        })
      Web({ src: 'www.example.com', controller: this.controller })
    }
  }
}

onActive

onActive(): void

调用此接口通知Web组件进入前台激活状态。

示例：

// xxx.ets
@Entry
@Component
struct WebComponent {
  controller: WebController = new WebController();

  build() {
    Column() {
      Button('onActive')
        .onClick(() => {
          this.controller.onActive();
        })
      Web({ src: 'www.example.com', controller: this.controller })
    }
  }
}

onInactive

onInactive(): void

调用此接口通知Web组件进入未激活状态。

示例：

// xxx.ets
@Entry
@Component
struct WebComponent {
  controller: WebController = new WebController();

  build() {
    Column() {
      Button('onInactive')
        .onClick(() => {
          this.controller.onInactive();
        })
      Web({ src: 'www.example.com', controller: this.controller })
    }
  }
}

refresh

refresh()

调用此接口通知Web组件刷新网页。

示例：

// xxx.ets
@Entry
@Component
struct WebComponent {
  controller: WebController = new WebController();

  build() {
    Column() {
      Button('refresh')
        .onClick(() => {
          this.controller.refresh();
        })
      Web({ src: 'www.example.com', controller: this.controller })
    }
  }
}

registerJavaScriptProxy

registerJavaScriptProxy(options: { object: object, name: string, methodList: Array<string> })

注入JavaScript对象到window对象中，并在window对象中调用该对象的方法。注册后，须调用refresh接口生效。

参数：

示例：

// xxx.ets
@Entry
@Component
struct Index {
  controller: WebController = new WebController()
  testObj = {
    test: (data) => {
      return "ArkUI Web Component";
    },
    toString: () => {
      console.log('Web Component toString');
    }
  }
  build() {
    Column() {
      Row() {
        Button('Register JavaScript To Window').onClick(() => {
          this.controller.registerJavaScriptProxy({
            object: this.testObj,
            name: "objName",
            methodList: ["test", "toString"],
          });
        })
      }
      Web({ src: $rawfile('index.html'), controller: this.controller })
        .javaScriptAccess(true)
    }
  }
}

<!-- index.html -->
<!DOCTYPE html>
<html>
    <meta charset="utf-8">
    <body>
        Hello world!
    </body>
    <script type="text/javascript">
    function htmlTest() {
        str = objName.test("test function");
        console.log('objName.test result:'+ str);
    }
</script>
</html>

runJavaScript

runJavaScript(options: { script: string, callback?: (result: string) => void })

异步执行JavaScript脚本，并通过回调方式返回脚本执行的结果。runJavaScript需要在loadUrl完成后，比如onPageEnd中调用。

参数：

示例：

// xxx.ets
@Entry
@Component
struct WebComponent {
  controller: WebController = new WebController();
  @State webResult: string = ''
  build() {
    Column() {
      Text(this.webResult).fontSize(20)
      Web({ src: $rawfile('index.html'), controller: this.controller })
      .javaScriptAccess(true)
      .onPageEnd(e => {
        this.controller.runJavaScript({
          script: 'test()',
          callback: (result: string)=> {
            this.webResult = result
            console.info(`The test() return value is: ${result}`)
          }});
        console.info('url: ', e.url);
      })
    }
  }
}

<!-- index.html -->
<!DOCTYPE html>
<html>
  <meta charset="utf-8">
  <body>
      Hello world!
  </body>
  <script type="text/javascript">
  function test() {
      console.log('Ark WebComponent');
      return "This value is from index.html"
  }
  </script>
</html>

stop

stop()

停止页面加载。

示例：

// xxx.ets
@Entry
@Component
struct WebComponent {
  controller: WebController = new WebController();

  build() {
    Column() {
      Button('stop')
        .onClick(() => {
          this.controller.stop();
        })
      Web({ src: 'www.example.com', controller: this.controller })
    }
  }
}

zoom

zoom(factor: number): void

调整当前网页的缩放比例。

参数：

示例：

// xxx.ets
@Entry
@Component
struct WebComponent {
  controller: WebController = new WebController();
  @State factor: number = 1;

  build() {
    Column() {
      Button('zoom')
        .onClick(() => {
          this.controller.zoom(this.factor);
        })
      Web({ src: 'www.example.com', controller: this.controller })
    }
  }
}

clearHistory

clearHistory(): void

删除所有前进后退记录。

示例：

// xxx.ets
@Entry
@Component
struct WebComponent {
  controller: WebController = new WebController();

  build() {
    Column() {
      Button('clearHistory')
        .onClick(() => {
          this.controller.clearHistory();
        })
      Web({ src: 'www.example.com', controller: this.controller })
    }
  }
}

MessageLevel枚举说明

MixedMode枚举说明

CacheMode枚举说明

HitTestType枚举说明