Skip to content

Commit 5901720

Browse files
committed
fix: docs
1 parent f92666c commit 5901720

File tree

2 files changed

+15
-13
lines changed

2 files changed

+15
-13
lines changed

docs/helpers/Playwright.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -993,13 +993,12 @@ Returns **[Promise][9]<[Array][10]<any>>**
993993

994994
### grabCheckedElementStatus
995995

996-
{{> grabCheckedElementStatus }}
996+
Return the checked status of given element.
997997

998998
#### Parameters
999999

1000-
- `locator`
1001-
- `options`
1002-
- `See` **[object][5]** [https://playwright.dev/docs/api/class-locator#locator-is-checked][24]
1000+
- `locator` **([string][8] | [object][5])** element located by CSS|XPath|strict locator.
1001+
- `options` **[object][5]?** See [https://playwright.dev/docs/api/class-locator#locator-is-checked][24]
10031002

10041003
Returns **[Promise][9]<[boolean][25]>**
10051004

@@ -1092,13 +1091,12 @@ Returns **[Promise][9]<void>** automatically synchronized promise through #re
10921091

10931092
### grabDisabledElementStatus
10941093

1095-
{{> grabDisabledElementStatus }}
1094+
Return the disabled status of given element.
10961095

10971096
#### Parameters
10981097

1099-
- `locator`
1100-
- `options`
1101-
- `See` **[object][5]** [https://playwright.dev/docs/api/class-locator#locator-is-disabled][26]
1098+
- `locator` **([string][8] | [object][5])** element located by CSS|XPath|strict locator.
1099+
- `options` **[object][5]?** See [https://playwright.dev/docs/api/class-locator#locator-is-disabled][26]
11021100

11031101
Returns **[Promise][9]<[boolean][25]>**
11041102

lib/helper/Playwright.js

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -994,8 +994,10 @@ class Playwright extends Helper {
994994
return this._waitForAction();
995995
}
996996
/**
997-
* {{> grabCheckedElementStatus }}
998-
* @param {object} See https://playwright.dev/docs/api/class-locator#locator-is-checked
997+
* Return the checked status of given element.
998+
*
999+
* @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
1000+
* @param {object} [options] See https://playwright.dev/docs/api/class-locator#locator-is-checked
9991001
* @return {Promise<boolean>}
10001002
*
10011003
*/
@@ -1004,14 +1006,16 @@ class Playwright extends Helper {
10041006
const el = await this._locateElement(locator);
10051007
const type = await el.getAttribute('type');
10061008

1007-
if (type === 'checkbox' || type === 'radio') {
1009+
if (['checkbox', 'radio'].includes(type)) {
10081010
return el.isChecked(options);
10091011
}
10101012
throw new Error('Element is not a checkbox or radio input');
10111013
}
10121014
/**
1013-
* {{> grabDisabledElementStatus }}
1014-
* @param {object} See https://playwright.dev/docs/api/class-locator#locator-is-disabled
1015+
* Return the disabled status of given element.
1016+
*
1017+
* @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
1018+
* @param {object} [options] See https://playwright.dev/docs/api/class-locator#locator-is-disabled
10151019
* @return {Promise<boolean>}
10161020
*
10171021
*/

0 commit comments

Comments
 (0)