Add Locator.Filter
#5114
Open
Add Locator.Filter
#5114
+312
−13
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
8e19945 to
0bc6686
Compare
79dce26 to
6519119
Compare
503392f to
330386c
Compare
This will be used by the injected_script.js and selectors.go later on to select the elements with a specified text.
The has and has-not engines will use this to evaluate selectors.
This engine selects elements that have the specified text.
It detects the internal selector and prepares it for the injected script. We use TrimQuotes to get rid of the quotes around the selector so that the selector engines can work with the selector. This allow using chainable locator strings: "listitem >> internal:has-text='Product 2'" Which this feature requires.
LocatorFilterOptions embed LocatorOptions, as their options are the same except the `visible` option, which we'll soon add. Their options are similar because `filter` is just a chain operation for locators. See: - https://playwright.dev/docs/api/class-locator#locator-filter - https://playwright.dev/docs/api/class-page#page-locator
We currently only use `LocatorOptions`, but the code is ready to use the `view` option (https://playwright.dev/docs/api/class-locator#locator-filter).
330386c to
6c2d237
Compare
inancgumus
commented
Sep 3, 2025
| @@ -460,13 +495,13 @@ func (l *Locator) innerText(opts *FrameInnerTextOptions) (string, error) { | |||
| // Last will return the last child of the element matching the locator's | |||
| // selector. | |||
| func (l *Locator) Last() *Locator { | |||
| return NewLocator(l.ctx, l.selector+" >> nth=-1", l.frame, l.log) | |||
| return NewLocator(l.ctx, nil, l.selector+" >> nth=-1", l.frame, l.log) | |||
There was a problem hiding this comment.
We don't pass the options here, otherwise, we'd duplicate options when iterating on elements. For example:
page.getByRole('listitem').filter({ hasText: 'foo' }).last()Would produce:
internal:role=listitem >> internal:has-text=foo >> nth=42 >> internal:has-text=fooNow, it produces (matching the PW behavior):
internal:role=listitem >> internal:has-text=foo >> nth=42
6c2d237 to
a23ef68
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What?
Locator.Filterto get a new locator with a selector that filters sub-elements from a set of elements described by another locator on which theFiltermethod is called.locator_filter.jsexample E2E test.Why?
Use
Filtermatches Playwright'sFiltermethod behavior. We currently only supportHasTextandHasNotTextfilters.Given an HTML:
Filter the 2nd item using
hasText:Filter the 1st item using
hasNotTextand a regex:See this document to find more details.
Checklist
make check) and all pass.Checklist: Documentation (only for k6 maintainers and if relevant)
Please do not merge this PR until the following items are filled out.
Related PR(s)/Issue(s)
Closes #5033.