From 207cb38a2b65865a619fe2cec941b8fe5d1f6f4e Mon Sep 17 00:00:00 2001 From: fancidev Date: Mon, 28 Jul 2025 06:36:57 +0800 Subject: [PATCH] Update docs with MouseScrollLeft and MouseScrollRight. --- docs/events/click.md | 2 ++ docs/events/enter.md | 2 ++ docs/events/leave.md | 2 ++ docs/events/mouse_down.md | 2 ++ docs/events/mouse_move.md | 2 ++ docs/events/mouse_scroll_down.md | 2 ++ docs/events/mouse_scroll_left.md | 22 ++++++++++++++++++++++ docs/events/mouse_scroll_right.md | 22 ++++++++++++++++++++++ docs/events/mouse_scroll_up.md | 2 ++ docs/events/mouse_up.md | 2 ++ docs/guide/input.md | 2 ++ 11 files changed, 62 insertions(+) create mode 100644 docs/events/mouse_scroll_left.md create mode 100644 docs/events/mouse_scroll_right.md diff --git a/docs/events/click.md b/docs/events/click.md index e93dd8d33..a9252077d 100644 --- a/docs/events/click.md +++ b/docs/events/click.md @@ -20,5 +20,7 @@ See [MouseEvent][textual.events.MouseEvent] for the list of properties and metho - [MouseEvent][textual.events.MouseEvent] - [MouseMove](mouse_move.md) - [MouseScrollDown](mouse_scroll_down.md) +- [MouseScrollLeft](mouse_scroll_left.md) +- [MouseScrollRight](mouse_scroll_right.md) - [MouseScrollUp](mouse_scroll_up.md) - [MouseUp](mouse_up.md) diff --git a/docs/events/enter.md b/docs/events/enter.md index d6d532b91..5b81987cf 100644 --- a/docs/events/enter.md +++ b/docs/events/enter.md @@ -9,5 +9,7 @@ - [MouseDown](mouse_down.md) - [MouseMove](mouse_move.md) - [MouseScrollDown](mouse_scroll_down.md) +- [MouseScrollLeft](mouse_scroll_left.md) +- [MouseScrollRight](mouse_scroll_right.md) - [MouseScrollUp](mouse_scroll_up.md) - [MouseUp](mouse_up.md) diff --git a/docs/events/leave.md b/docs/events/leave.md index e6231890d..a0ae675ae 100644 --- a/docs/events/leave.md +++ b/docs/events/leave.md @@ -9,5 +9,7 @@ - [MouseDown](mouse_down.md) - [MouseMove](mouse_move.md) - [MouseScrollDown](mouse_scroll_down.md) +- [MouseScrollLeft](mouse_scroll_left.md) +- [MouseScrollRight](mouse_scroll_right.md) - [MouseScrollUp](mouse_scroll_up.md) - [MouseUp](mouse_up.md) diff --git a/docs/events/mouse_down.md b/docs/events/mouse_down.md index 83d5e21cf..a8c64d9dc 100644 --- a/docs/events/mouse_down.md +++ b/docs/events/mouse_down.md @@ -16,5 +16,7 @@ See [MouseEvent][textual.events.MouseEvent] for the full list of properties and - [MouseEvent][textual.events.MouseEvent] - [MouseMove](mouse_move.md) - [MouseScrollDown](mouse_scroll_down.md) +- [MouseScrollLeft](mouse_scroll_left.md) +- [MouseScrollRight](mouse_scroll_right.md) - [MouseScrollUp](mouse_scroll_up.md) - [MouseUp](mouse_up.md) diff --git a/docs/events/mouse_move.md b/docs/events/mouse_move.md index 3ac663226..73d688e9d 100644 --- a/docs/events/mouse_move.md +++ b/docs/events/mouse_move.md @@ -16,5 +16,7 @@ See [MouseEvent][textual.events.MouseEvent] for the full list of properties and - [MouseDown](mouse_down.md) - [MouseEvent][textual.events.MouseEvent] - [MouseScrollDown](mouse_scroll_down.md) +- [MouseScrollLeft](mouse_scroll_left.md) +- [MouseScrollRight](mouse_scroll_right.md) - [MouseScrollUp](mouse_scroll_up.md) - [MouseUp](mouse_up.md) diff --git a/docs/events/mouse_scroll_down.md b/docs/events/mouse_scroll_down.md index bf51c7ff8..e4e79a377 100644 --- a/docs/events/mouse_scroll_down.md +++ b/docs/events/mouse_scroll_down.md @@ -16,5 +16,7 @@ See [MouseEvent][textual.events.MouseEvent] for the full list of properties and - [MouseDown](mouse_down.md) - [MouseEvent][textual.events.MouseEvent] - [MouseMove](mouse_move.md) +- [MouseScrollLeft](mouse_scroll_left.md) +- [MouseScrollRight](mouse_scroll_right.md) - [MouseScrollUp](mouse_scroll_up.md) - [MouseUp](mouse_up.md) diff --git a/docs/events/mouse_scroll_left.md b/docs/events/mouse_scroll_left.md new file mode 100644 index 000000000..67e25b3f5 --- /dev/null +++ b/docs/events/mouse_scroll_left.md @@ -0,0 +1,22 @@ +--- +title: MouseScrollLeft +--- + +::: textual.events.MouseScrollLeft + options: + heading_level: 1 + +See [MouseEvent][textual.events.MouseEvent] for the full list of properties and methods. + +## See also + +- [Click](click.md) +- [Enter](enter.md) +- [Leave](leave.md) +- [MouseDown](mouse_down.md) +- [MouseEvent][textual.events.MouseEvent] +- [MouseMove](mouse_move.md) +- [MouseScrollDown](mouse_scroll_down.md) +- [MouseScrollRight](mouse_scroll_right.md) +- [MouseScrollUp](mouse_scroll_up.md) +- [MouseUp](mouse_up.md) diff --git a/docs/events/mouse_scroll_right.md b/docs/events/mouse_scroll_right.md new file mode 100644 index 000000000..77aa6372e --- /dev/null +++ b/docs/events/mouse_scroll_right.md @@ -0,0 +1,22 @@ +--- +title: MouseScrollRight +--- + +::: textual.events.MouseScrollRight + options: + heading_level: 1 + +See [MouseEvent][textual.events.MouseEvent] for the full list of properties and methods. + +## See also + +- [Click](click.md) +- [Enter](enter.md) +- [Leave](leave.md) +- [MouseDown](mouse_down.md) +- [MouseEvent][textual.events.MouseEvent] +- [MouseMove](mouse_move.md) +- [MouseScrollDown](mouse_scroll_down.md) +- [MouseScrollLeft](mouse_scroll_left.md) +- [MouseScrollUp](mouse_scroll_up.md) +- [MouseUp](mouse_up.md) diff --git a/docs/events/mouse_scroll_up.md b/docs/events/mouse_scroll_up.md index facba94fd..d864747e6 100644 --- a/docs/events/mouse_scroll_up.md +++ b/docs/events/mouse_scroll_up.md @@ -17,4 +17,6 @@ See [MouseEvent][textual.events.MouseEvent] for the full list of properties and - [MouseEvent][textual.events.MouseEvent] - [MouseMove](mouse_move.md) - [MouseScrollDown](mouse_scroll_down.md) +- [MouseScrollLeft](mouse_scroll_left.md) +- [MouseScrollRight](mouse_scroll_right.md) - [MouseUp](mouse_up.md) diff --git a/docs/events/mouse_up.md b/docs/events/mouse_up.md index 97baf1d4a..e472fb193 100644 --- a/docs/events/mouse_up.md +++ b/docs/events/mouse_up.md @@ -17,4 +17,6 @@ See [MouseEvent][textual.events.MouseEvent] for the full list of properties and - [MouseEvent][textual.events.MouseEvent] - [MouseMove](mouse_move.md) - [MouseScrollDown](mouse_scroll_down.md) +- [MouseScrollLeft](mouse_scroll_left.md) +- [MouseScrollRight](mouse_scroll_right.md) - [MouseScrollUp](mouse_scroll_up.md) diff --git a/docs/guide/input.md b/docs/guide/input.md index 8d216eda9..012794a1e 100644 --- a/docs/guide/input.md +++ b/docs/guide/input.md @@ -262,6 +262,8 @@ If you want your app to respond to a mouse click you should prefer the Click eve Most mice have a scroll wheel which you can use to scroll the window underneath the cursor. Scrollable containers in Textual will handle these automatically, but you can handle [MouseScrollDown](../events/mouse_scroll_down.md) and [MouseScrollUp](../events/mouse_scroll_up.md) if you want build your own scrolling functionality. +For terminals that support horizontal mouse wheel, Textual sends [MouseScrollLeft](../events/mouse_scroll_left.md) and [MouseScrollRight](../events/mouse_scroll_right.md), and scrollable containers handle them automatically. + !!! information Terminal emulators will typically convert trackpad gestures into scroll events.