logo
积分中心
鸿蒙UI开发——键盘弹出避让模式设置
头像 蓝亭书序 2026-11-18 14:07:52    发布
0 浏览 0 收藏

1、概 述

我们在鸿蒙开发时,不免会遇到用户输入场景,当用户准备输入时,会涉及到输入法的弹出,我们的界面针对输入法的弹出有两种避让模式:上抬模式、压缩模式。

下面针对输入法的两种避让模式的设置做简单介绍。

2、设置避让模式

设置虚拟键盘抬起时页面的避让模式,API介绍如下:


setKeyboardAvoidMode(value: KeyboardAvoidMode): void


获取虚拟键盘抬起时的页面避让模式,API介绍如下:


getKeyboardAvoidMode(): KeyboardAvoidMode


其中,KeyboardAvoidMode是一个枚举,默认值为OFFSET上抬模式,定义如下:


OFFSET, // 上抬模式。
RESIZE, // 压缩模式。


KeyboardAvoidMode.RESIZE是压缩Page的大小,Page下设置百分比宽高的组件会跟随Page压缩,直接设置宽高的组件会按设置的固定大小布局。


👉🏻 设置为压缩模式

设置虚拟键盘抬起时压缩页面大小为减去键盘的高度。

下面的示例通过调用setKeyboardAvoidMode设置键盘避让模式为RESIZE模式,实现键盘抬起时page的压缩效果。

我们先在EntryAbility中设置避让模式(我们也可以在Page中获取到UIContext动态设置),示例代码如下(第10行):


// EntryAbility.ets
import { KeyboardAvoidMode } from '@kit.ArkUI';

onWindowStageCreate(windowStage: window.WindowStage) {
  // Main window is created, set main page for this ability
  hilog.info(0x0000, 'testTag', '%{public}s', 'Ability onWindowStageCreate');

  windowStage.loadContent('pages/Index', (err, data) => {
  
  windowStage.getMainWindowSync().getUIContext().setKeyboardAvoidMode(KeyboardAvoidMode.RESIZE);
    if (err.code) {
      hilog.error(0x0000, 'testTag', 'Failed to load the content. Cause: %{public}s', JSON.stringify(err) ?? '');
      return;
    }
    hilog.info(0x0000, 'testTag', 'Succeeded in loading the content. Data: %{public}s', JSON.stringify(data) ?? '');
  });
}


然后写一个简单的界面,代码如下:


// xxx.ets
@Entry
@Component
struct KeyboardAvoidExample1 {
  build() {
    Column() {
      Row().height("30%").width("100%").backgroundColor(Color.Gray)
      TextArea().width("100%").borderWidth(1)
      Text("I can see the bottom of the page").width("100%").textAlign(TextAlign.Center).backgroundColor(Color.Pink).layoutWeight(1)
    }.width('100%').height("100%")
  }
}


默认情况下(键盘未弹出),效果如下:

图片

键盘弹出后,效果如下(底部的粉色区域被压缩):

图片


👉🏻 设置为上抬模式

下面的示例通过调用setKeyboardAvoidMode设置键盘避让模式为OFFSET模式,实现键盘抬起时page的上抬效果。

当输入光标距离屏幕底部的高度大于键盘高度时,page不会抬起

我们先在EntryAbility中设置避让模式(我们也可以在Page中获取到UIContext动态设置),示例代码如下(第10行):


// EntryAbility.ets
import { KeyboardAvoidMode } from '@kit.ArkUI';

onWindowStageCreate(windowStage: window.WindowStage) {
  // Main window is created, set main page for this ability
  hilog.info(0x0000, 'testTag', '%{public}s', 'Ability onWindowStageCreate');

  windowStage.loadContent('pages/Index', (err, data) => {
 
  windowStage.getMainWindowSync().getUIContext().setKeyboardAvoidMode(KeyboardAvoidMode.OFFSET);
    if (err.code) {
      hilog.error(0x0000, 'testTag', 'Failed to load the content. Cause: %{public}s', JSON.stringify(err) ?? '');
      return;
    }
    hilog.info(0x0000, 'testTag', 'Succeeded in loading the content. Data: %{public}s', JSON.stringify(data) ?? '');
  });
}


然后写一个简单的界面(与Resize的一样),代码如下:


// xxx.ets
@Entry
@Component
struct KeyboardAvoidExample2 {
  build() {
    Column() {
      Row().height("30%").width("100%").backgroundColor(Color.Gray)
      TextArea().width("100%").borderWidth(1)
      Text("I can see the bottom of the page").width("100%").textAlign(TextAlign.Center).backgroundColor(Color.Pink).layoutWeight(1)
    }.width('100%').height("100%")
  }
}


默认情况下(键盘未弹出),效果如下:

图片

键盘弹出后,效果如下(底部粉色区域的文字被键盘遮挡,同时,由于底部粉色区域高于键盘,所以界面不会因为键盘弹出而发生布局变化):

图片



©本站发布的所有内容,包括但不限于文字、图片、音频、视频、图表、标志、标识、广告、商标、商号、域名、软件、程序等,除特别标明外,均来源于网络或用户投稿,版权归原作者或原出处所有。我们致力于保护原作者版权,若涉及版权问题,请及时联系我们进行处理。
分类
HarmonyOS

暂无评论数据

加载中...

发布

地址:北京市朝阳区北三环东路三元桥曙光西里甲1号第三置业A座1508室 电话:13391790444或(010)62178877
版权所有:电脑商情信息服务集团 北京赢邦策略咨询有限责任公司
声明:本媒体部分图片、文章来源于网络,版权归原作者所有,我司致力于保护作者版权,如有侵权,请与我司联系删除

京ICP备:2022009079号-2

京公网安备:11010502051901号

ICP证:京B2-20230255