跳到主要內容

其他定位器

簡介​

注意

查看主要的定位器指南，以取得最常見和推薦的定位器。

除了推薦的定位器，例如 Page.getByRole() 和 Page.getByText()，Playwright 還支援本指南中描述的各種其他定位器。

CSS 定位器​

注意

我們建議優先使用使用者可見的定位器，例如文字或可訪問的角色，而不是使用與實作相關聯的 CSS，這些 CSS 可能在頁面變更時中斷。

Playwright 可以通過 CSS 選擇器定位元素。

page.locator("css=button").click();

Playwright 以兩種方式擴充了標準 CSS 選擇器

  • CSS 選擇器會穿透開放式陰影 DOM。
  • Playwright 新增了自訂虛擬類別，例如 :visible、:has-text()、:has()、:is()、:nth-match() 等等。

CSS：依文字比對​

Playwright 包含許多 CSS 虛擬類別，可依元素的文字內容比對元素。

  • article:has-text("Playwright") - :has-text() 比對任何元素，該元素在內部某處（可能在子元素或後代元素中）包含指定的文字。比對不區分大小寫、修剪空格並搜尋子字串。

    例如，article:has-text("Playwright") 比對 <article><div>Playwright</div></article>。

    請注意，:has-text() 應與其他 CSS 指定符一起使用，否則它將比對包含指定文字的所有元素，包括 <body>。

    // Wrong, will match many elements including <body>
    page.locator(":has-text(\"Playwright\")").click();
    // Correct, only matches the <article> element
    page.locator("article:has-text(\"Playwright\")").click();

  • #nav-bar :text("Home") - :text() 虛擬類別比對包含指定文字的最小元素。比對不區分大小寫、修剪空格並搜尋子字串。

    例如，這將在 #nav-bar 元素內某處找到帶有文字 "Home" 的元素

    page.locator("#nav-bar :text('Home')").click();

  • #nav-bar :text-is("Home") - :text-is() 虛擬類別比對具有完全相同文字的最小元素。完全比對區分大小寫、修剪空格並搜尋完整字串。

    例如，:text-is("Log") 不比對 <button>Log in</button>，因為 <button> 包含單個文字節點 "Log in"，該節點不等於 "Log"。但是，:text-is("Log") 比對 <button> Log <span>in</span></button>，因為 <button> 包含文字節點 " Log "。

    同樣地，:text-is("Download") 將不比對 <button>download</button>，因為它是區分大小寫的。

  • #nav-bar :text-matches("reg?ex", "i") - :text-matches() 虛擬類別比對文字內容與類似 JavaScript 的正規表示式比對的最小元素。

    例如，:text-matches("Log\s*in", "i") 比對 <button>Login</button> 和 <button>log IN</button>。

注意

文字比對始終正規化空格。例如，它將多個空格變成一個空格，將換行符號變成空格，並忽略前導和尾隨空格。

注意

button 和 submit 類型的輸入元素會依其 value 而不是文字內容進行比對。例如，:text("Log in") 比對 <input type=button value="Log in">。

CSS：僅比對可見元素​

Playwright 在 CSS 選擇器中支援 :visible 虛擬類別。例如，css=button 比對頁面上的所有按鈕，而 css=button:visible 僅比對可見的按鈕。這對於區分非常相似但在可見性方面不同的元素很有用。

考慮一個包含兩個按鈕的頁面，第一個按鈕不可見，第二個按鈕可見。

<button style='display: none'>Invisible</button>
<button>Visible</button>

  • 這將找到兩個按鈕並拋出嚴格模式違規錯誤

    page.locator("button").click();

  • 這將僅找到第二個按鈕，因為它是可見的，然後點擊它。

    page.locator("button:visible").click();

CSS：包含其他元素的元素​

:has() 虛擬類別是實驗性 CSS 虛擬類別。如果作為參數傳遞的任何選擇器相對於給定元素的 :scope 比對至少一個元素，則它會傳回元素。

以下程式碼片段傳回內部具有 <div class=promo> 的 <article> 元素的文字內容。

page.locator("article:has(div.promo)").textContent();

CSS：比對條件之一的元素​

逗號分隔的 CSS 選擇器清單將比對可以由該清單中選擇器之一選取的所有元素。

// Clicks a <button> that has either a "Log in" or "Sign in" text.
page.locator("button:has-text(\"Log in\"), button:has-text(\"Sign in\")").click();

:is() 虛擬類別是實驗性 CSS 虛擬類別，可用於指定元素上額外條件的清單。

CSS：依版面配置比對元素​

注意

依版面配置比對可能會產生意外的結果。例如，當版面配置變更一個像素時，可能會比對到不同的元素。

有時，當目標元素缺少獨特的功能時，很難想出一個好的選擇器。在這種情況下，使用 Playwright 版面配置 CSS 虛擬類別可能會有所幫助。這些可以與常規 CSS 結合使用，以精確找出多個選項之一。

例如，input:right-of(:text("Password")) 比對位於文字 "Password" 右側的輸入欄位 - 當頁面有多個難以區分的輸入時很有用。

請注意，版面配置虛擬類別除了 input 之類的東西之外，也很有用。如果您單獨使用版面配置虛擬類別，例如 :right-of(:text("Password"))，則很可能您將獲得的不是您要尋找的輸入，而是一些位於文字和目標輸入之間的空白元素。

版面配置虛擬類別使用 bounding client rect 來計算元素的距離和相對位置。

  • :right-of(div > button) - 比對位於比對內部選擇器的任何元素右側的元素，位於任何垂直位置。
  • :left-of(div > button) - 比對位於比對內部選擇器的任何元素左側的元素，位於任何垂直位置。
  • :above(div > button) - 比對位於比對內部選擇器的任何元素上方的元素，位於任何水平位置。
  • :below(div > button) - 比對位於比對內部選擇器的任何元素下方的元素，位於任何水平位置。
  • :near(div > button) - 比對靠近（在 50 CSS 像素內）比對內部選擇器的任何元素的元素。

請注意，產生的比對會依其與錨點元素的距離排序，因此您可以使用 Locator.first() 來選取最接近的一個。這僅在您有類似元素清單之類的東西時才有用，其中最接近的顯然是正確的元素。但是，在其他情況下使用 Locator.first() 最有可能無法按預期運作 - 它不會以您要搜尋的元素為目標，而是以碰巧最接近的其他元素為目標，例如隨機的空白 <div>，或捲動出且目前不可見的元素。

// Fill an input to the right of "Username".
page.locator("input:right-of(:text(\"Username\"))").fill("value");

// Click a button near the promo card.
page.locator("button:near(.promo-card)").click();

// Click the radio input in the list closest to the "Label 3".
page.locator("[type=radio]:left-of(:text(\"Label 3\"))").first().click();

所有版面配置虛擬類別都支援選用的最大像素距離作為最後一個引數。例如，button:near(:text("Username"), 120) 比對一個按鈕，該按鈕與文字 "Username" 的元素相距最多 120 CSS 像素。

CSS：從查詢結果中選取第 n 個比對​

注意

通常可以通過某些屬性或文字內容來區分元素，這對於頁面變更更具彈性。

有時，頁面包含許多相似的元素，並且很難選取特定的元素。例如

<section> <button>Buy</button> </section>
<article><div> <button>Buy</button> </div></article>
<div><div> <button>Buy</button> </div></div>

在這種情況下，:nth-match(:text("Buy"), 3) 將從上面的程式碼片段中選取第三個按鈕。請注意，索引是以 1 為基礎的。

// Click the third "Buy" button
page.locator(":nth-match(:text('Buy'), 3)").click();

:nth-match() 也可用於等待指定的元素數量出現，使用 Locator.waitFor()。

// Wait until all three buttons are visible
page.locator(":nth-match(:text('Buy'), 3)").waitFor();
注意

與 :nth-child() 不同，元素不必是同級元素，它們可以位於頁面上的任何位置。在上面的程式碼片段中，所有三個按鈕都比對 :text("Buy") 選擇器，而 :nth-match() 選取第三個按鈕。

第 N 個元素定位器​

您可以使用傳遞以零為基礎的索引的 nth= 定位器，將查詢範圍縮小到第 n 個比對。

// Click first button
page.locator("button").locator("nth=0").click();

// Click last button
page.locator("button").locator("nth=-1").click();

父元素定位器​

當您需要以某些其他元素的父元素為目標時，大多數時候您應該依子定位器Locator.filter()。例如，考慮以下 DOM 結構

<li><label>Hello</label></li>
<li><label>World</label></li>

如果您想以文字為 "Hello" 的標籤的父 <li> 為目標，則使用 Locator.filter() 的效果最佳

Locator child = page.getByText("Hello");
Locator parent = page.getByRole(AriaRole.LISTITEM).filter(new Locator.FilterOptions().setHas(child));

或者，如果您找不到適合父元素的定位器，請使用 xpath=..。請注意，此方法不如可靠，因為對 DOM 結構的任何變更都會破壞您的測試。如果可以，請優先使用 Locator.filter()。

Locator parent = page.getByText("Hello").locator("xpath=..");

React 定位器​

注意

React 定位器是實驗性的，並以 _ 為前綴。此功能在未來可能會變更。

React 定位器允許依其元件名稱和屬性值尋找元素。語法與CSS 屬性選擇器非常相似，並支援所有 CSS 屬性選擇器運算子。

在 React 定位器中，元件名稱以 CamelCase 轉錄。

page.locator("_react=BookItem").click();

更多範例

  • 依元件比對：_react=BookItem
  • 依元件和完全屬性值比對，區分大小寫：_react=BookItem[author = "Steven King"]
  • 僅依屬性值比對，不區分大小寫：_react=[author = "steven king" i]
  • 依元件和真值屬性值比對：_react=MyButton[enabled]
  • 依元件和布林值比對：_react=MyButton[enabled = false]
  • 依屬性值子字串比對：_react=[author *= "King"]
  • 依元件和多個屬性比對：_react=BookItem[author *= "king" i][year = 1990]
  • 依巢狀屬性值比對：_react=[some.nested.value = 12]
  • 依元件和屬性值前綴比對：_react=BookItem[author ^= "Steven"]
  • 依元件和屬性值後綴比對：_react=BookItem[author $= "Steven"]
  • 依元件和 key 比對：_react=BookItem[key = '2']
  • 依屬性值正規表示式比對：_react=[author = /Steven(\\s+King)?/i]

若要在樹狀結構中尋找 React 元素名稱，請使用 React DevTools。

注意

React 定位器支援 React 15 及更高版本。

注意

React 定位器以及 React DevTools 僅適用於 未縮減 的應用程式組建。

Vue 定位器​

注意

Vue 定位器是實驗性的，並以 _ 為前綴。此功能在未來可能會變更。

Vue 定位器允許依其元件名稱和屬性值尋找元素。語法與CSS 屬性選擇器非常相似，並支援所有 CSS 屬性選擇器運算子。

在 Vue 定位器中，元件名稱以 kebab-case 轉錄。

page.locator("_vue=book-item").click();

更多範例

  • 依元件比對：_vue=book-item
  • 依元件和完全屬性值比對，區分大小寫：_vue=book-item[author = "Steven King"]
  • 僅依屬性值比對，不區分大小寫：_vue=[author = "steven king" i]
  • 依元件和真值屬性值比對：_vue=my-button[enabled]
  • 依元件和布林值比對：_vue=my-button[enabled = false]
  • 依屬性值子字串比對：_vue=[author *= "King"]
  • 依元件和多個屬性比對：_vue=book-item[author *= "king" i][year = 1990]
  • 依巢狀屬性值比對：_vue=[some.nested.value = 12]
  • 依元件和屬性值前綴比對：_vue=book-item[author ^= "Steven"]
  • 依元件和屬性值後綴比對：_vue=book-item[author $= "Steven"]
  • 依屬性值正規表示式比對：_vue=[author = /Steven(\\s+King)?/i]

若要在樹狀結構中尋找 Vue 元素名稱，請使用 Vue DevTools。

注意

Vue 定位器支援 Vue2 及更高版本。

注意

Vue 定位器以及 Vue DevTools 僅適用於 未縮減 的應用程式組建。

XPath 定位器​

警告

我們建議優先使用使用者可見的定位器，例如文字或可訪問的角色，而不是使用與實作相關聯的 XPath，這些 XPath 可能在頁面變更時輕易中斷。

XPath 定位器等效於呼叫 Document.evaluate。

page.locator("xpath=//button").click();
注意

任何以 // 或 .. 開頭的選擇器字串都假定為 xpath 選擇器。例如，Playwright 會將 '//html/body' 轉換為 'xpath=//html/body'。

注意

XPath 不會穿透陰影根。

XPath 聯集​

管道運算子 (|) 可用於在 XPath 中指定多個選擇器。它將比對可以由該清單中選擇器之一選取的所有元素。

// Waits for either confirmation dialog or load spinner.
page.locator("//span[contains(@class, 'spinner__loading')]|//div[@id='confirmation']").waitFor();

標籤到表單控制項重新定向​

警告

我們建議依標籤文字定位，而不是依賴標籤到控制項的重新定向。

Playwright 中的目標輸入動作會自動區分標籤和控制項，因此您可以以標籤為目標，以對相關聯的控制項執行動作。

例如，考慮以下 DOM 結構：<label for="password">Password:</label><input id="password" type="password">。您可以使用 Page.getByText() 依其 "Password" 文字以標籤為目標。但是，以下動作將在輸入而不是標籤上執行

// Fill the input by targeting the label.
page.getByText("Password").fill("secret");

但是，其他方法將以標籤本身為目標，例如 assertThat(locator).hasText() 將斷言標籤的文字內容，而不是輸入欄位。

// Fill the input by targeting the label.
assertThat(page.locator("label")).hasText("Password");

舊版文字定位器​

警告

我們建議使用現代文字定位器。

舊版文字定位器比對包含傳遞文字的元素。

page.locator("text=Log in").click();

舊版文字定位器有幾個變體

  • text=Log in - 預設比對不區分大小寫、修剪空格並搜尋子字串。例如，text=Log 比對 <button>Log in</button>。

    page.locator("text=Log in").click();

  • text="Log in" - 可以使用單引號或雙引號逸出文字主體，以搜尋具有修剪空格後完全相同內容的文字節點。

    例如，text="Log" 不比對 <button>Log in</button>，因為 <button> 包含單個文字節點 "Log in"，該節點不等於 "Log"。但是，text="Log" 比對 <button> Log <span>in</span></button>，因為 <button> 包含文字節點 " Log "。此完全模式表示區分大小寫的比對，因此 text="Download" 將不比對 <button>download</button>。

    引號括住的主體遵循慣用的逸出規則，例如，使用 \" 來逸出雙引號字串中的雙引號：text="foo\"bar"。

    page.locator("text='Log in'").click();

  • /Log\s*in/i - 主體可以是包裝在 / 符號中的類似 JavaScript 的正規表示式。例如，text=/Log\s*in/i 比對 <button>Login</button> 和 <button>log IN</button>。

    page.locator("text=/Log\\s*in/i").click();
注意

以引號（" 或 '）開頭和結尾的字串選擇器假定為舊版文字定位器。例如，"Log in" 會在內部轉換為 text="Log in"。

注意

比對始終正規化空格。例如，它將多個空格變成一個空格，將換行符號變成空格，並忽略前導和尾隨空格。

注意

button 和 submit 類型的輸入元素會依其 value 而不是文字內容進行比對。例如，text=Log in 比對 <input type=button value="Log in">。

id、data-testid、data-test-id、data-test 選擇器​

警告

我們建議依測試 ID 定位。

Playwright 支援使用某些屬性選取元素的簡寫。目前，僅支援以下屬性

  • id
  • data-testid
  • data-test-id
  • data-test
// Fill an input with the id "username"
page.locator("id=username").fill("value");

// Click an element with data-test-id "submit"
page.locator("data-test-id=submit").click();
注意

屬性選擇器不是 CSS 選擇器，因此不支援任何特定於 CSS 的內容，例如 :enabled。如需更多功能，請使用正確的 css 選擇器，例如 css=[data-test="login"]:enabled。

鏈結選擇器​

警告

我們建議改用鏈結定位器。

定義為 engine=body 或簡短格式的選擇器可以與 >> 符號組合，例如 selector1 >> selector2 >> selectors3。當選擇器鏈結在一起時，下一個選擇器是相對於前一個選擇器的結果查詢的。

例如，

css=article >> css=.bar > .baz >> css=span[attr=value]

等效於

document
    .querySelector('article')
    .querySelector('.bar > .baz')
    .querySelector('span[attr=value]');

如果選擇器需要在主體中包含 >>，則應在字串內逸出，以免與鏈結分隔符號混淆，例如 text="some >> text"。

中繼比對​

警告

我們建議依另一個定位器篩選，以定位包含其他元素的元素。

預設情況下，鏈結選擇器會解析為由最後一個選擇器查詢的元素。選擇器可以加上 * 前綴，以擷取由中繼選擇器查詢的元素。

例如，css=article >> text=Hello 擷取具有文字 Hello 的元素，而 *css=article >> text=Hello（請注意 *）擷取包含文字 Hello 的某些元素的 article 元素。