playwright.controller.NavsetBar

playwright.controller.NavsetBar(page, id)

Controller for shiny.express.ui.navset_bar.

Attributes

Name	Description
expect	Expectation method equivalent to playwright.expect(self.loc).
id	The browser DOM id of the UI element.
loc	Playwright Locator of the UI element.
loc_container	Playwright Locator for the container of the UI element.
page	Playwright Page of the Shiny app.

Methods

Name	Description
expect_bg	Expects the navset bar to have the specified background color.
expect_fluid	Expects the navset bar to have a fluid or fixed layout.
expect_gap	Expects the navset bar to have the specified gap.
expect_inverse	Expects the navset bar to be light text color if inverse is True
expect_nav_titles	Expects the control to have the specified nav titles.
expect_nav_values	Expects the control to have the specified nav values.
expect_position	Expects the navset bar to have the specified position.
expect_sidebar	Assert whether or not the sidebar exists within the navset.
expect_title	Expects the navset title to have the specified text.
expect_value	Expects the control to have the specified value.
get_loc_active_content	Returns the locator for the active content.
nav_panel	Returns the nav panel (NavPanel) with the specified value.
set	Sets the state of the control to open or closed.

expect_bg

playwright.controller.NavsetBar.expect_bg(bg, *, timeout=None)

Expects the navset bar to have the specified background color.

Parameters

Name	Type	Description	Default
bg	PatternOrStr	The expected background color.	required
timeout	Timeout	The maximum time to wait for the expectation to pass. Defaults to None.	None

expect_fluid

playwright.controller.NavsetBar.expect_fluid(value, *, timeout=None)

Expects the navset bar to have a fluid or fixed layout.

Parameters

Name	Type	Description	Default
value	bool	True if the layout is fluid or False if it is fixed.	required
timeout	Timeout	The maximum time to wait for the expectation to pass. Defaults to None.	None

expect_gap

playwright.controller.NavsetBar.expect_gap(gap, *, timeout=None)

Expects the navset bar to have the specified gap.

Parameters

Name	Type	Description	Default
gap	PatternOrStr	The expected gap.	required
timeout	Timeout	The maximum time to wait for the expectation to pass. Defaults to None.	None

expect_inverse

playwright.controller.NavsetBar.expect_inverse(value, *, timeout=None)

Expects the navset bar to be light text color if inverse is True

Parameters

Name	Type	Description	Default
value	bool	True if the navset bar is expected to have inverse text color, False otherwise.	required
timeout	Timeout	The maximum time to wait for the expectation to pass. Defaults to None.	None

expect_nav_titles

playwright.controller.NavsetBar.expect_nav_titles(value, *, timeout=None)

Expects the control to have the specified nav titles.

Parameters

Name	Type	Description	Default
value	list[PatternOrStr]	The expected nav titles.	required
timeout	Timeout	The maximum time to wait for the expectation to pass. Defaults to None.	None

expect_nav_values

playwright.controller.NavsetBar.expect_nav_values(value, *, timeout=None)

Expects the control to have the specified nav values.

Parameters

Name	Type	Description	Default
value	list[PatternOrStr]	The expected nav values.	required
timeout	Timeout	The maximum time to wait for the expectation to pass. Defaults to None.	None

expect_position

playwright.controller.NavsetBar.expect_position(
    position='static-top',
    *,
    timeout=None,
)

Expects the navset bar to have the specified position.

Parameters

Name	Type	Description	Default
position	Literal[‘fixed-top’, ‘fixed-bottom’, ‘static-top’, ‘sticky-top’]	The expected position. Defaults to 'static-top'.	'static-top'
timeout	Timeout	The maximum time to wait for the expectation to pass. Defaults to None.	None

expect_sidebar

playwright.controller.NavsetBar.expect_sidebar(exists, *, timeout=None)

Assert whether or not the sidebar exists within the navset.

Parameters

Name	Type	Description	Default
exists	bool	True if the sidebar exists within the navset.	required
timeout	Timeout	The maximum time to wait for the expectation to pass. Defaults to None.	None

expect_title

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

Expects the navset title to have the specified text.

Parameters

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

expect_value

playwright.controller.NavsetBar.expect_value(value, *, timeout=None)

Expects the control to have the specified value.

Parameters

Name	Type	Description	Default
value	PatternOrStr	The expected value.	required
timeout	Timeout	The maximum time to wait for the expectation to pass. Defaults to None.	None

get_loc_active_content

playwright.controller.NavsetBar.get_loc_active_content(timeout=None)

Returns the locator for the active content.

Parameters

Name	Type	Description	Default
timeout	Timeout	The maximum time to wait for the locator to appear. Defaults to None.	None

nav_panel

playwright.controller.NavsetBar.nav_panel(value)

Returns the nav panel (NavPanel) with the specified value.

Parameters

Name	Type	Description	Default
value	str	The value of the nav panel.	required

set

playwright.controller.NavsetBar.set(value, *, timeout=None)

Sets the state of the control to open or closed.

Parameters

Name	Type	Description	Default
value	str	The selected nav item.	required