Merge pull request #4915 from tisilent/update-attachCustomWheelEventHandler-comments

Update attachCustomWheelEventHandler comments
This commit is contained in:
Daniel Imms
2023-12-29 03:58:50 -08:00
committed by GitHub
+2 -2
View File
@@ -1014,7 +1014,7 @@ declare module '@xterm/xterm' {
* Attaches a custom wheel event handler which is run before keys are
* processed, giving consumers of xterm.js control over whether to proceed
* or cancel terminal wheel events.
* @param customMouseEventHandler The custom WheelEvent handler to attach.
* @param customWheelEventHandler The custom WheelEvent handler to attach.
* This is a function that takes a WheelEvent, allowing consumers to stop
* propagation and/or prevent the default action. The function returns
* whether the event should be processed by xterm.js.
@@ -1022,7 +1022,7 @@ declare module '@xterm/xterm' {
* @example A handler that prevents all wheel events while ctrl is held from
* being processed.
* ```ts
* term.attachCustomKeyEventHandler(ev => {
* term.attachCustomWheelEventHandler(ev => {
* if (ev.ctrlKey) {
* return false;
* }