鍵盤

updateKeyboard

TIP

該API使用方法為： wx.updateKeyboard(Object object)

• 功能說明： 更新鍵盤輸入框內容。只有當鍵盤處於拉起狀態時才會產生效果。
• 參數及說明： Object object。

内容	類型	預設值	必填	說明
value	string	-	是	鍵盤輸入框的目前值
success	Function	-	否	接口調用成功的回呼函數
fail	Function	-	否	接口調用失敗的回呼函數
complete	Function	-	否	接口調用結束的回呼函數（無論成功與否都執行）

showKeyboard

TIP

該API使用方法為： wx.showKeyboard(Object object)

• 功能說明： 顯示鍵盤。
• 參數及說明： Object object。

内容	類型	預設值	必填	說明
defaultValue	string	-	是	鍵盤輸入框顯示的預設值
maxLength	number	-	是	鍵盤中文字的最大長度
multiple	boolean	-	是	是否為多行輸入
confirmHold	boolean	-	是	點擊完成時鍵盤是否保持顯示
confirmType	string	-	是	鍵盤右下角 confirm 按鈕的類型，只會影響按鈕的文字內容
success	Function	-	否	接口調用成功的回呼函數
fail	Function	-	否	接口調用失敗的回呼函數
complete	Function	-	否	接口調用結束的回呼函數（無論成功與否都執行）

• confirmType 合法值

  合法值	說明
  done	完成
  next	下一個
  search	蒐索
  go	前往
  send	傳送

onKeyboardInput

TIP

該API使用方法為： wx.onKeyboardInput(function listener)

• 功能說明： 監聽鍵盤輸入事件。

• 參數及說明： function listener， 鍵盤輸入事件的監聽函數，參數如下：

  内容	類型	說明
  value	string	鍵盤輸入的當前值

onKeyboardHeightChange

TIP

該API使用方法為： wx.onKeyboardHeightChange(function listener)

• 功能說明： 監聽鍵盤高度變化事件。

• 參數及說明： function listener， 鍵盤高度變化事件的監聽函數，參數如下：

• Object res。

  内容	類型	說明
  height	number	鍵盤高度

• 示例代碼：

wx.onKeyboardHeightChange((res) => {
  console.log(res.height);
});

onKeyboardConfirm

TIP

該API使用方法為： wx.onKeyboardConfirm(function listener)

• 功能說明： 監聽使用者點擊鍵盤 Confirm 按鈕時的事件。

• 參數及說明： function listener， 使用者點擊鍵盤 Confirm 按鈕時的事件的監聽函數，參數如下：

  内容	類型	說明
  value	string	鍵盤輸入的當前值

onKeyboardComplete

TIP

該API使用方法為： wx.onKeyboardComplete(function listener)

• 功能說明： 監聽鍵盤收起的事件。

• 參數及說明： function listener， 鍵盤收起的事件的監聽函數，參數如下：

  内容	類型	說明
  value	string	鍵盤輸入的當前值

offKeyboardInput

TIP

該API使用方法為： wx.offKeyboardInput(function listener)

• 功能說明： 移除鍵盤輸入事件的監聽函數。
• 參數及說明： function listener， onKeyboardInput 傳入的監聽函數。不傳此參數則移除所有監聽函數。
• 示例代碼：

const listener = function (res) {
  console.log(res);
};
wx.onKeyboardInput(listener);
d;
wx.offKeyboardInput(listener); // Must pass the same function object used in onKeyboardInput

offKeyboardHeightChange

TIP

該API使用方法為： wx.offKeyboardHeightChange(function listener)

• 功能說明： 移除鍵盤高度變化事件的監聽函數。
• 參數及說明： function listener， onKeyboardHeightChange 傳入的監聽函式。不傳此參數則移除所有監聽函數。
• 示例代碼：

const listener = function (res) {
  console.log(res);
};
wx.onKeyboardHeightChange(listener);
wx.offKeyboardHeightChange(listener); // Must pass the same function object used in onKeyboardHeightChange

offKeyboardConfirm

TIP

該API使用方法為： wx.offKeyboardConfirm(function listener)

• 功能說明： 移除使用者點擊鍵盤 Confirm 按鈕時的事件的監聽函數。
• 參數及說明： function listener， onKeyboardConfirm 傳入的監聽函數。不傳此參數則移除所有監聽函數。
• 示例代碼：

const listener = function (res) {
  console.log(res);
};

wx.onKeyboardConfirm(listener);
wx.offKeyboardConfirm(listener); // Must pass the same function object used in onKeyboardConfirm

offKeyboardComplete

TIP

該API使用方法為： wx.offKeyboardComplete(function listener)

• 功能說明： 移除鍵盤收起的事件的監聽函數。
• 參數及說明： function listener， onKeyboardComplete 傳入的監聽函數。不傳此參數則移除所有監聽函數。
• 示例代碼：

const listener = function (res) {
  console.log(res);
};

wx.onKeyboardComplete(listener);
wx.offKeyboardComplete(listener); // Must pass the same function object used in onKeyboardComplete

hideKeyboard

TIP

該API使用方法為： wx.hideKeyboard(Object object)

• 功能說明： 隱藏鍵盤

• 參數及說明： Object object。

  内容	類型	預設值	必填	說明
  success	Function	-	否	接口調用成功的回呼函數
  fail	Function	-	否	接口調用失敗的回呼函數
  complete	Function	-	否	接口調用結束的回呼函數（無論成功與否都執行）

• 示例代碼：

wx.hideKeyboard({
  complete: (res) => {
    console.log("hideKeyboard res", res);
  },
});