メインコンテンツにスキップ

その他のロケーター

はじめに​

注

よく使用され推奨されるロケーターについては、メインのロケーターガイドをご覧ください。

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」とは異なる単一のテキストノード「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つのボタンがあるページを考えます。1つ目は非表示で、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: いずれかの条件にマッチする要素​

カンマ区切りの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: レイアウトに基づく要素のマッチング​

注

レイアウトに基づくマッチングは予期せぬ結果を生む可能性があります。例えば、レイアウトが1ピクセル変わるだけで、別の要素がマッチする可能性があります。

特徴的な機能を持たないターゲット要素に対して、良いセレクターを考案するのが難しい場合があります。この場合、PlaywrightのレイアウトCSS疑似クラスを使用すると役立ちます。これらは通常のCSSと組み合わせて、複数の選択肢の中から1つを正確に特定できます。

例えば、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) - 内部セレクターにマッチする任意の要素の近く（50CSSピクセル以内）にある要素にマッチします。

結果として得られるマッチはアンカー要素からの距離でソートされるため、最も近いものを選択するために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」というテキストを持つ要素から最大120CSSピクセル離れたボタンにマッチします。

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=ロケーターを使用すると、クエリを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]
  • コンポーネントとtruthyなプロパティ値でマッチ: _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と同様に、unminifiedなアプリケーションビルドでのみ動作します。

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]
  • コンポーネントとtruthyなプロパティ値でマッチ: _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と同様に、unminifiedなアプリケーションビルドでのみ動作します。

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」と等しくない単一のテキストノード「Log in」が含まれているからです。しかし、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は、特定の属性を使用して要素を選択するための省略形をサポートしています。現在、以下の属性のみがサポートされています。

  • 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セレクターではないため、: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要素をキャプチャします。