==========
Mouse Keys
==========

Mouse button key names available per platform.

Windows
=======

.. list-table::
   :header-rows: 1
   :widths: 40 60

   * - Key Name
     - Description
   * - ``mouse_left``
     - Left mouse button
   * - ``mouse_middle``
     - Middle mouse button (scroll wheel click)
   * - ``mouse_right``
     - Right mouse button
   * - ``mouse_x1``
     - Extra button 1 (back)
   * - ``mouse_x2``
     - Extra button 2 (forward)

Linux (X11)
===========

**Standard buttons:**

.. list-table::
   :header-rows: 1
   :widths: 40 60

   * - Key Name
     - Description
   * - ``mouse_left``
     - Left mouse button
   * - ``mouse_middle``
     - Middle mouse button
   * - ``mouse_right``
     - Right mouse button

**Scroll directions (special keys):**

.. list-table::
   :header-rows: 1
   :widths: 40 60

   * - Key Name
     - Description
   * - ``scroll_up``
     - Scroll up
   * - ``scroll_down``
     - Scroll down
   * - ``scroll_left``
     - Scroll left
   * - ``scroll_right``
     - Scroll right

macOS
=====

.. list-table::
   :header-rows: 1
   :widths: 40 60

   * - Key Name
     - Description
   * - ``mouse_left``
     - Left mouse button
   * - ``mouse_middle``
     - Middle mouse button
   * - ``mouse_right``
     - Right mouse button