Skip to content

Commit

Permalink
Added side button documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
xanderfrangos committed Jan 15, 2024
1 parent f62faae commit 960acc2
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Import the module and register for the mouse events you'd like to listen to.
Returns:
- **x:** The X position of the mouse, relative to the top left of the primary display.
- **y:** The Y position of the mouse, relative to the top left of the primary display.
- **button:** Which button was pressed. 1 is left-click. 2 is right-click. 3 is middle-click.
- **button:** Which button was pressed. 1 is left-click. 2 is right-click. 3 is middle-click. 4 and 5 are side buttons ("XBUTTON1" and "XBUTTON2").

**`mousemove`***Fires when the mouse cursor is moved.*\
Returns:
Expand Down

0 comments on commit 960acc2

Please sign in to comment.