Skip to content

Update Widget.set_loading Docstring #5833

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
willmcgugan merged 3 commits into from
Jun 11, 2025
Merged

Update Widget.set_loading Docstring #5833

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7c7706a
docs(Widget): remove outdated return header from `set_loading` method…
ddkasa Jun 2, 2025
8fa5640
ref(Widget): move class name into method call
ddkasa Jun 2, 2025
4a8d37f
docs(Widget): update `set_loading` extended description
ddkasa Jun 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 3 additions & 6 deletions src/textual/widget.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -953,18 +953,15 @@ def get_loading_widget(self) -> Widget:
def set_loading(self, loading: bool) -> None:
"""Set or reset the loading state of this widget.

A widget in a loading state will display a LoadingIndicator that obscures the widget.
A widget in a loading state will display a `LoadingIndicator` or a custom widget
set through overriding the `get_loading_widget` method.

Args:
loading: `True` to put the widget into a loading state, or `False` to reset the loading state.

Returns:
An optional awaitable.
"""
LOADING_INDICATOR_CLASS = "-textual-loading-indicator"
if loading:
loading_indicator = self.get_loading_widget()
loading_indicator.add_class(LOADING_INDICATOR_CLASS)
loading_indicator.add_class("-textual-loading-indicator")
self._cover(loading_indicator)
else:
self._uncover()
Expand Down
Loading