Kibo 不依賴任何函式庫,只要把它放進頁面即可:
<script type="text/javascript" src="kibo.js"></script>
建立一個 Kibo 實例,事件監聽隨之就緒:
var k = new Kibo();
建構子有一個可選參數,用來指定接收事件的 HTML 元素,可以是 input、textarea 或 select;不傳則預設監聽 window.document。
Kibo 只提供兩個方法:down 與 up,都接受兩個參數——按鍵或按鍵組合(可用陣列一次傳多組,也支援通配符),以及匹配成功時要執行的函式。兩者皆支援鏈式調用。
按鍵組合指「控制鍵 + 字符鍵」,或單純一個/多個控制鍵。回呼函式被調用時事件物件會一併傳入:不需要就直接忽略;若函式回傳 false,事件的預設行為會被阻止。
此外還有一個 lastKey 方法,用來查詢最後一次鍵盤事件按下的是哪個鍵,回傳鍵名;不支援的鍵則回傳 undefined。你也可以傳入參數判斷某個特定功能鍵是否被按下,結果是 true 或 false。
以下名稱不分大小寫:
控制鍵:shift, ctrl, alt
字母鍵:a 到 z
數字鍵:0 到 9
功能鍵:f1 到 f12
方向鍵:left, up, right, down
其他:enter, esc, space, backspace, delete, insert, tab, page_up, page_down, home, end, caps_lock, num_lock
通配符:any, any arrow, any number, any letter, any f
單鍵或多鍵組合:
var k = new Kibo();
k.down(['up', 'down'], function() {
console.log('up or down arrow key pressed');
}).up('tab', function() {
console.log('TAB key released');
});
含控制鍵的組合:
function handler() {
console.log('last key: ' + k.lastKey());
}
k.down(['shift q', 'ctrl alt x'], handler);
通配符:
k.down(['any letter', 'any number'], function() {
console.log('letter or number key pressed');
console.log('shift key was' + (k.lastKey('shift') ? '' : ' not') + ' pressed');
});
k.up('any', function() {
console.log('key released');
});
阻止預設行為,例如攔下 F5 重新整理:
k.down('f5', function() { return false; });
Kibo 以 MIT License 發布。