140

Is there any method or solution to click on an element with text? I couldn't find one in the API.

For example I have the following HTML:

<div class="elements">
    <button>Button text</button>
    <a href=#>Href text</a>
    <div>Div text</div>
</div>

And I want to click on an element in which text is wrapped (click on the button inside .elements), like so:

Page.click('Button text', '.elements')
Josh Correia
  • 3,807
  • 3
  • 33
  • 50
Aleksandr Golubovskij
  • 1,493
  • 3
  • 12
  • 9

10 Answers10

182

Short answer

This XPath expression will query a button which contains the text "Button text":

const [button] = await page.$x("//button[contains(., 'Button text')]");
if (button) {
    await button.click();
}

To also respect the <div class="elements"> surrounding the buttons, use the following code:

const [button] = await page.$x("//div[@class='elements']/button[contains(., 'Button text')]");

Explanation

To explain why using the text node (text()) is wrong in some cases, let's look at an example:

<div>
    <button>Start End</button>
    <button>Start <em>Middle</em> End</button>
</div>

First, let's check the results when using contains(text(), 'Text'):

  • //button[contains(text(), 'Start')] will return both two nodes (as expected)
  • //button[contains(text(), 'End')] will only return one nodes (the first) as text() returns a list with two texts (Start and End), but contains will only check the first one
  • //button[contains(text(), 'Middle')] will return no results as text() does not include the text of child nodes

Here are the XPath expressions for contains(., 'Text'), which works on the element itself including its child nodes:

  • //button[contains(., 'Start')] will return both two buttons
  • //button[contains(., 'End')] will again return both two buttons
  • //button[contains(., 'Middle')] will return one (the last button)

So in most cases, it makes more sense to use the . instead of text() in an XPath expression.

lxg
  • 12,375
  • 12
  • 51
  • 73
Thomas Dondorf
  • 23,416
  • 6
  • 84
  • 105
108

You may use a XPath selector with page.$x(expression):

const linkHandlers = await page.$x("//a[contains(text(), 'Some text')]");

if (linkHandlers.length > 0) {
  await linkHandlers[0].click();
} else {
  throw new Error("Link not found");
}

Check out clickByText in this gist for a complete example. It takes care of escaping quotes, which is a bit tricky with XPath expressions.

tokland
  • 66,169
  • 13
  • 144
  • 170
34

You can also use page.evaluate() to click elements obtained from document.querySelectorAll() that have been filtered by text content:

await page.evaluate(() => {
  [...document.querySelectorAll('.elements button')].find(element => element.textContent === 'Button text').click();
});

Alternatively, you can use page.evaluate() to click an element based on its text content using document.evaluate() and a corresponding XPath expression:

await page.evaluate(() => {
  const xpath = '//*[@class="elements"]//button[contains(text(), "Button text")]';
  const result = document.evaluate(xpath, document, null, XPathResult.ANY_TYPE, null);

  result.iterateNext().click();
});
Grant Miller
  • 27,532
  • 16
  • 147
  • 165
19

made quick solution to be able to use advanced css selectors like ":contains(text)"

so using this library you can just

const select = require ('puppeteer-select');

const element = await select(page).getElement('button:contains(Button text)');
await element.click()
user3493381
  • 199
  • 1
  • 2
  • Getting `Evaluation failed: ReferenceError: Sizzle is not defined` when tried to use this `const el = await select(page).getElement('[data-testid="ContextualLayerRoot"] [role="menuitem"] div:contains("Instagram Feed")');` The issue is still open on the github – Sayed Apr 17 '21 at 18:54
7

The solution is

(await page.$$eval(selector, a => a
            .filter(a => a.textContent === 'target text')
))[0].click()
Alex A
  • 95
  • 1
  • 1
6

Here is my solution:

let selector = 'a';
    await page.$$eval(selector, anchors => {
        anchors.map(anchor => {
            if(anchor.textContent == 'target text') {
                anchor.click();
                return
            }
        })
    });
Kamen
  • 61
  • 1
  • 2
  • I'd use `find` or a `for .. of` loop rather than `map` here. `map` in this case allocates, then discards, an array of `undefined` for all `anchors`. Also, the `return` is miseading: `map` will keep going even after it finds the target. Only use `map` if you're going to do something with the return value. – ggorlen Mar 19 '22 at 22:26
2

There is no supported css selector syntax for text selector or a combinator option, my work around for this would be:

await page.$$eval('selector', selectorMatched => {
    for(i in selectorMatched)
      if(selectorMatched[i].textContent === 'text string'){
          selectorMatched[i].click();
          break;//Remove this line (break statement) if you want to click on all matched elements otherwise the first element only is clicked  
        }
    });
Ekeuwei
  • 273
  • 3
  • 7
  • `for(i in selectorMatched)` should be `for (const i in selectorMatched)` to avoid creating a global variable. Also, avoid [`for .. in` to loop arrays](https://stackoverflow.com/questions/500504/why-is-using-for-in-for-array-iteration-a-bad-idea). That syntax is intended for objects. Instead, prefer `for (const element of [...selectorMatched])`. – ggorlen Apr 04 '23 at 22:23
2

Puppeteer 19.7.1 added "p" (pseudo) selectors, so text/ is deprecated in favor of ::-p-text. For example:

const el = await page.waitForSelector("::-p-text(Button text)");

Pseudoselectors can work in conjunction with CSS selectors, like

const el = await page.$(".container button::-p-text(Button text)");

In Puppeteer >= 18.0.0, selectors have a text/ prefix:

const el = await page.waitForSelector("text/Button text");

With regards to XPath specifically:

Since OP's use case appears to be an exact match on the target string "Button text", <button>Button text</button>, text() seems like the correct method rather than the less-precise contains().

Although Thomas makes a good argument for contains when there are sub-elements, avoiding false negatives, using text() avoids a false positive when the button is, say, <button>Button text and more stuff</button>, which seems just as likely a scenario. It's useful to have both tools on hand so you can pick the more appropriate one on a case-by-case basis.

const xp = '//*[@class="elements"]//button[text()="Button text"]';
const [el] = await page.$x(xp);
await el?.click();

Note that many other answers missed the .elements parent class requirement.

Another XPath function is [normalize-space()="Button text"] which "strips leading and trailing white-space from a string, replaces sequences of whitespace characters by a single space" and may be useful for certain cases.

Also, it's often handy to use waitForXPath which waits for, then returns, the element matching the XPath or throws if it's not found within the specified timeout:

const xp = '//*[@class="elements"]//button[text()="Button text"]';
const el = await page.waitForXPath(xp);
await el.click();
ggorlen
  • 44,755
  • 7
  • 76
  • 106
1

With puppeteer 12.0.1, the following works for me:

await page.click("input[value='Opt1']"); //where value is an attribute of the element input
await page.waitForTimeout(1000);

await page.click("li[value='Nested choice 1']"); //where value is an attribute of the element li after clicking the previous option
await page.waitForTimeout(5000);
chinsoon12
  • 25,005
  • 4
  • 25
  • 35
-3

You can just use the query selector.

await page.evaluate(() => {
    document.querySelector('input[type=button]').click();
});

Edits ----

You can give your button a className and use that to select the button element since you know exactly what you're trying to click:

await page.evaluate(() => {
    document.querySelector('.button]').click();
});
Esther
  • 1
  • 1