Skip to content

AppianButton

AppianButton represents a button selected with page.button(...).

button = page.button(name="Save")
button.click()

AppianButton

Represent an Appian button element bound to a page and name.

Appian action buttons are identified by the DOM contract <button type="button">. A button is disabled when the HTML disabled attribute is present and enabled when that attribute is absent.

click

click() -> None

Wait for Appian, click the actionable button, then wait for completion.

is_visible

is_visible() -> bool

Return whether the button is currently visible.

is_disabled

is_disabled() -> bool

Return whether the HTML disabled attribute is present.

is_enabled

is_enabled(timeout: float | int | None = None) -> bool

Return whether the button is enabled, optionally waiting.

Omitting timeout performs an immediate state query. Supplying a positive timeout in seconds waits up to that duration and returns False if the button never becomes enabled.

wait_until_ready

wait_until_ready() -> 'AppianButton'

Wait until the button is visible and enabled, then return it.

wait_until_hidden

wait_until_hidden() -> None

Wait until the button is hidden or removed.

Use the button to perform actions and check its state through methods such as click(), is_visible(), is_enabled(), and is_disabled().

Exact matching and visibility

By default, robo-appian uses a visible component whose displayed name or label exactly matches what you provide. Keep exact=True and visible=True for normal business automation. Use exact=False only when you intentionally want a partial name or label match. Change visible only when your scenario specifically requires a component that is not currently visible.

Timeout

timeout is expressed in seconds. Leave timeout=None to use the normal configured wait time, or provide a positive value when this particular action needs a different wait time.