playwright.controller.Offcanvas

playwright.controller.Offcanvas(page, id)

Attributes

Name	Description
expect	Expectation method equivalent to `playwright.expect(self.loc)`.
id	The browser DOM `id` of the UI element.
loc	Playwright `Locator` for the offcanvas root element (`bslib-offcanvas#{id}`).
loc_body	Playwright `Locator` for the offcanvas body.
loc_close	Playwright `Locator` for the close button inside the offcanvas header.
loc_footer	Playwright `Locator` for the offcanvas footer.
loc_title	Playwright `Locator` for the title inside the offcanvas header.
loc_trigger	Playwright `Locator` for the trigger element(s) targeting this offcanvas panel.
page	Playwright `Page` of the Shiny app.

Name	Description
close	Closes the offcanvas panel.
expect_body	Expects the offcanvas body to have the specified text.
expect_footer	Expects the offcanvas footer to have the specified text.
expect_open	Expects the offcanvas panel to be open or closed.
expect_placement	Expects the offcanvas panel to have the specified placement.
expect_title	Expects the offcanvas title to have the specified text.
open	Opens the offcanvas panel.
set	Sets the offcanvas panel to open or closed.

playwright.controller.Offcanvas.close(timeout=None)

Closes the offcanvas panel.

Name	Type	Description	Default
timeout	`Timeout`	The maximum time to wait for the offcanvas to close. Defaults to `None`.	`None`

playwright.controller.Offcanvas.expect_body(value, *, timeout=None)

Expects the offcanvas body to have the specified text.

Name	Type	Description	Default
value	`PatternOrStr`	The expected text pattern or string.	required
timeout	`Timeout`	The maximum time to wait for the offcanvas body to appear. Defaults to `None`.	`None`

playwright.controller.Offcanvas.expect_footer(value, *, timeout=None)

Expects the offcanvas footer to have the specified text.

Name	Type	Description	Default
value	`PatternOrStr`	The expected text pattern or string.	required
timeout	`Timeout`	The maximum time to wait for the footer to appear. Defaults to `None`.	`None`

playwright.controller.Offcanvas.expect_open(value, *, timeout=None)

Expects the offcanvas panel to be open or closed.

Name	Type	Description	Default
value	bool	`True` if the offcanvas should be open, `False` if it should be closed.	required
timeout	`Timeout`	The maximum time to wait for the expectation to pass. Defaults to `None`.	`None`

playwright.controller.Offcanvas.expect_placement(value, *, timeout=None)

Expects the offcanvas panel to have the specified placement.

Name	Type	Description	Default
value	Literal[‘start’, ‘end’, ‘top’, ‘bottom’, ‘left’, ‘right’]	The expected placement (“start”, “end”, “top”, “bottom”, “left”, “right”).	required
timeout	`Timeout`	The maximum time to wait for the expectation to pass. Defaults to `None`.	`None`

playwright.controller.Offcanvas.expect_title(value, *, timeout=None)

Expects the offcanvas title to have the specified text.

Name	Type	Description	Default
value	`PatternOrStr`	The expected text pattern or string.	required
timeout	`Timeout`	The maximum time to wait for the title to appear. Defaults to `None`.	`None`

playwright.controller.Offcanvas.open(timeout=None)

Opens the offcanvas panel.

Name	Type	Description	Default
timeout	`Timeout`	The maximum time to wait for the offcanvas to open. Defaults to `None`.	`None`

playwright.controller.Offcanvas.set(open, *, timeout=None)

Sets the offcanvas panel to open or closed.

Name	Type	Description	Default
open	bool	`True` to open the offcanvas, `False` to close it.	required
timeout	`Timeout`	The maximum time to wait for the offcanvas to change state. Defaults to `None`.	`None`