目录

输入法应用沉浸模式

场景介绍

为了让应用能够提供一致的沉浸式体验，我们提供了前台应用和输入法应用之间的通信机制。通过该机制，输入法应用根据前台应用设置的沉浸模式来决定最终沉浸模式。

框架原理

接入指导

  1. 前台应用设置编辑框沉浸模式keyboardappearance。示例代码如下。

    TextArea({placeholder: '沉浸模式'})
  .keyboardAppearance(KeyboardAppearance.IMMERSIVE)

TextArea({placeholder: '非沉浸模式'})
  .keyboardAppearance(KeyboardAppearance.NONE_IMMERSIVE)

  2. 输入法应用订阅编辑框属性变化事件editorAttributeChanged，通过回调参数EditorAttribute中的immersiveMode字段感知前台应用期望的沉浸模式。示例代码如下。

    // 感知是否设置沉浸模式，如果是沉浸模式选择沉浸模式类型
inputMethodEngine.getKeyboardDelegate().on("editorAttributeChanged", (attr : inputMethodEngine.EditorAttribute) => {
  console.info('recv editorAttributeChanged, immersiveMode: ', attr.immersiveMode);
  if (attr.immersiveMode == inputMethodEngine.ImmersiveMode.DARK_IMMERSIVE) {
    this.panel?.setImmersiveMode(inputMethodEngine.ImmersiveMode.DARK_IMMERSIVE);
    console.info('recv editorAttributeChanged, panel:', this.panel?.getImmersiveMode());
  }
})

  3. 输入法应用设置沉浸模式setimmersivemode。

    • IMMERSIVE表示沉浸模式由输入法应用决定。
    • 输入法应用不能设置IMMERSIVE模式给输入法框架。
    • 如果输入法应用收到前台应用期望的沉浸模式为IMMERSIVE，建议输入法应用根据当前系统所处主题模式，将最终沉浸模式设置为浅色沉浸模式（LIGHT_IMMERSIVE）或深色沉浸模式（DARK_IMMERSIVE）。

    设置沉浸模式，示例代码如下。setImmersiveMode接口需使用createPanel获取到Panel实例后，通过实例调用。

    // 感知是否设置沉浸模式，如果是沉浸模式选择沉浸模式类型
inputMethodEngine.getKeyboardDelegate().on("editorAttributeChanged", (attr : inputMethodEngine.EditorAttribute) => {
  console.info('recv editorAttributeChanged, immersiveMode: ', attr.immersiveMode);
  if (attr.immersiveMode == inputMethodEngine.ImmersiveMode.DARK_IMMERSIVE) {
    this.panel?.setImmersiveMode(inputMethodEngine.ImmersiveMode.DARK_IMMERSIVE);
    console.info('recv editorAttributeChanged, panel:', this.panel?.getImmersiveMode());
  }
})