ScreenCILocator
ScreenCILocator =
Omit<Locator,"click"|"fill"|"check"|"uncheck"|"setChecked"|"tap"|"selectOption"|"selectText"|"dragTo"|LocatorReturnMethodNames|"all"|"page"> &object
Defined in: types.ts:480
Type Declaration
Section titled “Type Declaration”all():
Promise<ScreenCILocator[]>
Returns
Section titled “Returns”Promise<ScreenCILocator[]>
and(…
args):ScreenCILocator
Parameters
Section titled “Parameters”…[Locator]
Returns
Section titled “Returns”ScreenCILocator
check()
Section titled “check()”check(
options?):Promise<void>
Checks the checkbox or radio button.
ScreenCI defaults noWaitAfter to true for the underlying click.
Pass noWaitAfter: false to keep Playwright’s default waiting behavior.
Parameters
Section titled “Parameters”options?
Section titled “options?”ScreenCILocatorCheckOptions
Returns
Section titled “Returns”Promise<void>
click()
Section titled “click()”click(
options?):Promise<void>
Clicks the element with an animated cursor move.
ScreenCI defaults noWaitAfter to true for this action so the rendered
click can complete before navigation waits. Pass noWaitAfter: false to
keep Playwright’s default waiting behavior.
Parameters
Section titled “Parameters”options?
Section titled “options?”ScreenCILocatorClickOptions
Returns
Section titled “Returns”Promise<void>
describe()
Section titled “describe()”describe(…
args):ScreenCILocator
Parameters
Section titled “Parameters”…[string]
Returns
Section titled “Returns”ScreenCILocator
dragTo()
Section titled “dragTo()”dragTo(
target,options?):Promise<void>
Drags the element to the target locator with animated cursor movement.
The animation consists of:
- Cursor moves to the source element (
moveDuration,moveEasing). - A brief pause (
preDragPause) then a mouseDown. - Cursor drags from source to target (
dragDuration,dragEasing). - A mouseUp at the target.
Parameters
Section titled “Parameters”target
Section titled “target”Locator
The locator of the drop target element.
options?
Section titled “options?”ScreenCILocatorDragToOptions
Returns
Section titled “Returns”Promise<void>
fill()
Section titled “fill()”fill(
value,options?):Promise<void>
Types value character-by-character using pressSequentially.
Parameters
Section titled “Parameters”string
The text to type into the element.
options?
Section titled “options?”ScreenCILocatorFillOptions
Returns
Section titled “Returns”Promise<void>
filter()
Section titled “filter()”filter(…
args):ScreenCILocator
Parameters
Section titled “Parameters”…[object]
Returns
Section titled “Returns”ScreenCILocator
first()
Section titled “first()”first():
ScreenCILocator
Returns
Section titled “Returns”ScreenCILocator
getByAltText()
Section titled “getByAltText()”getByAltText(…
args):ScreenCILocator
Parameters
Section titled “Parameters”…[string | RegExp, object]
Returns
Section titled “Returns”ScreenCILocator
getByLabel()
Section titled “getByLabel()”getByLabel(…
args):ScreenCILocator
Parameters
Section titled “Parameters”…[string | RegExp, object]
Returns
Section titled “Returns”ScreenCILocator
getByPlaceholder()
Section titled “getByPlaceholder()”getByPlaceholder(…
args):ScreenCILocator
Parameters
Section titled “Parameters”…[string | RegExp, object]
Returns
Section titled “Returns”ScreenCILocator
getByRole()
Section titled “getByRole()”getByRole(…
args):ScreenCILocator
Parameters
Section titled “Parameters”…["alert" | "alertdialog" | "application" | "article" | "banner" | "blockquote" | "button" | "caption" | "cell" | "checkbox" | "code" | "columnheader" | "combobox" | "complementary" | "contentinfo" | "definition" | "deletion" | "dialog" | "directory" | "document" | "emphasis" | "feed" | "figure" | "form" | "generic" | "grid" | "gridcell" | "group" | "heading" | "img" | "insertion" | "link" | "list" | "listbox" | "listitem" | "log" | "main" | "marquee" | "math" | "meter" | "menu" | "menubar" | "menuitem" | "menuitemcheckbox" | "menuitemradio" | "navigation" | "none" | "note" | "option" | "paragraph" | "presentation" | "progressbar" | "radio" | "radiogroup" | "region" | "row" | "rowgroup" | "rowheader" | "scrollbar" | "search" | "searchbox" | "separator" | "slider" | "spinbutton" | "status" | "strong" | "subscript" | "superscript" | "switch" | "tab" | "table" | "tablist" | "tabpanel" | "term" | "textbox" | "time" | "timer" | "toolbar" | "tooltip" | "tree" | "treegrid" | "treeitem", object]
Returns
Section titled “Returns”ScreenCILocator
getByTestId()
Section titled “getByTestId()”getByTestId(…
args):ScreenCILocator
Parameters
Section titled “Parameters”…[string | RegExp]
Returns
Section titled “Returns”ScreenCILocator
getByText()
Section titled “getByText()”getByText(…
args):ScreenCILocator
Parameters
Section titled “Parameters”…[string | RegExp, object]
Returns
Section titled “Returns”ScreenCILocator
getByTitle()
Section titled “getByTitle()”getByTitle(…
args):ScreenCILocator
Parameters
Section titled “Parameters”…[string | RegExp, object]
Returns
Section titled “Returns”ScreenCILocator
hover()
Section titled “hover()”hover(
options?):Promise<void>
Hovers over the element with an animated cursor move.
Parameters
Section titled “Parameters”options?
Section titled “options?”ScreenCILocatorHoverOptions
Returns
Section titled “Returns”Promise<void>
last()
Section titled “last()”last():
ScreenCILocator
Returns
Section titled “Returns”ScreenCILocator
locator()
Section titled “locator()”locator(…
args):ScreenCILocator
Parameters
Section titled “Parameters”…[string | Locator, object]
Returns
Section titled “Returns”ScreenCILocator
nth(…
args):ScreenCILocator
Parameters
Section titled “Parameters”…[number]
Returns
Section titled “Returns”ScreenCILocator
or(…
args):ScreenCILocator
Parameters
Section titled “Parameters”…[Locator]
Returns
Section titled “Returns”ScreenCILocator
page()
Section titled “page()”page():
ScreenCIPage
Returns
Section titled “Returns”pressSequentially()
Section titled “pressSequentially()”pressSequentially(
text,options?):Promise<void>
Presses keys one by one as if on a physical keyboard.
Parameters
Section titled “Parameters”string
The text to type.
options?
Section titled “options?”ScreenCILocatorPressSequentiallyOptions
Returns
Section titled “Returns”Promise<void>
selectOption()
Section titled “selectOption()”selectOption(
values,options?):Promise<string[]>
Selects an option in a <select> element.
Note: the native dropdown UI is not rendered. ScreenCI animates the
cursor to the select element, clicks it, and then selects the option
programmatically, but no dropdown will appear on screen.
ScreenCI defaults noWaitAfter to true for the underlying action.
Pass noWaitAfter: false to keep Playwright’s default waiting behavior.
Parameters
Section titled “Parameters”values
Section titled “values”string | ElementHandle<Node> | readonly string[] | { } | readonly ElementHandle<Node>[] | readonly object[] | null
The option(s) to select (value, label, index, or element).
options?
Section titled “options?”ScreenCILocatorSelectOptionOptions
Returns
Section titled “Returns”Promise<string[]>
selectText()
Section titled “selectText()”selectText(
options?):Promise<void>
Selects all text content of the element with an animated cursor move and triple-click animation.
Parameters
Section titled “Parameters”options?
Section titled “options?”ScreenCILocatorSelectTextOptions
Returns
Section titled “Returns”Promise<void>
setChecked()
Section titled “setChecked()”setChecked(
checked,options?):Promise<void>
Sets the checked state of a checkbox or radio element.
Delegates to the instrumented check() or uncheck() based on checked.
ScreenCI defaults noWaitAfter to true for the underlying click.
Pass noWaitAfter: false to keep Playwright’s default waiting behavior.
Parameters
Section titled “Parameters”checked
Section titled “checked”boolean
options?
Section titled “options?”ScreenCILocatorCheckOptions
Returns
Section titled “Returns”Promise<void>
tap(
options?):Promise<void>
Taps the element (touch event).
ScreenCI defaults noWaitAfter to true for this action so the rendered
tap is not delayed by later navigation waits. Pass noWaitAfter: false
to keep Playwright’s default waiting behavior.
Parameters
Section titled “Parameters”options?
Section titled “options?”object & object
Returns
Section titled “Returns”Promise<void>
uncheck()
Section titled “uncheck()”uncheck(
options?):Promise<void>
Unchecks the checkbox.
ScreenCI defaults noWaitAfter to true for the underlying click.
Pass noWaitAfter: false to keep Playwright’s default waiting behavior.
Parameters
Section titled “Parameters”options?
Section titled “options?”ScreenCILocatorCheckOptions
Returns
Section titled “Returns”Promise<void>