Add customKeypressHandler

This commit is contained in:
CHaBou
2017-06-16 20:23:48 +02:00
parent 663d3b24cd
commit 95aed8fcb0
2 changed files with 47 additions and 1 deletions
+27
View File
@@ -377,6 +377,11 @@ describe('xterm.js', function() {
stopPropagation: function() {}, stopPropagation: function() {},
type: 'keydown' type: 'keydown'
} }
var evKeyPress = {
preventDefault: function() {},
stopPropagation: function() {},
type: 'keypress'
}
beforeEach(function() { beforeEach(function() {
xterm.handler = function() {}; xterm.handler = function() {};
@@ -387,6 +392,11 @@ describe('xterm.js', function() {
bind: function() { bind: function() {
return function () { return true; } return function () { return true; }
} }
},
keypress: {
bind: function() {
return function () { return true; }
}
} }
} }
}); });
@@ -403,13 +413,30 @@ describe('xterm.js', function() {
assert.equal(xterm.keyDown(Object.assign({}, evKeyDown, { keyCode: 77 })), false); assert.equal(xterm.keyDown(Object.assign({}, evKeyDown, { keyCode: 77 })), false);
}); });
it('should process the keypress event based on what the handler returns', function () {
assert.equal(xterm.keyPress(Object.assign({}, evKeyPress, { keyCode: 77 })), true);
xterm.attachCustomKeypressHandler(function (ev) {
return ev.keyCode === 77;
});
assert.equal(xterm.keyPress(Object.assign({}, evKeyPress, { keyCode: 77 })), true);
xterm.attachCustomKeypressHandler(function (ev) {
return ev.keyCode !== 77;
});
assert.equal(xterm.keyPress(Object.assign({}, evKeyPress, { keyCode: 77 })), false);
});
it('should alive after reset(ESC c Full Reset (RIS))', function () { it('should alive after reset(ESC c Full Reset (RIS))', function () {
xterm.attachCustomKeydownHandler(function (ev) { xterm.attachCustomKeydownHandler(function (ev) {
return ev.keyCode !== 77; return ev.keyCode !== 77;
}); });
xterm.attachCustomKeypressHandler(function (ev) {
return ev.keyCode !== 77;
});
assert.equal(xterm.keyDown(Object.assign({}, evKeyDown, { keyCode: 77 })), false); assert.equal(xterm.keyDown(Object.assign({}, evKeyDown, { keyCode: 77 })), false);
assert.equal(xterm.keyPress(Object.assign({}, evKeyPress, { keyCode: 77 })), false);
xterm.reset(); xterm.reset();
assert.equal(xterm.keyDown(Object.assign({}, evKeyDown, { keyCode: 77 })), false); assert.equal(xterm.keyDown(Object.assign({}, evKeyDown, { keyCode: 77 })), false);
assert.equal(xterm.keyPress(Object.assign({}, evKeyPress, { keyCode: 77 })), false);
}); });
}); });
+20 -1
View File
@@ -168,6 +168,7 @@ function Terminal(options) {
this.scrollTop = 0; this.scrollTop = 0;
this.scrollBottom = this.rows - 1; this.scrollBottom = this.rows - 1;
this.customKeydownHandler = null; this.customKeydownHandler = null;
this.customKeypressHandler = null;
this.cursorBlinkInterval = null; this.cursorBlinkInterval = null;
// modes // modes
@@ -1316,6 +1317,18 @@ Terminal.prototype.attachCustomKeydownHandler = function(customKeydownHandler) {
this.customKeydownHandler = customKeydownHandler; this.customKeydownHandler = customKeydownHandler;
} }
/**
* Attaches a custom keypress handler which is run before keys are processed, giving consumers of
* xterm.js ultimate control as to what keys should be processed by the terminal and what keys
* should not.
* @param {function} customKeypressHandler The custom KeyboardEvent handler to attach. This is a
* function that takes a KeyboardEvent, allowing consumers to stop propogation and/or prevent
* the default action. The function returns whether the event should be processed by xterm.js.
*/
Terminal.prototype.attachCustomKeypressHandler = function(customKeypressHandler) {
this.customKeypressHandler = customKeypressHandler;
}
/** /**
* Attaches a http(s) link handler, forcing web links to behave differently to * Attaches a http(s) link handler, forcing web links to behave differently to
* regular <a> tags. This will trigger a refresh as links potentially need to be * regular <a> tags. This will trigger a refresh as links potentially need to be
@@ -1777,6 +1790,10 @@ Terminal.prototype.setgCharset = function(g, charset) {
Terminal.prototype.keyPress = function(ev) { Terminal.prototype.keyPress = function(ev) {
var key; var key;
if (this.customKeypressHandler && this.customKeypressHandler(ev) === false) {
return false;
}
this.cancel(ev); this.cancel(ev);
if (ev.charCode) { if (ev.charCode) {
@@ -1802,7 +1819,7 @@ Terminal.prototype.keyPress = function(ev) {
this.showCursor(); this.showCursor();
this.handler(key); this.handler(key);
return false; return true;
}; };
/** /**
@@ -2236,9 +2253,11 @@ Terminal.prototype.reset = function() {
this.options.rows = this.rows; this.options.rows = this.rows;
this.options.cols = this.cols; this.options.cols = this.cols;
var customKeydownHandler = this.customKeydownHandler; var customKeydownHandler = this.customKeydownHandler;
var customKeypressHandler = this.customKeypressHandler;
var cursorBlinkInterval = this.cursorBlinkInterval; var cursorBlinkInterval = this.cursorBlinkInterval;
Terminal.call(this, this.options); Terminal.call(this, this.options);
this.customKeydownHandler = customKeydownHandler; this.customKeydownHandler = customKeydownHandler;
this.customKeypressHandler = customKeypressHandler;
this.cursorBlinkInterval = cursorBlinkInterval; this.cursorBlinkInterval = cursorBlinkInterval;
this.refresh(0, this.rows - 1); this.refresh(0, this.rows - 1);
this.viewport.syncScrollArea(); this.viewport.syncScrollArea();