alihan/textual
1
0
Fork 0
mirror of https://github.com/Textualize/textual.git synced 2025-10-17 02:38:12 +03:00
Code Issues Packages Projects Releases Wiki Activity

Datatable scrolling faq (#2477)

Browse Source 
* Add FAQ about DataTable scrolling.

Related issues: #2458

* Write concisely.

* Update questions/datatable-doesnt-scroll.question.md

Co-authored-by: Will McGugan <willmcgugan@gmail.com>

* Remove example.

* Add recommendation.

---------

Co-authored-by: Will McGugan <willmcgugan@gmail.com>
This commit is contained in:
Rodrigo Girão Serrão
2023-05-04 11:42:19 +01:00
committed by GitHub
parent 38592c34bd
commit cbd68b20df
2 changed files with 17 additions and 86 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
questions/datatable-doesnt-scroll.question.md
View File

@@ -5,41 +5,6 @@ alt_titles:
- "Datatable cursor goes off screen and doesn't scroll."
---
If it looks like the scrolling in your `DataTable` is broken, it may be because your `DataTable` does not have its height set, which means it is using the default value of `height: auto`.
In turn, this means that the `DataTable` itself does not have a scrollbar and, hence, it cannot scroll.
If it looks like your `DataTable` has scrollbars, those might belong to the container(s) of the `DataTable`, which in turn makes it look like the scrolling of the `DataTable` is broken.
To see the difference, try running the app below with and without the comment in the attribute `TableApp.CSS`.
Press <kbd>E</kbd> to scroll the `DataTable` to the end.
If the `CSS` is commented out, the `DataTable` does not have a scrollbar and, therefore, there is nothing to scroll.
<details>
<summary>Example app.</summary>
```py
from textual.app import App, ComposeResult
from textual.widgets import DataTable
class TableApp(App):
# CSS = "DataTable { height: 100% }"
def compose(self) -> ComposeResult:
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_e(self) -> None:
self.query_one(DataTable).action_scroll_end()
app = TableApp()
if __name__ == "__main__":
app.run()
```
</details>
If scrolling in your `DataTable` is _apparently_ broken, it may be because your `DataTable` is using the default value of `height: auto`.
This means that the table will be sized to fit its rows without scrolling, which may cause the *container* (typically the screen) to scroll.
If you would like the table itself to scroll, set the height to something other than `auto`, like `100%`.