その他のロケーター
はじめに
一般的でおすすめのロケーターについては、メインのロケーターガイドをご覧ください。
page.getByRole() や page.getByText() のような推奨ロケーターに加えて、Playwright はこのガイドで説明されているさまざまなロケーターをサポートしています。
CSS ロケーター
実装に結びついており、ページが変更されたときに壊れる可能性のある CSS を使用する代わりに、テキストやアクセシブルロールのようなユーザーに表示されるロケーターを優先することをお勧めします。
Playwright は CSS セレクターによって要素を特定できます。
await 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>
await page.locator(':has-text("Playwright")').click();
// Correct, only matches the <article> element
await page.locator('article:has-text("Playwright")').click(); -
#nav-bar :text("Home")-:text()擬似クラスは、指定されたテキストを含む最小の要素にマッチングします。マッチングでは、大文字と小文字が区別されず、空白がトリムされ、部分文字列が検索されます。たとえば、これは
#nav-bar要素内のどこかにテキスト「Home」を持つ要素を見つけます。await page.locator('#nav-bar :text("Home")').click(); -
#nav-bar :text-is("Home")-:text-is()擬似クラスは、正確なテキストを持つ最小の要素にマッチングします。正確なマッチングでは、大文字と小文字が区別され、空白がトリムされ、完全な文字列が検索されます。たとえば、
:text-is("Log")は<button>Log in</button>にマッチングしません。なぜなら、<button>には"Log"と等しくない単一のテキストノード"Log in"が含まれているからです。ただし、: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>
-
これは両方のボタンを見つけ、厳密性違反エラーをスローします。
await page.locator('button').click(); -
これは 2 番目のボタンのみを見つけ、なぜなら可視であり、それをクリックします。
await page.locator('button:visible').click();
CSS: 他の要素を含む要素
:has() 擬似クラスは、実験的な CSS 擬似クラスです。与えられた要素の :scope に相対的なパラメーターとして渡されたセレクターのいずれかが、少なくとも 1 つの要素にマッチングする場合、要素を返します。
次のスニペットは、内部に <div class=promo> を持つ <article> 要素のテキストコンテンツを返します。
await page.locator('article:has(div.promo)').textContent();
CSS: 条件のいずれかに一致する要素
コンマ区切りの CSS セレクターのリストは、そのリスト内のセレクターの 1 つで選択できるすべての要素にマッチングします。
// Clicks a <button> that has either a "Log in" or "Sign in" text.
await page.locator('button:has-text("Log in"), button:has-text("Sign in")').click();
:is() 擬似クラスは、要素に追加の条件のリストを指定するのに役立つ可能性のある 実験的な CSS 擬似クラスです。
CSS: レイアウトに基づく要素のマッチング
レイアウトに基づくマッチングは、予期しない結果を生み出す可能性があります。たとえば、レイアウトが 1 ピクセル変化すると、異なる要素がマッチングされる可能性があります。
時々、ターゲット要素に特徴的な機能がない場合、ターゲット要素への適切なセレクターを思いつくのが難しい場合があります。この場合、Playwright レイアウト CSS 擬似クラスを使用すると役立つ可能性があります。これらは、複数の選択肢の 1 つを特定するために、通常の 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".
await page.locator('input:right-of(:text("Username"))').fill('value');
// Click a button near the promo card.
await page.locator('button:near(.promo-card)').click();
// Click the radio input in the list closest to the "Label 3".
await 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
await page.locator(':nth-match(:text("Buy"), 3)').click();
:nth-match() は、locator.waitFor() を使用して、指定された数の要素が表示されるまで待機する場合にも役立ちます。
// Wait until all three buttons are visible
await page.locator(':nth-match(:text("Buy"), 3)').waitFor();
:nth-child() とは異なり、要素は兄弟である必要はなく、ページ上のどこにあってもかまいません。上記のコードスニペットでは、3 つのボタンすべてが :text("Buy") セレクターにマッチングし、:nth-match() は 3 番目のボタンを選択します。
N 番目の要素ロケーター
ゼロベースのインデックスを渡す nth= ロケーターを使用して、クエリを n 番目のマッチングに絞り込むことができます。
// Click first button
await page.locator('button').locator('nth=0').click();
// Click last button
await page.locator('button').locator('nth=-1').click();
親要素ロケーター
他の要素の親要素をターゲットにする必要がある場合、ほとんどの場合、子ロケーターで locator.filter() を使用する必要があります。たとえば、次の DOM 構造を考えてみましょう。
<li><label>Hello</label></li>
<li><label>World</label></li>
テキスト "Hello" を持つラベルの親 <li> をターゲットにしたい場合は、locator.filter() を使用するのが最適です。
const child = page.getByText('Hello');
const parent = page.getByRole('listitem').filter({ has: child });
または、親要素の適切なロケーターが見つからない場合は、xpath=.. を使用します。この方法は信頼性が低いことに注意してください。DOM 構造への変更はテストを壊すためです。可能な場合は、locator.filter() を優先してください。
const parent = page.getByText('Hello').locator('xpath=..');
React ロケーター
React ロケーターは実験的であり、_ がプレフィックスとして付いています。機能は将来変更される可能性があります。
React ロケーターを使用すると、コンポーネント名とプロパティ値で要素を検索できます。構文は CSS 属性セレクター と非常によく似ており、すべての CSS 属性セレクター演算子をサポートしています。
React ロケーターでは、コンポーネント名は **CamelCase** で記述されます。
await 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 ロケーターでは、コンポーネント名は **kebab-case** で記述されます。
await 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 を呼び出すことと同等です。
await page.locator('xpath=//button').click();
// または .. で始まる任意のセレクタ文字列は、xpath セレクターであると見なされます。たとえば、Playwright は '//html/body' を 'xpath=//html/body' に変換します。
XPath はシャドウルートを貫通しません。
XPath ユニオン
パイプ演算子 (|) は、XPath で複数のセレクターを指定するために使用できます。リスト内のセレクターの 1 つで選択できるすべての要素にマッチングします。
// Waits for either confirmation dialog or load spinner.
await 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.
await page.getByText('Password').fill('secret');
ただし、他のメソッドはラベル自体をターゲットにします。たとえば、expect(locator).toHaveText() は、入力フィールドではなく、ラベルのテキストコンテンツをアサートします。
// Fill the input by targeting the label.
await expect(page.locator('label')).toHaveText('Password');
レガシーテキストロケーター
代わりに、最新の テキストロケーター をお勧めします。
レガシーテキストロケーターは、渡されたテキストを含む要素にマッチングします。
await page.locator('text=Log in').click();
レガシーテキストロケーターにはいくつかのバリエーションがあります。
-
text=Log in- デフォルトのマッチングでは、大文字と小文字が区別されず、空白がトリムされ、部分文字列が検索されます。たとえば、text=Logは<button>Log in</button>にマッチングします。await page.locator('text=Log in').click(); -
text="Log in"- テキスト本体は、空白をトリムした後、正確なコンテンツを持つテキストノードを検索するために、単一引用符または二重引用符でエスケープできます。たとえば、
text="Log"は<button>Log in</button>にマッチングしません。なぜなら、<button>には"Log"と等しくない単一のテキストノード"Log in"が含まれているからです。ただし、text="Log"は<button> Log <span>in</span></button>にマッチングします。なぜなら、<button>にはテキストノード" Log "が含まれているからです。この正確なモードは、大文字と小文字を区別するマッチングを意味するため、text="Download"は<button>download</button>にマッチングしません。引用符で囲まれた本体は、通常のエスケープルールに従います。例：二重引用符で囲まれた文字列で二重引用符をエスケープするには
\"を使用します。例：text="foo\"bar"。await page.locator('text="Log in"').click(); -
/Log\s*in/i- 本体は、/記号で囲まれた JavaScript の正規表現 にすることができます。たとえば、text=/Log\s*in/iは<button>Login</button>および<button>log IN</button>にマッチングします。await 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"
await page.locator('id=username').fill('value');
// Click an element with data-test-id "submit"
await 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 要素をキャプチャします。