Skip to content

Commit

Permalink
Update attachCustomWheelEventHandler comments
Browse files Browse the repository at this point in the history
  • Loading branch information
tisilent committed Dec 14, 2023
1 parent 1f15c47 commit 427b4f6
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions typings/xterm.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1014,15 +1014,15 @@ 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.
*
* @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;
* }
Expand Down

0 comments on commit 427b4f6

Please sign in to comment.