目录

如何解决Web组件高度无法动态改变的问题

问题现象

在Web组件中,加载了一个包含输入区域的HTML页面,当点击页面中的任何区域,系统输入法弹出之后会通过listenKeyboard监听到输入法键盘高度,并压缩Web组件的高度,让它缩小到屏幕上半部分。

背景知识

问题定位

分析结论

通过排查可以知道,问题代码的处理,并不能使Web组件的高度动态变化。参考背景知识,为了解决这个问题,需要通过突破安全区域的限制来处理。利用安全区域的expandSafeArea属性支持组件不改变布局情况下扩展其绘制区域至安全区外。

修改建议

设置Web的属性expandSafeArea([SafeAreaType.KEYBOARD]),让Web组件不避让软键盘。通过监听软键盘高度变化,在软键盘弹出时设置Web的底部的margin为键盘高度,实现Web组件的高度动态变化。

完整示例如下:

import { webview } from '@kit.ArkWeb';
import { BusinessError } from '@kit.BasicServicesKit';
import { window } from '@kit.ArkUI';


@Entry
@Component
struct WebExpandHeightDemo {
  controller: webview.WebviewController = new webview.WebviewController();
  @State safeExpandHeight: number = 0;


  aboutToAppear(): void {
    try {
      webview.WebviewController.setWebDebuggingAccess(true);
      this.listenKeyboard();
    } catch (error) {
      console.error(`ErrorCode: ${(error as BusinessError).code},  Message: ${(error as BusinessError).message}`);
    }
  }


  // 监听键盘高度
  private listenKeyboard() {
    window.getLastWindow(this.getUIContext().getHostContext()).then(currentWindow => {
      // 监听键盘高度,处理工具条偏移量
      currentWindow.on('keyboardHeightChange', (data) => {
        let keyboardHeight = Math.floor(this.getUIContext().px2vp(data));
        if (keyboardHeight > 0) {
          // 键盘编辑态,偏移量=键盘高度
          this.safeExpandHeight = keyboardHeight;
        } else {
          // 无键盘编辑态,安全区高度
          this.safeExpandHeight = 0;
        }
      });
    });
  }


  build() {
    Stack() {
      Column() {
        Web({ src: $rawfile('index.html'), controller: this.controller })
          .fileAccess(false)
          .geolocationAccess(false)
          .onControllerAttached(() => {
            // 推荐在此loadUrl、设置自定义用户代理、注入JS对象等
            console.info('onControllerAttached execute');
          })
          .margin({ bottom: this.safeExpandHeight })
          .layoutWeight(1)
          .expandSafeArea([SafeAreaType.KEYBOARD]);
      };
    };
  }
}

HTML代码示例:

<!DOCTYPE html>
<html>
<head>
    <meta charset="UTF-8">
    <style>
        body {
            font-size: 24px;
            line-height: 1.5;
        }
        contenteditable {
            display: block;
            width: 100%;
            height: 100vh;
            border: none;
            outline: none;
        }
    </style>
</head>
<body>
<h1>Hello, ArkWeb</h1>
<div contenteditable="true" id="editableContent">
    <script>
        let numbers = '';
        for (let i = 1; i <= 100; i++) {
            numbers += i + '<br>';
        }
        document.getElementById('editableContent').innerHTML = numbers;
    </script>
</div>
</body>
</html>

总结

对于组件在页面显示区域内的变化,可以考虑设置组件绘制内容突破安全区域的限制来处理。其中需要注意的几点是:

  1. 组件设置expandSafeArea属性之后生效的条件为:
    • type为SafeAreaType.KEYBOARD时默认生效,组件不避让键盘。
    • 设置其他type,组件的边界与安全区域重合时组件能够延伸到安全区域下。例如:设备顶部状态栏高度100,那么组件在屏幕中的绝对位置需要为0<=y<=100。
  2. 组件延伸到安全区域下,在安全区域处的事件,如点击事件等可能会被系统拦截,优先给状态栏等系统组件响应。
  3. 滚动类容器内的组件不建议设置expandSafeArea属性,如果设置,需要按照组件嵌套关系,将当前节点到滚动类容器间所有子节点设置expandSafeArea属性,否则expandSafeArea属性在滚动后可能会失效。
  4. 除了组件扩展其安全区域外,和键盘相关比较常见的还有setKeyboardAvoidMode(控制虚拟键盘抬起时页面的避让模式)、getKeyboardAvoidMode(返回虚拟键盘抬起时的页面避让模式)。

更多示例请见官方文档安全区域。