Scroll cursor into view. (#2464)

* Scroll cursor into view.

Related issues: #2459.

* Add regression test.

* Update changelog.
This commit is contained in:
Rodrigo Girão Serrão
2023-05-03 13:57:04 +01:00
committed by GitHub
parent e5c54a3683
commit 3728555fbd
3 changed files with 32 additions and 0 deletions

View File

@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](http://keepachangelog.com/)
and this project adheres to [Semantic Versioning](http://semver.org/).
## Unreleased
### Changed
- The DataTable cursor is now scrolled into view when the cursor coordinate is changed programmatically https://github.com/Textualize/textual/issues/2459
## [0.23.0] - 2023-05-03
### Fixed

View File

@@ -950,6 +950,7 @@ class DataTable(ScrollView, Generic[CellType], can_focus=True):
elif self.cursor_type == "column":
self.refresh_column(old_coordinate.column)
self._highlight_column(new_coordinate.column)
self._scroll_cursor_into_view()
def _highlight_coordinate(self, coordinate: Coordinate) -> None:
"""Apply highlighting to the cell at the coordinate, and post event."""

View File

@@ -991,3 +991,28 @@ def test_key_string_lookup():
assert dictionary[RowKey("foo")] == "bar"
assert dictionary["hello"] == "world"
assert dictionary[RowKey("hello")] == "world"
async def test_scrolling_cursor_into_view():
"""Regression test for https://github.com/Textualize/textual/issues/2459"""
class TableApp(App):
CSS = "DataTable { height: 100%; }"
def compose(self):
yield DataTable()
def on_mount(self) -> None:
table = self.query_one(DataTable)
table.add_column("n")
table.add_rows([(n,) for n in range(300)])
def key_c(self):
self.query_one(DataTable).cursor_coordinate = Coordinate(200, 0)
app = TableApp()
async with app.run_test() as pilot:
await pilot.press("c")
await pilot.pause()
assert app.query_one(DataTable).scroll_y > 100