module:WPAdminWCSettings

A WooCommerce admin Settings screen

Constructor

new module:WPAdminWCSettings(driver, args)

Parameters:

Name	Type	Description
`driver`	WebDriver	Instance of WebDriver.
`args`	object	Configuration arguments.

Source:

pages/wp-admin/wp-admin-wc-settings.js, line 17

Extends

WPAdminSettings

Methods

_getSubTabSelector(subTab) → {object}

Get the sub-tab selector for a settings sub-tab (Internal use only).

Parameters:

Name	Type	Description
`subTab`	string	Text in the sub-tab.
`.`	object	args - Options. Default { active = false }.

Source:

pages/wp-admin/wp-admin-wc-settings.js, line 110

Returns:

Selector object.

Type: object

_getTabSelector(tab) → {object}

Get the tab selector for a settings tab (Internal use only).

Parameters:

Name	Type	Description
`tab`	string	Text in the tab.
`.`	object	args - Options. Default { active = false }.

Source:

pages/wp-admin/wp-admin-wc-settings.js, line 94

Returns:

Selector object.

Type: object

clickSubTab(subTab) → {Promise}

Click a settings sub-tab.

Parameters:

Name	Type	Description
`subTab`	string	Text in the sub-tab.

Source:

pages/wp-admin/wp-admin-wc-settings.js, line 83

Returns:

Promise that evaluates to true if sub-tab is successfully clicked, false otherwise.

Type: Promise

clickTab(tab) → {Promise}

Click a settings tab.

Parameters:

Name	Type	Description
`tab`	string	Text in the tab.

Source:

pages/wp-admin/wp-admin-wc-settings.js, line 73

Returns:

Promise that evaluates to true if tab is successfully clicked, false otherwise.

Type: Promise

hasActiveSubTab(subTab) → {Promise}

Check whether a settings sub-tab is the current sub-tab.

Parameters:

Name	Type	Description
`subTab`	string	Text in the sub-tab.

Source:

pages/wp-admin/wp-admin-wc-settings.js, line 63

Returns:

Promise that evaluates to true if sub-tab is active, false otherwise.

Type: Promise

hasActiveTab(tab) → {Promise}

Check whether a settings tab is the current tab.

Parameters:

Name	Type	Description
`tab`	string	Text in the tab.

Source:

pages/wp-admin/wp-admin-wc-settings.js, line 53

Returns:

Promise that evaluates to true if tab is active, false otherwise.

Type: Promise

hasSubTab(subTab) → {Promise}

Check whether a settings sub-tab is present.

Parameters:

Name	Type	Description
`subTab`	string	Text in the sub-tab.

Source:

pages/wp-admin/wp-admin-wc-settings.js, line 43

Returns:

Promise that evaluates to true if sub-tab is present and displayed, false otherwise.

Type: Promise

hasTab(tab) → {Promise}

Check whether a settings tab is present.

Parameters:

Name	Type	Description
`tab`	string	Text in the tab.

Source:

pages/wp-admin/wp-admin-wc-settings.js, line 33

Returns:

Promise that evaluates to true if tab is present and displayed, false otherwise.

Type: Promise