Skip to content

doc: show pn.state.sync_busy in the busy how-to #8564

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
philippjfr merged 1 commit into from
Apr 23, 2026
Merged

doc: show pn.state.sync_busy in the busy how-to #8564

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
23 changes: 23 additions & 0 deletions doc/how_to/state/busy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,27 @@ pn.Row(button, pn.bind(indicator, pn.state.param.busy)).servable()

This way we can create a global indicator for the busy state instead of modifying all our callbacks.

## Sync a Boolean indicator with the busy state

If you already have a [`BooleanIndicator`](../../reference/indicators/BooleanStatus.ipynb) such as [`BooleanStatus`](../../reference/indicators/BooleanStatus.ipynb) or [`LoadingSpinner`](../../reference/indicators/LoadingSpinner.ipynb), you can skip the manual `pn.bind` wiring and let `pn.state.sync_busy` update the indicator's `value` directly:

```{pyodide}
import time
import panel as pn
pn.extension() # for notebook

def processing(event):
time.sleep(1)

button = pn.widgets.Button(name='Click me!')
button.on_click(processing)

busy = pn.indicators.LoadingSpinner(value=False, size=30)
pn.state.sync_busy(busy)

pn.Row(button, busy).servable()
```

`sync_busy` accepts any indicator whose `value` parameter is `Boolean`, and keeps multiple synced indicators in step with `pn.state.busy`.

## Relate Resources