ActivityIndicator¶

An activity indicator for a task of indeterminate length.

Usage¶

On most platforms, an ActivityIndicator is usually rendered as a "spinner".

import toga

indicator = toga.ActivityIndicator()

# Start the animation
indicator.start()

# Stop the animation
indicator.stop()

The ActivityIndicator will always take up a fixed amount of physical space in a layout. However, the widget will not be visible when it is in a "stopped" state.

ActivityIndicator(
    id: str | None = None,
    style: StyleT | None = None,
    running: bool = False,
    **kwargs,
)

Bases: Widget

Create a new ActivityIndicator widget.

PARAMETER	DESCRIPTION
`id`	The ID for the widget. TYPE: `str \| None` DEFAULT: `None`
`style`	A style object. If no style is provided, a default style will be applied to the widget. TYPE: `StyleT \| None` DEFAULT: `None`
`running`	Describes whether the indicator is running at the time it is created. TYPE: `bool` DEFAULT: `False`
`kwargs`	Initial style properties. DEFAULT: `{}`

enabled: Literal[True]

Is the widget currently enabled? i.e., can the user interact with the widget?

ActivityIndicator widgets cannot be disabled; this property will always return True; any attempt to modify it will be ignored.

is_running: bool

Determine if the activity indicator is currently running.

Use start() and stop() to change the running state.

True if this activity indicator is running; False otherwise.

focus() -> None

No-op; ActivityIndicator cannot accept input focus.

start() -> None

Start the activity indicator.

If the activity indicator is already started, this is a no-op.

stop() -> None

Stop the activity indicator.

If the activity indicator is already stopped, this is a no-op.