h5手機鍵盤彈出收起的處理

本文首發於 hzzly的博客

原文連接：h5手機鍵盤彈出收起的處理

前言：前端時間也是應項目的需求開始了h5移動端的折騰之旅，在目前中臺的基礎上擴展了兩個ToC移動端項目，下面就是在h5移動端表單頁面鍵盤彈出收起兼容性的一些總結。

問題

在 h5 項目中，咱們會常常遇到一些表單頁面，在輸入框獲取焦點時，會自動觸發鍵盤彈起，而鍵盤彈出在 IOS 與 Android 的 webview 中表現並不是一致，同時當咱們主動觸發鍵盤收起時也一樣存在差別化。

鍵盤彈出

• IOS：IOS系統 的鍵盤處在窗口的最上層，當鍵盤彈起時，webview 的高度 height 並無改變，只是 scrollTop 發生變化，頁面能夠滾動。且頁面能夠滾動的最大限度爲彈出的鍵盤的高度，而只有鍵盤彈出時頁面剛好也滾動到最底部時，scrollTop 的變化值爲鍵盤的高度，其餘狀況下則沒法獲取。這就致使在 IOS 狀況下難以獲取鍵盤的真實高度。
• Android: 在Android系統中，鍵盤也是處在窗口的最上層，鍵盤彈起時，若是輸入框在靠近底部的話，就會被鍵盤擋住，只有你輸入的時候輸入框纔會滾動到可視化區域。

鍵盤收起

• IOS：觸發鍵盤上的按鈕收起鍵盤或者輸入框之外的頁面區域時，輸入框會失去焦點，所以會觸發輸入框的 blur 事件；當鍵盤收起時，頁面底部會出現一個空白區域，頁面會被頂起。
• Android: 觸發鍵盤上的按鈕收起鍵盤時，輸入框並不會失去焦點，所以不會觸發頁面的 blur 事件；觸發輸入框之外的區域時，輸入框會失去焦點，觸發輸入框的 blur 事件。

指望的結果

針對不一樣系統觸發鍵盤彈出收起時的差別化，咱們但願功能流暢的同時，儘可能保持用戶體驗的一致性。

對症下藥

上面咱們理清了目前市面上兩大主要系統的差別性，接下來就需對症下藥了。

在 h5 中目前沒有接口能夠直接監聽鍵盤事件，但咱們能夠經過分析鍵盤彈出、收起的觸發過程及表現形式，來判斷鍵盤是彈出仍是收起的狀態。

• 鍵盤彈出：輸入框獲取焦點時會自動觸發鍵盤的彈起動做，所以，咱們能夠監聽 focusin 事件，在裏面實現鍵盤彈出後所需的頁面邏輯。

• 鍵盤收起：當觸發其餘頁面區域收起鍵盤時，咱們能夠監聽 focusout 事件，在裏面實現鍵盤收起後所需的頁面邏輯。而在經過鍵盤按鈕收起鍵盤時在 ios 與 android 端存在差別化表現，下面具體分析：

  • IOS：觸發了 focusout 事件，仍然經過該辦法監聽。
  • Android：沒有觸發 focusout 事件。在 android 中，鍵盤的狀態切換（彈出、收起）不只和輸入框關聯，同時還會影響到 webview 高度的變化，那咱們就能夠經過監聽 webview height 的變化來判斷鍵盤是否收起。

系統判斷

在實踐中咱們能夠經過 userAgent 來判斷目前的系統：

const ua = window.navigator.userAgent.toLocaleLowerCase();
const isIOS = /iphone|ipad|ipod/.test(ua);
const isAndroid = /android/.test(ua);

IOS 處理

let isReset = true; //是否歸位

this.focusinHandler = () => {
  isReset = false; //聚焦時鍵盤彈出，焦點在輸入框之間切換時，會先觸發上一個輸入框的失焦事件，再觸發下一個輸入框的聚焦事件
};

this.focusoutHandler = () => {
  isReset = true;
  setTimeout(() => {
    //當焦點在彈出層的輸入框之間切換時先不歸位
    if (isReset) {
        window.scroll(0, 0); //肯定延時後沒有聚焦下一元素，是由收起鍵盤引發的失焦，則強制讓頁面歸位
    }
  }, 30);
};

document.body.addEventListener('focusin', this.focusinHandler);
document.body.addEventListener('focusout', this.focusoutHandler);

Android 處理

const originHeight = document.documentElement.clientHeight || document.body.clientHeight;

this.resizeHandler = () => {
  const resizeHeight = document.documentElement.clientHeight || document.body.clientHeight;
  const activeElement = document.activeElement;
  if (resizeHeight < originHeight) {
    // 鍵盤彈起後邏輯
    if (activeElement && (activeElement.tagName === "INPUT" || activeElement.tagName === "TEXTAREA")) {
      setTimeout(()=>{
        activeElement.scrollIntoView({ block: 'center' });//焦點元素滾到可視區域的問題
      },0)
    }
  } else {
    // 鍵盤收起後邏輯
  }
};

window.addEventListener('resize', this.resizeHandler);

react 封裝

在 react 中咱們能夠寫一個類裝飾器來修飾表單組件。

類裝飾器：類裝飾器在類聲明以前被聲明（緊靠着類聲明）。 類裝飾器應用於類構造函數，能夠用來監視，修改或替換類定義。

// keyboard.tsx
/*
 * @Description: 鍵盤處理裝飾器
 * @Author: hzzly
 * @LastEditors: hzzly
 * @Date: 2020-01-09 09:36:40
 * @LastEditTime: 2020-01-10 12:08:47
 */
import React, { Component } from 'react';

const keyboard = () => (WrappedComponent: any) =>
  class HOC extends Component {
    focusinHandler: (() => void) | undefined;
    focusoutHandler: (() => void) | undefined;
    resizeHandler: (() => void) | undefined;
    componentDidMount() {
      const ua = window.navigator.userAgent.toLocaleLowerCase();
      const isIOS = /iphone|ipad|ipod/.test(ua);
      const isAndroid = /android/.test(ua);
      if (isIOS) {
        // 上面 IOS 處理
        ...
      }
      if (isAndroid) {
        // 上面 Android 處理
        ...
      }
    }

    componentWillUnmount() {
      if (this.focusinHandler && this.focusoutHandler) {
        document.body.removeEventListener('focusin', this.focusinHandler);
        document.body.removeEventListener('focusout', this.focusoutHandler);
      }
      if (this.resizeHandler) {
        document.body.removeEventListener('resize', this.resizeHandler);
      }
    }

    render() {
      return <WrappedComponent {...this.props} />;
    }
  };

export default keyboard;

使用

// PersonForm.tsx
@keyboard()
class PersonForm extends PureComponent<{}, {}> {
  // 業務邏輯
  ...
}

export default PersonForm;