Page Action | Loading

info

Introduced in v0.20.0 of the SDK.

The page.loading() method makes it easy to build flexible loading states into your apps. It also exposes useful parameters for disabling user interaction while loading, showing different loading texts to indicate different stages of loading, and more.

Node.js

page.loading(true, { disableInteraction: true, text: "Step 1..." })

await expensiveOperation()

page.loading(true, { text: "Step 2..." })

await expensiveOperation()

page.loading(false)

Python

page.loading(True, disable_interaction=True, text="Step 1...")

expensive_operation()

page.loading(True, text="Step 2...")

expensive_operation()

page.loading(False)

API reference

Function signature

Node.js

page.loading(
    value: boolean,
    properties?: Partial<{
        text: string;
        disableInteraction: boolean;
    }>
): void

Python

page.loading(
    value,
    *,
    text: str | None = None,
    disable_interaction: bool = False
) -> None

Parameters

Node.js

value

required boolean

Whether to show the loading indicator or not.

Python

value

required bool

Whether to show the loading indicator or not.

---

Node.js

properties.text

optional string

Specify a custom text for the loading indicator. You can call page.loading() multiple times with different texts to indicate different stages of loading.

Python

text

optional str

Specify a custom text for the loading indicator. You can call page.loading() multiple times with different texts to indicate different stages of loading.

---

Node.js

properties.disableInteraction

optional boolean

Whether to disable user interaction on the page while the loading indicator is shown. Defaults to false.

Python

disable_interaction

optional bool

Whether to disable user interaction on the page while the loading indicator is shown. Defaults to False.

---

Returns

Node.js

void

Python

None