その他のロケーター
はじめに
最も一般的でおすすめのロケーターについては、メインのロケーターガイドをご覧ください。
Page.getByRole() や Page.getByText() のような推奨されるロケーターに加えて、Playwright はこのガイドで説明されているさまざまなその他のロケーターをサポートしています。
CSS ロケーター
ページが変更されたときに実装に結びついていて壊れる可能性のある CSS を使用する代わりに、テキストやアクセシブルなロールのようなユーザーに見えるロケーターを優先することをお勧めします。
Playwright は CSS セレクターで要素を特定できます。
page.locator("css=button").click();
Playwright は標準の CSS セレクターを 2 つの方法で拡張します
- 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>に一致します。
テキストマッチングは常に空白を正規化します。たとえば、複数のスペースを 1 つに変換し、改行をスペースに変換し、先頭と末尾の空白を無視します。
button および submit タイプの入力要素は、テキストコンテンツの代わりに value によって一致します。たとえば、:text("Log in") は <input type=button value="Log in"> に一致します。
CSS: 可視要素のみをマッチング
Playwright は CSS セレクターで :visible 疑似クラスをサポートしています。たとえば、css=button はページ上のすべてのボタンに一致しますが、css=button:visible は可視ボタンのみに一致します。これは、非常によく似ているが可視性が異なる要素を区別するのに役立ちます。
最初に非表示、次に表示される 2 つのボタンがあるページを考えます。
<button style='display: none'>Invisible</button>
<button>Visible</button>
-
これは両方のボタンを見つけ、厳密性違反エラーをスローします
page.locator("button").click(); -
これは 2 番目のボタンのみを見つけ、それが可視であるため、クリックします。
page.locator("button:visible").click();
CSS: 他の要素を含む要素
:has() 疑似クラスは、実験的な CSS 疑似クラスです。パラメーターとして渡されたセレクターのいずれかが、与えられた要素の :scope を基準にして少なくとも 1 つの要素に一致する場合、要素を返します。
次のスニペットは、内部に <div class=promo> を持つ <article> 要素のテキストコンテンツを返します。
page.locator("article:has(div.promo)").textContent();
CSS: 条件の 1 つに一致する要素
コンマ区切りの CSS セレクターのリストは、そのリスト内のセレクターの 1 つで選択できるすべての要素に一致します。
// 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: レイアウトに基づく要素のマッチング
レイアウトに基づくマッチングは、予期しない結果を生み出す可能性があります。たとえば、レイアウトが 1 ピクセル変化すると、異なる要素が一致する可能性があります。
特徴的な機能がない場合、ターゲット要素に適したセレクターを思い付くのが難しい場合があります。この場合、Playwright レイアウト CSS 疑似クラスが役立つ可能性があります。これらは、通常の CSS と組み合わせて、複数の選択肢の中から 1 つを特定できます。
たとえば、input:right-of(:text("Password")) は、「Password」というテキストの右側にある入力フィールドに一致します。これは、相互に区別するのが難しい複数の入力がある場合に役立ちます。
レイアウト疑似クラスは、input のような他の何かに追加する場合に役立つことに注意してください。:right-of(:text("Password")) のようにレイアウト疑似クラスを単独で使用すると、探している入力ではなく、テキストとターゲット入力の間の空の要素が最も可能性が高くなります。
レイアウト疑似クラスは、要素の距離と相対位置を計算するために getBoundingClientRect を使用します。
: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) は上記のスニペットから 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() とは異なり、要素は兄弟である必要はなく、ページ上のどこにあってもかまいません。上記のスニペットでは、3 つのボタンすべてが :text("Buy") セレクターに一致し、:nth-match() は 3 番目のボタンを選択します。
N 番目の要素ロケーター
nth= ロケーターに 0 から始まるインデックスを渡すことで、クエリを 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 ロケーターでは、コンポーネント名はキャメルケースで記述されます。
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"] - コンポーネントとキーで一致:
_react=BookItem[key = '2'] - プロパティ値の正規表現で一致:
_react=[author = /Steven(\\s+King)?/i]
ツリー内の React 要素名を見つけるには、React DevTools を使用します。
React ロケーターは React 15 以降をサポートしています。
React ロケーターは、React DevTools と同様に、minify されていないアプリケーションビルドに対してのみ機能します。
Vue ロケーター
Vue ロケーターは実験的であり、_ がプレフィックスとして付いています。機能は将来変更される可能性があります。
Vue ロケーターを使用すると、コンポーネント名とプロパティ値で要素を見つけることができます。構文は CSS 属性セレクターと非常によく似ており、すべての CSS 属性セレクター演算子をサポートしています。
Vue ロケーターでは、コンポーネント名はケバブケースで記述されます。
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 と同様に、minify されていないアプリケーションビルドに対してのみ機能します。
XPath ロケーター
ページが変更されたときに実装に結びついていて簡単に壊れる XPath を使用する代わりに、テキストやアクセシブルなロールのようなユーザーに見えるロケーターを優先することをお勧めします。
XPath ロケーターは、Document.evaluate を呼び出すことと同等です。
page.locator("xpath=//button").click();
// または .. で始まるセレクター文字列は、xpath セレクターと見なされます。たとえば、Playwright は '//html/body' を 'xpath=//html/body' に変換します。
XPath はシャドウルートを貫通しません。
XPath ユニオン
パイプ演算子 (|) を使用して、XPath で複数のセレクターを指定できます。リスト内のセレクターの 1 つで選択できるすべての要素に一致します。
// 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」テキストでラベルをターゲットにできます。ただし、次のアクションはラベルではなく入力で実行されます
- Locator.click() はラベルをクリックし、自動的に入力フィールドにフォーカスを当てます。
- Locator.fill() は入力フィールドに入力します。
- Locator.inputValue() は入力フィールドの値を返します。
- Locator.selectText() は入力フィールド内のテキストを選択します。
- Locator.setInputFiles() は
type=fileの入力フィールドのファイルを設定します。 - Locator.selectOption() はセレクトボックスからオプションを選択します。
// 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" に変換されます。
マッチングは常に空白を正規化します。たとえば、複数のスペースを 1 つに変換し、改行をスペースに変換し、先頭と末尾の空白を無視します。
button および submit タイプの入力要素は、テキストコンテンツの代わりに value によって一致します。たとえば、text=Log in は <input type=button value="Log in"> に一致します。
id、data-testid、data-test-id、data-test セレクター
代わりに、テスト ID でロケーターを使用することをお勧めします。
Playwright は、特定の属性を使用して要素を選択するための短縮形をサポートしています。現在、次の属性のみがサポートされています
iddata-testiddata-test-iddata-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 セレクターではないため、:enabled のような CSS 固有のものはサポートされていません。より多くの機能については、適切な 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 要素をキャプチャします。