Locator

ロケーターは、Playwright の自動待機および再試行機能の中心となるものです。要するに、ロケーターは、ページ上の要素をいつでも見つける方法を表します。ロケーターは、Page.locator() メソッドで作成できます。

ロケーターについて詳しく知る.

メソッド

all

追加バージョン: v1.29

locator.all

ロケーターが要素のリストを指す場合、これはそれぞれの要素を指すロケーターの配列を返します。

注

Locator.all() は、要素がロケーターに一致するのを待たずに、ページに存在するものを即座に返します。

要素のリストが動的に変化する場合、Locator.all() は予測不能で不安定な結果を生成します。

要素のリストが安定しているものの動的に読み込まれる場合は、Locator.all() を呼び出す前に、リスト全体が読み込みを完了するのを待ってください。

使用方法

for (Locator li : page.getByRole("listitem").all())
  li.click();

戻り値

List<Locator>#

allInnerTexts

追加バージョン: v1.14

locator.allInnerTexts

一致するすべてのノードの node.innerText 値の配列を返します。

テキストのアサーション

ページ上のテキストをアサートする必要がある場合は、不安定さを避けるために、assertThat(locator).hasText() を setUseInnerText オプションと共に使用することをお勧めします。アサーションガイドで詳細を参照してください。

使用方法

String[] texts = page.getByRole(AriaRole.LINK).allInnerTexts();

戻り値

List<String>#

allTextContents

追加バージョン: v1.14

locator.allTextContents

一致するすべてのノードの node.textContent 値の配列を返します。

テキストのアサーション

ページ上のテキストをアサートする必要がある場合は、不安定さを避けるために assertThat(locator).hasText() を使用することをお勧めします。アサーションガイドで詳細を参照してください。

使用方法

String[] texts = page.getByRole(AriaRole.LINK).allTextContents();

戻り値

List<String>#

and

追加バージョン: v1.34

locator.and

このロケーターと引数ロケーターの両方に一致するロケーターを作成します。

使用方法

次の例は、特定のタイトルを持つボタンを検索します。

Locator button = page.getByRole(AriaRole.BUTTON).and(page.getByTitle("Subscribe"));

引数

locator Locator #

一致させる追加のロケーター。

戻り値

Locator #

ariaSnapshot

追加バージョン: v1.49

locator.ariaSnapshot

指定された要素のARIAスナップショットをキャプチャします。ARIAスナップショットおよび対応するアサーションについては、assertThat(locator).matchesAriaSnapshot() を参照してください。

使用方法

page.getByRole(AriaRole.LINK).ariaSnapshot();

引数

options Locator.AriaSnapshotOptions (任意)
- setRef boolean (任意)追加バージョン: v1.52#
  
  各要素のシンボリックリファレンスを生成します。スナップショットをキャプチャした直後に aria-ref=<ref> ロケーターを使用して、要素に対するアクションを実行できます。
- setTimeout double (任意)#
  
  ミリ秒単位の最大時間。デフォルトは 30000 (30秒) です。0 を渡すとタイムアウトを無効にします。デフォルト値は BrowserContext.setDefaultTimeout() または Page.setDefaultTimeout() メソッドを使用して変更できます。

戻り値

String #

詳細

このメソッドは、指定された要素のARIAスナップショットをキャプチャします。スナップショットは、要素とその子の状態を表す文字列です。スナップショットは、テストで要素の状態をアサートするため、または将来の状態と比較するために使用できます。

ARIAスナップショットはYAMLマークアップ言語を使用して表現されます。

オブジェクトのキーは、要素のロールとオプションのアクセシブルネームです。
値はテキストコンテンツか子要素の配列です。
一般的な静的テキストは text キーで表現できます。

以下はHTMLマークアップとそれぞれのARIAスナップショットです。

<ul aria-label="Links">
  <li><a href="/">Home</a></li>
  <li><a href="/about">About</a></li>
<ul>

- list "Links":
  - listitem:
    - link "Home"
  - listitem:
    - link "About"

blur

追加バージョン: v1.28

locator.blur

要素に対して blur を呼び出します。

使用方法

Locator.blur();
Locator.blur(options);

引数

options Locator.BlurOptions (任意)
- setTimeout double (任意)#
  
  ミリ秒単位の最大時間。デフォルトは 30000 (30秒) です。0 を渡すとタイムアウトを無効にします。デフォルト値は BrowserContext.setDefaultTimeout() または Page.setDefaultTimeout() メソッドを使用して変更できます。

戻り値

void #

boundingBox

追加バージョン: v1.14

locator.boundingBox

このメソッドは、ロケーターに一致する要素のバウンディングボックスを返します。要素が非表示の場合は null を返します。バウンディングボックスはメインフレームのビューポートを基準に計算されます。これは通常、ブラウザウィンドウと同じです。

使用方法

BoundingBox box = page.getByRole(AriaRole.BUTTON).boundingBox();
page.mouse().click(box.x + box.width / 2, box.y + box.height / 2);

引数

options Locator.BoundingBoxOptions (任意)
- setTimeout double (任意)#
  
  ミリ秒単位の最大時間。デフォルトは 30000 (30秒) です。0 を渡すとタイムアウトを無効にします。デフォルト値は BrowserContext.setDefaultTimeout() または Page.setDefaultTimeout() メソッドを使用して変更できます。

戻り値

null | BoundingBox#
- x double
  
  要素のX座標（ピクセル単位）。
- y double
  
  要素のY座標（ピクセル単位）。
- width double
  
  要素の幅（ピクセル単位）。
- height double
  
  要素の高さ（ピクセル単位）。

詳細

スクロールは、Element.getBoundingClientRect と同様に、返されるバウンディングボックスに影響します。これは、x および/または y が負になる可能性があることを意味します。

子フレームの要素は、Element.getBoundingClientRect とは異なり、メインフレームを基準としたバウンディングボックスを返します。

ページが静的であると仮定すると、バウンディングボックスの座標を使用して入力を実行しても安全です。たとえば、次のスニペットは要素の中心をクリックするはずです。

check

追加バージョン: v1.14

locator.check

チェックボックスまたはラジオ要素がチェックされていることを確認します。

使用方法

page.getByRole(AriaRole.CHECKBOX).check();

引数

options Locator.CheckOptions (任意)
- setForce boolean (任意)#
  
  アクション可能性チェックをバイパスするかどうか。デフォルトは false です。
- setNoWaitAfter boolean (任意)#
  
  非推奨
  このオプションは効果がありません。
  
  このオプションは効果がありません。
- setPosition Position (任意)#
  - setX double
  - setY double
  要素のパディングボックスの左上隅を基準に使用する点。指定されていない場合は、要素の表示可能な点のいずれかが使用されます。
- setTimeout double (任意)#
  
  ミリ秒単位の最大時間。デフォルトは 30000 (30秒) です。0 を渡すとタイムアウトを無効にします。デフォルト値は BrowserContext.setDefaultTimeout() または Page.setDefaultTimeout() メソッドを使用して変更できます。
- setTrial boolean (任意)#
  
  設定すると、このメソッドはアクション可能性チェックのみを実行し、アクションはスキップします。デフォルトは false です。アクションを実行せずに要素がアクションの準備が整うまで待機するのに便利です。

戻り値

void #

詳細

次のステップを実行します

要素がチェックボックスまたはラジオ入力であることを確認します。そうでない場合、このメソッドは例外をスローします。要素が既にチェックされている場合、このメソッドはすぐに戻ります。
setForce オプションが設定されていない限り、要素に対するアクション可能性チェックを待ちます。
必要に応じて、要素をビューにスクロールします。
要素の中央をクリックするために Page.mouse() を使用します。
要素が現在チェックされていることを確認します。そうでない場合、このメソッドは例外をスローします。

アクション中に要素がDOMからデタッチされた場合、このメソッドは例外をスローします。

指定された setTimeout 中にすべてのステップが完了しない場合、このメソッドは TimeoutError をスローします。タイムアウトをゼロにすると、これを無効にします。

clear

追加バージョン: v1.28

locator.clear

入力フィールドをクリアします。

使用方法

page.getByRole(AriaRole.TEXTBOX).clear();

引数

options Locator.ClearOptions (任意)
- setForce boolean (任意)#
  
  アクション可能性チェックをバイパスするかどうか。デフォルトは false です。
- setNoWaitAfter boolean (任意)#
  
  非推奨
  このオプションは効果がありません。
  
  このオプションは効果がありません。
- setTimeout double (任意)#
  
  ミリ秒単位の最大時間。デフォルトは 30000 (30秒) です。0 を渡すとタイムアウトを無効にします。デフォルト値は BrowserContext.setDefaultTimeout() または Page.setDefaultTimeout() メソッドを使用して変更できます。

戻り値

void #

詳細

このメソッドは、アクション可能性チェックを待ち、要素にフォーカスし、クリアして、クリア後に input イベントをトリガーします。

ターゲット要素が <input>、<textarea>、または [contenteditable] 要素でない場合、このメソッドはエラーをスローします。ただし、要素が関連付けられたコントロールを持つ <label> 要素内にある場合は、代わりにそのコントロールがクリアされます。

click

追加バージョン: v1.14

locator.click

要素をクリックします。

使用方法

ボタンをクリック

page.getByRole(AriaRole.BUTTON).click();

キャンバス上の特定の位置でShiftキーを押しながら右クリック

page.locator("canvas").click(new Locator.ClickOptions()
  .setButton(MouseButton.RIGHT)
  .setModifiers(Arrays.asList(KeyboardModifier.SHIFT))
  .setPosition(23, 32));

引数

options Locator.ClickOptions (任意)
- setButton enum MouseButton { LEFT, RIGHT, MIDDLE } (任意)#
  
  デフォルトは left です。
- setClickCount int (任意)#
  
  デフォルトは1です。UIEvent.detail を参照してください。
- setDelay double (任意)#
  
  mousedown と mouseup の間の待機時間（ミリ秒単位）。デフォルトは0です。
- setForce boolean (任意)#
  
  アクション可能性チェックをバイパスするかどうか。デフォルトは false です。
- setModifiers List<enum KeyboardModifier { ALT, CONTROL, CONTROLORMETA, META, SHIFT }> (任意)#
  
  押す修飾キー。操作中はこれらの修飾キーのみが押され、その後現在の修飾キーが元に戻ることを保証します。指定されていない場合、現在押されている修飾キーが使用されます。「ControlOrMeta」は、WindowsおよびLinuxでは「Control」に、macOSでは「Meta」に解決されます。
- setNoWaitAfter boolean (任意)#
  
  非推奨
  このオプションは将来的にデフォルトで true になります。
  
  ナビゲーションを開始するアクションは、これらのナビゲーションが発生し、ページの読み込みが開始されるのを待ちます。このフラグを設定することで、待機をオプトアウトできます。このオプションは、アクセスできないページへのナビゲーションなどの例外的な場合にのみ必要です。デフォルトは false です。
- setPosition Position (任意)#
  - setX double
  - setY double
  要素のパディングボックスの左上隅を基準に使用する点。指定されていない場合は、要素の表示可能な点のいずれかが使用されます。
- setTimeout double (任意)#
  
  ミリ秒単位の最大時間。デフォルトは 30000 (30秒) です。0 を渡すとタイムアウトを無効にします。デフォルト値は BrowserContext.setDefaultTimeout() または Page.setDefaultTimeout() メソッドを使用して変更できます。
- setTrial boolean (任意)#
  
  設定すると、このメソッドはアクション可能性チェックのみを実行し、アクションはスキップします。デフォルトは false です。アクションを実行せずに要素がアクションの準備が整うまで待機するのに便利です。キーボードの modifiers は、それらのキーが押されたときにのみ表示される要素をテストできるように、trial にかかわらず押されることに注意してください。

戻り値

void #

詳細

このメソッドは、次の手順を実行して要素をクリックします。

setForce オプションが設定されていない限り、要素に対するアクション可能性チェックを待ちます。
必要に応じて、要素をビューにスクロールします。
要素の中央、または指定されたsetPositionでクリックするためにPage.mouse() を使用します。
setNoWaitAfter オプションが設定されていない限り、開始されたナビゲーションが成功するか失敗するのを待ちます。

アクション中に要素がDOMからデタッチされた場合、このメソッドは例外をスローします。

指定されたsetTimeout中にすべてのステップが完了しない場合、このメソッドはTimeoutErrorをスローします。タイムアウトをゼロにすると、これを無効にします。

contentFrame

追加バージョン: v1.43

locator.contentFrame

このロケーターと同じ iframe を指す FrameLocator オブジェクトを返します。

どこかで取得した Locator オブジェクトがあり、後でフレーム内のコンテンツと対話したい場合に便利です。

逆の操作には、FrameLocator.owner() を使用してください。

使用方法

Locator locator = page.locator("iframe[name=\"embedded\"]");
// ...
FrameLocator frameLocator = locator.contentFrame();
frameLocator.getByRole(AriaRole.BUTTON).click();

戻り値

FrameLocator #

count

追加バージョン: v1.14

locator.count

ロケーターに一致する要素の数を返します。

カウントのアサーション

ページ上の要素の数をアサートする必要がある場合は、不安定さを避けるために assertThat(locator).hasCount() を使用することをお勧めします。アサーションガイドで詳細を参照してください。

使用方法

int count = page.getByRole(AriaRole.LISTITEM).count();

戻り値

int #

dblclick

追加バージョン: v1.14

locator.dblclick

要素をダブルクリックします。

使用方法

Locator.dblclick();
Locator.dblclick(options);

引数

options Locator.DblclickOptions (任意)
- setButton enum MouseButton { LEFT, RIGHT, MIDDLE } (任意)#
  
  デフォルトは left です。
- setDelay double (任意)#
  
  mousedown と mouseup の間の待機時間（ミリ秒単位）。デフォルトは0です。
- setForce boolean (任意)#
  
  アクション可能性チェックをバイパスするかどうか。デフォルトは false です。
- setModifiers List<enum KeyboardModifier { ALT, CONTROL, CONTROLORMETA, META, SHIFT }> (任意)#
  
  押す修飾キー。操作中はこれらの修飾キーのみが押され、その後現在の修飾キーが元に戻ることを保証します。指定されていない場合、現在押されている修飾キーが使用されます。「ControlOrMeta」は、WindowsおよびLinuxでは「Control」に、macOSでは「Meta」に解決されます。
- setNoWaitAfter boolean (任意)#
  
  非推奨
  このオプションは効果がありません。
  
  このオプションは効果がありません。
- setPosition Position (任意)#
  - setX double
  - setY double
  要素のパディングボックスの左上隅を基準に使用する点。指定されていない場合は、要素の表示可能な点のいずれかが使用されます。
- setTimeout double (任意)#
  
  ミリ秒単位の最大時間。デフォルトは 30000 (30秒) です。0 を渡すとタイムアウトを無効にします。デフォルト値は BrowserContext.setDefaultTimeout() または Page.setDefaultTimeout() メソッドを使用して変更できます。
- setTrial boolean (任意)#
  
  設定すると、このメソッドはアクション可能性チェックのみを実行し、アクションはスキップします。デフォルトは false です。アクションを実行せずに要素がアクションの準備が整うまで待機するのに便利です。キーボードの modifiers は、それらのキーが押されたときにのみ表示される要素をテストできるように、trial にかかわらず押されることに注意してください。

戻り値

void #

詳細

このメソッドは、次の手順を実行して要素をダブルクリックします。

setForce オプションが設定されていない限り、要素に対するアクション可能性チェックを待ちます。
必要に応じて、要素をビューにスクロールします。
要素の中央、または指定されたsetPositionでダブルクリックするためにPage.mouse() を使用します。

アクション中に要素がDOMからデタッチされた場合、このメソッドは例外をスローします。

指定されたsetTimeout中にすべてのステップが完了しない場合、このメソッドはTimeoutErrorをスローします。タイムアウトをゼロにすると、これを無効にします。

注

element.dblclick() は2つの click イベントと1つの dblclick イベントをディスパッチします。

dispatchEvent

追加バージョン: v1.14

locator.dispatchEvent

一致する要素に対して、プログラムでイベントをディスパッチします。

使用方法

locator.dispatchEvent("click");

引数

type String #

DOMイベントタイプ: "click"、"dragstart" など。
eventInit EvaluationArgument (任意)#

イベント固有のオプションの初期化プロパティ。
options Locator.DispatchEventOptions (任意)
- setTimeout double (任意)#
  
  ミリ秒単位の最大時間。デフォルトは 30000 (30秒) です。0 を渡すとタイムアウトを無効にします。デフォルト値は BrowserContext.setDefaultTimeout() または Page.setDefaultTimeout() メソッドを使用して変更できます。

戻り値

void #

詳細

上記のスニペットは、要素に対して click イベントをディスパッチします。要素の表示状態にかかわらず、click がディスパッチされます。これは element.click() を呼び出すのと同等です。

内部では、指定された type に基づいてイベントのインスタンスを作成し、eventInit プロパティで初期化し、要素にディスパッチします。イベントはデフォルトで composed、cancelable、およびバブルします。

eventInit はイベント固有であるため、初期プロパティのリストについてはイベントのドキュメントを参照してください。

ライブオブジェクトをイベントに渡したい場合は、プロパティ値として JSHandle を指定することもできます。

JSHandle dataTransfer = page.evaluateHandle("() => new DataTransfer()");
Map<String, Object> arg = new HashMap<>();
arg.put("dataTransfer", dataTransfer);
locator.dispatchEvent("dragstart", arg);

dragTo

追加バージョン: v1.18

locator.dragTo

ソース要素をターゲット要素に向かってドラッグし、ドロップします。

使用方法

Locator source = page.locator("#source");
Locator target = page.locator("#target");

source.dragTo(target);
// or specify exact positions relative to the top-left corners of the elements:
source.dragTo(target, new Locator.DragToOptions()
  .setSourcePosition(34, 7).setTargetPosition(10, 20));

引数

target Locator #

ドラッグ先の要素のロケーター。
options Locator.DragToOptions (任意)
- setForce boolean (任意)#
  
  アクション可能性チェックをバイパスするかどうか。デフォルトは false です。
- setNoWaitAfter boolean (任意)#
  
  非推奨
  このオプションは効果がありません。
  
  このオプションは効果がありません。
- setSourcePosition SourcePosition (任意)#
  - setX double
  - setY double
  要素のパディングボックスの左上隅を基準として、この点でソース要素をクリックします。指定されていない場合、要素の表示可能な点のいずれかが使用されます。
- setTargetPosition TargetPosition (任意)#
  - setX double
  - setY double
  要素のパディングボックスの左上隅を基準として、この点でターゲット要素にドロップします。指定されていない場合、要素の表示可能な点のいずれかが使用されます。
- setTimeout double (任意)#
  
  ミリ秒単位の最大時間。デフォルトは 30000 (30秒) です。0 を渡すとタイムアウトを無効にします。デフォルト値は BrowserContext.setDefaultTimeout() または Page.setDefaultTimeout() メソッドを使用して変更できます。
- setTrial boolean (任意)#
  
  設定すると、このメソッドはアクション可能性チェックのみを実行し、アクションはスキップします。デフォルトは false です。アクションを実行せずに要素がアクションの準備が整うまで待機するのに便利です。

戻り値

void #

詳細

このメソッドは、ロケーターを別のターゲットロケーターまたはターゲット位置にドラッグします。最初にソース要素に移動し、mousedown を実行し、次にターゲット要素または位置に移動して mouseup を実行します。

evaluate

追加バージョン: v1.14

locator.evaluate

ページでJavaScriptコードを実行し、一致する要素を引数として取ります。

使用方法

引数

expression String #

ブラウザコンテキストで評価されるJavaScript式。式が関数に評価される場合、その関数は自動的に呼び出されます。
arg EvaluationArgument (任意)#

expression に渡すオプションの引数。
options Locator.EvaluateOptions (任意)
- setTimeout double (任意)#
  
  ロケーターを評価するまでの最大待機時間（ミリ秒単位）。ロケーターが解決された後、評価自体はタイムアウトによって制限されないことに注意してください。デフォルトは 30000 (30秒) です。0 を渡すとタイムアウトを無効にします。

戻り値

Object #

詳細

expression の戻り値を返します。これは、一致する要素を最初の引数として、arg を2番目の引数として呼び出されます。

expression が Promise を返す場合、このメソッドは Promise が解決されるまで待機し、その値を返します。

expression が例外をスローまたは拒否した場合、このメソッドは例外をスローします。

evaluateAll

追加バージョン: v1.14

locator.evaluateAll

ページでJavaScriptコードを実行し、すべての一致する要素を引数として取ります。

使用方法

Locator locator = page.locator("div");
boolean moreThanTen = (boolean) locator.evaluateAll("(divs, min) => divs.length > min", 10);

引数

expression String #

ブラウザコンテキストで評価されるJavaScript式。式が関数に評価される場合、その関数は自動的に呼び出されます。
arg EvaluationArgument (任意)#

expression に渡すオプションの引数。

戻り値

Object #

詳細

expression の戻り値を返します。これは、すべての一致する要素の配列を最初の引数として、arg を2番目の引数として呼び出されます。

expression が Promise を返す場合、このメソッドは Promise が解決されるまで待機し、その値を返します。

expression が例外をスローまたは拒否した場合、このメソッドは例外をスローします。

evaluateHandle

追加バージョン: v1.14

locator.evaluateHandle

ページでJavaScriptコードを実行し、一致する要素を引数として取り、結果を伴う JSHandle を返します。

使用方法

Locator.evaluateHandle(expression);
Locator.evaluateHandle(expression, arg, options);

引数

expression String #

ブラウザコンテキストで評価されるJavaScript式。式が関数に評価される場合、その関数は自動的に呼び出されます。
arg EvaluationArgument (任意)#

expression に渡すオプションの引数。
options Locator.EvaluateHandleOptions (任意)
- setTimeout double (任意)#
  
  ロケーターを評価するまでの最大待機時間（ミリ秒単位）。ロケーターが解決された後、評価自体はタイムアウトによって制限されないことに注意してください。デフォルトは 30000 (30秒) です。0 を渡すとタイムアウトを無効にします。

戻り値

JSHandle #

詳細

expression の戻り値を JSHandle として返します。これは、一致する要素を最初の引数として、arg を2番目の引数として呼び出されます。

Locator.evaluate() と Locator.evaluateHandle() の唯一の違いは、Locator.evaluateHandle() が JSHandle を返すことです。

expression が Promise を返す場合、このメソッドは Promise が解決されるまで待機し、その値を返します。

expression が例外をスローまたは拒否した場合、このメソッドは例外をスローします。

詳細については、Page.evaluateHandle() を参照してください。

fill

追加バージョン: v1.14

locator.fill

入力フィールドに値を設定します。

使用方法

page.getByRole(AriaRole.TEXTBOX).fill("example value");

引数

value String #

<input>、<textarea>、または [contenteditable] 要素に設定する値。
options Locator.FillOptions (任意)
- setForce boolean (任意)#
  
  アクション可能性チェックをバイパスするかどうか。デフォルトは false です。
- setNoWaitAfter boolean (任意)#
  
  非推奨
  このオプションは効果がありません。
  
  このオプションは効果がありません。
- setTimeout double (任意)#
  
  ミリ秒単位の最大時間。デフォルトは 30000 (30秒) です。0 を渡すとタイムアウトを無効にします。デフォルト値は BrowserContext.setDefaultTimeout() または Page.setDefaultTimeout() メソッドを使用して変更できます。

戻り値

void #

詳細

このメソッドは、アクション可能性チェックを待ち、要素にフォーカスし、値を入力して、入力後に input イベントをトリガーします。空の文字列を渡して入力フィールドをクリアすることも可能です。

ターゲット要素が <input>、<textarea>、または [contenteditable] 要素でない場合、このメソッドはエラーをスローします。ただし、要素が関連付けられたコントロールを持つ <label> 要素内にある場合は、代わりにそのコントロールが入力されます。

細かいキーボードイベントを送信するには、Locator.pressSequentially() を使用してください。

filter

追加バージョン: v1.22

locator.filter

このメソッドは、オプションに従って既存のロケーターを絞り込みます。たとえば、テキストでフィルターします。複数回チェーンしてフィルターすることも可能です。

使用方法

Locator rowLocator = page.locator("tr");
// ...
rowLocator
    .filter(new Locator.FilterOptions().setHasText("text in column 1"))
    .filter(new Locator.FilterOptions().setHas(
        page.getByRole(AriaRole.BUTTON, new Page.GetByRoleOptions().setName("column 2 button"))
    ))
    .screenshot();

引数

options Locator.FilterOptions (任意)
- setHas Locator (任意)#
  
  この相対ロケーターに一致する要素を含む結果にメソッドの結果を絞り込みます。たとえば、text=Playwright を持つ article は <article><div>Playwright</div></article> に一致します。
  
  内部ロケーターは、外部ロケーターに**相対的**である必要があり、ドキュメントルートからではなく、外部ロケーターの一致からクエリが開始されます。たとえば、<article><content><div>Playwright</div></content></article> 内の div を持つ content を見つけることができます。ただし、article div を持つ content を探すと失敗します。これは、内部ロケーターが相対的である必要があり、content の外部の要素を使用してはならないためです。
  
  外部ロケーターと内部ロケーターは同じフレームに属している必要があることに注意してください。内部ロケーターは FrameLocator を含んでいてはなりません。
- setHasNot Locator (任意)追加バージョン: v1.33#
  
  内部ロケーターに一致する要素を含まない要素に一致します。内部ロケーターは外部ロケーターに対してクエリされます。たとえば、div を持たない article は <article><span>Playwright</span></article> に一致します。
  
  外部ロケーターと内部ロケーターは同じフレームに属している必要があることに注意してください。内部ロケーターは FrameLocator を含んでいてはなりません。
- setHasNotText String | Pattern (任意)追加バージョン: v1.33#
  
  指定されたテキストをどこかに（子要素または子孫要素内に）含まない要素に一致します。文字列が渡された場合、大文字小文字を区別せず、部分文字列を検索して一致させます。
- setHasText String | Pattern (任意)#
  
  指定されたテキストをどこかに（子要素または子孫要素内に）含む要素に一致します。文字列が渡された場合、大文字小文字を区別せず、部分文字列を検索して一致させます。たとえば、"Playwright" は <article><div>Playwright</div></article> に一致します。
- setVisible boolean (任意)追加バージョン: v1.51#
  
  表示されている要素または非表示の要素のみに一致します。

戻り値

Locator #

first

追加バージョン: v1.14

locator.first

最初の一致する要素へのロケーターを返します。

使用方法

Locator.first();

戻り値

Locator #

focus

追加バージョン: v1.14

locator.focus

一致する要素に対して focus を呼び出します。

使用方法

Locator.focus();
Locator.focus(options);

引数

options Locator.FocusOptions (任意)
- setTimeout double (任意)#
  
  ミリ秒単位の最大時間。デフォルトは 30000 (30秒) です。0 を渡すとタイムアウトを無効にします。デフォルト値は BrowserContext.setDefaultTimeout() または Page.setDefaultTimeout() メソッドを使用して変更できます。

戻り値

void #

frameLocator

追加バージョン: v1.17

locator.frameLocator

iframe を扱う場合、iframe に入り、その iframe 内の要素を特定できるフレームロケーターを作成できます。

使用方法

Locator locator = page.frameLocator("iframe").getByText("Submit");
locator.click();

引数

selector String #

DOM要素を解決する際に使用するセレクター。

戻り値

FrameLocator #

getAttribute

追加バージョン: v1.14

locator.getAttribute

一致する要素の属性値を返します。

属性のアサーション

要素の属性をアサートする必要がある場合は、不安定さを避けるために assertThat(locator).hasAttribute() を使用することをお勧めします。アサーションガイドで詳細を参照してください。

使用方法

Locator.getAttribute(name);
Locator.getAttribute(name, options);

引数

name String #

値を取得する属性名。
options Locator.GetAttributeOptions (任意)
- setTimeout double (任意)#
  
  ミリ秒単位の最大時間。デフォルトは 30000 (30秒) です。0 を渡すとタイムアウトを無効にします。デフォルト値は BrowserContext.setDefaultTimeout() または Page.setDefaultTimeout() メソッドを使用して変更できます。

戻り値

null | String #

getByAltText

追加バージョン: v1.27

locator.getByAltText

要素を代替テキスト（alt text）で特定できるようにします。

使用方法

例えば、このメソッドは「Playwright logo」という代替テキストを持つ画像を検索します。

<img alt='Playwright logo'>

page.getByAltText("Playwright logo").click();

引数

text String | Pattern #

要素を特定するためのテキスト。
options Locator.GetByAltTextOptions (任意)
- setExact boolean (任意)#
  
  完全一致（大文字小文字を区別し、文字列全体が一致）を検索するかどうか。デフォルトは false です。正規表現で検索する場合は無視されます。完全一致でも空白はトリムされることに注意してください。

戻り値

Locator #

getByLabel

追加バージョン: v1.27

locator.getByLabel

関連付けられた <label> または aria-labelledby 要素のテキスト、または aria-label 属性によって入力要素を特定できるようにします。

使用方法

例えば、このメソッドは以下のDOM構造において「Username」と「Password」というラベルで入力を検索します。

<input aria-label="Username">
<label for="password-input">Password:</label>
<input id="password-input">

page.getByLabel("Username").fill("john");
page.getByLabel("Password").fill("secret");

引数

text String | Pattern #

要素を特定するためのテキスト。
options Locator.GetByLabelOptions (任意)
- setExact boolean (任意)#
  
  完全一致（大文字小文字を区別し、文字列全体が一致）を検索するかどうか。デフォルトは false です。正規表現で検索する場合は無視されます。完全一致でも空白はトリムされることに注意してください。

戻り値

Locator #

getByPlaceholder

追加バージョン: v1.27

locator.getByPlaceholder

プレースホルダーテキストによって入力要素を特定できるようにします。

使用方法

例えば、次のDOM構造を考えてみましょう。

<input type="email" placeholder="name@example.com" />

プレースホルダーテキストで入力を特定した後、入力できます。

page.getByPlaceholder("name@example.com").fill("playwright@microsoft.com");

引数

text String | Pattern #

要素を特定するためのテキスト。
options Locator.GetByPlaceholderOptions (任意)
- setExact boolean (任意)#
  
  完全一致（大文字小文字を区別し、文字列全体が一致）を検索するかどうか。デフォルトは false です。正規表現で検索する場合は無視されます。完全一致でも空白はトリムされることに注意してください。

戻り値

Locator #

getByRole

追加バージョン: v1.27

locator.getByRole

要素をARIA ロール、ARIA 属性、およびアクセシブルネームで特定できるようにします。

使用方法

次のDOM構造を考慮してください。

<h3>Sign up</h3>
<label>
  <input type="checkbox" /> Subscribe
</label>
<br/>
<button>Submit</button>

各要素をその暗黙的な役割で特定できます。

assertThat(page
    .getByRole(AriaRole.HEADING,
               new Page.GetByRoleOptions().setName("Sign up")))
    .isVisible();

page.getByRole(AriaRole.CHECKBOX,
               new Page.GetByRoleOptions().setName("Subscribe"))
    .check();

page.getByRole(AriaRole.BUTTON,
               new Page.GetByRoleOptions().setName(
                   Pattern.compile("submit", Pattern.CASE_INSENSITIVE)))
    .click();

引数

role enum AriaRole { ALERT, ALERTDIALOG, APPLICATION, ARTICLE, BANNER, BLOCKQUOTE, BUTTON, CAPTION, CELL, CHECKBOX, CODE, COLUMNHEADER, COMBOBOX, COMPLEMENTARY, CONTENTINFO, DEFINITION, DELETION, DIALOG, DIRECTORY, DOCUMENT, EMPHASIS, FEED, FIGURE, FORM, GENERIC, GRID, GRIDCELL, GROUP, HEADING, IMG, INSERTION, LINK, LIST, LISTBOX, LISTITEM, LOG, MAIN, MARQUEE, MATH, METER, MENU, MENUBAR, MENUITEM, MENUITEMCHECKBOX, MENUITEMRADIO, NAVIGATION, NONE, NOTE, OPTION, PARAGRAPH, PRESENTATION, PROGRESSBAR, RADIO, RADIOGROUP, REGION, ROW, ROWGROUP, ROWHEADER, SCROLLBAR, SEARCH, SEARCHBOX, SEPARATOR, SLIDER, SPINBUTTON, STATUS, STRONG, SUBSCRIPT, SUPERSCRIPT, SWITCH, TAB, TABLE, TABLIST, TABPANEL, TERM, TEXTBOX, TIME, TIMER, TOOLBAR, TOOLTIP, TREE, TREEGRID, TREEITEM }#

必須のARIAロール。
options Locator.GetByRoleOptions (任意)
- setChecked boolean (任意)#
  
  通常、aria-checked またはネイティブの <input type=checkbox> コントロールによって設定される属性。
  
  aria-checked について詳しくはこちら。
- setDisabled boolean (任意)#
  
  通常、aria-disabled または disabled によって設定される属性。
  
  注
  他のほとんどの属性とは異なり、disabled はDOM階層を介して継承されます。aria-disabled について詳しくはこちら。
- setExact boolean (任意)追加バージョン: v1.28#
  
  setName が完全一致（大文字と小文字を区別し、文字列全体が一致）するかどうか。デフォルトは false です。setName が正規表現の場合、このオプションは無視されます。完全一致でも空白はトリムされることに注意してください。
- setExpanded boolean (任意)#
  
  通常、aria-expanded によって設定される属性。
  
  aria-expanded について詳しくはこちら。
- setIncludeHidden boolean (任意)#
  
  非表示要素が一致するかどうかを制御するオプション。デフォルトでは、ARIA で定義されているように、非非表示要素のみがロールセレクターによって一致します。
  
  aria-hidden について詳しくはこちら。
- setLevel int (任意)#
  
  通常、heading、listitem、row、treeitem のロールに存在する数値属性で、<h1>-<h6> 要素にはデフォルト値があります。
  
  aria-level について詳しくはこちら。
- setName String | Pattern (任意)#
  
  アクセシブルネームに一致するオプション。デフォルトでは、大文字小文字を区別せず部分文字列を検索して一致させます。この動作を制御するには setExact を使用してください。
  
  アクセシブルネームについて詳しくはこちら。
- setPressed boolean (任意)#
  
  通常、aria-pressed によって設定される属性。
  
  aria-pressed について詳しくはこちら。
- setSelected boolean (任意)#
  
  通常、aria-selected によって設定される属性。
  
  aria-selected について詳しくはこちら。

戻り値

Locator #

詳細

ロールセレクターはアクセシビリティ監査や適合性テストを**置き換えるものではありません**が、ARIAガイドラインに関する初期のフィードバックを提供します。

多くのHTML要素には、ロールセレクターによって認識される暗黙的に定義されたロールがあります。サポートされているすべてのロールはこちらで確認できます。ARIAガイドラインは、role および/または aria-* 属性をデフォルト値に設定することで、暗黙的なロールや属性を重複させることを**推奨していません**。

getByTestId

追加バージョン: v1.27

locator.getByTestId

テストIDで要素を特定します。

使用方法

次のDOM構造を考慮してください。

<button data-testid="directions">Itinéraire</button>

要素をテストIDで特定できます。

page.getByTestId("directions").click();

引数

testId String | Pattern #

要素を特定するためのID。

戻り値

Locator #

詳細

デフォルトでは、data-testid 属性がテストIDとして使用されます。必要に応じて別のテストID属性を設定するには、Selectors.setTestIdAttribute() を使用してください。

getByText

追加バージョン: v1.27

locator.getByText

指定されたテキストを含む要素を特定できるようにします。

アクセシブルロールなどの別の基準で一致させ、その後テキストコンテンツでフィルターできる Locator.filter() も参照してください。

使用方法

次のDOM構造を考慮してください。

<div>Hello <span>world</span></div>
<div>Hello</div>

テキストの部分文字列、完全な文字列、または正規表現で特定できます。

// Matches <span>
page.getByText("world");

// Matches first <div>
page.getByText("Hello world");

// Matches second <div>
page.getByText("Hello", new Page.GetByTextOptions().setExact(true));

// Matches both <div>s
page.getByText(Pattern.compile("Hello"));

// Matches second <div>
page.getByText(Pattern.compile("^hello$", Pattern.CASE_INSENSITIVE));

引数

text String | Pattern #

要素を特定するためのテキスト。
options Locator.GetByTextOptions (任意)
- setExact boolean (任意)#
  
  完全一致（大文字小文字を区別し、文字列全体が一致）を検索するかどうか。デフォルトは false です。正規表現で検索する場合は無視されます。完全一致でも空白はトリムされることに注意してください。

戻り値

Locator #

詳細

テキストによる一致は、完全一致であっても常に空白を正規化します。例えば、複数のスペースを1つにまとめ、改行をスペースに変換し、先頭と末尾の空白を無視します。

button および submit タイプの入力要素は、テキストコンテンツではなく value で一致します。例えば、テキスト "Log in" で検索すると <input type=button value="Log in"> に一致します。

getByTitle

追加バージョン: v1.27

locator.getByTitle

タイトル属性によって要素を特定できるようにします。

使用方法

次のDOM構造を考慮してください。

<span title='Issues count'>25 issues</span>

タイトルテキストで特定した後、問題の数をチェックできます。

assertThat(page.getByTitle("Issues count")).hasText("25 issues");

引数

text String | Pattern #

要素を特定するためのテキスト。
options Locator.GetByTitleOptions (オプション)
- setExact boolean (オプション)#
  
  完全一致（大文字小文字を区別し、文字列全体が一致）を検索するかどうか。デフォルトは false です。正規表現で検索する場合は無視されます。完全一致でも空白はトリムされることに注意してください。

戻り値

Locator #

highlight

追加バージョン: v1.20

locator.highlight

画面上の対応する要素をハイライト表示します。デバッグに役立ちますが、Locator.highlight()を使用するコードをコミットしないでください。

使用方法

Locator.highlight();

戻り値

void #

hover

追加バージョン: v1.14

locator.hover

一致する要素の上にホバーします。

使用方法

page.getByRole(AriaRole.LINK).hover();

引数

options Locator.HoverOptions (オプション)
- setForce boolean (オプション)#
  
  アクション可能性チェックをバイパスするかどうか。デフォルトは false です。
- setModifiers List<enum KeyboardModifier { ALT, CONTROL, CONTROLORMETA, META, SHIFT }> (オプション)#
  
  押す修飾キー。操作中はこれらの修飾キーのみが押され、その後現在の修飾キーが元に戻ることを保証します。指定されていない場合、現在押されている修飾キーが使用されます。「ControlOrMeta」は、WindowsおよびLinuxでは「Control」に、macOSでは「Meta」に解決されます。
- setNoWaitAfter boolean (オプション)追加バージョン: v1.28#
  
  非推奨
  このオプションは効果がありません。
  
  このオプションは効果がありません。
- setPosition Position (オプション)#
  - setX double
  - setY double
  要素のパディングボックスの左上隅を基準に使用する点。指定されていない場合は、要素の表示可能な点のいずれかが使用されます。
- setTimeout double (オプション)#
  
  ミリ秒単位の最大時間。デフォルトは 30000 (30秒) です。0 を渡すとタイムアウトを無効にします。デフォルト値は BrowserContext.setDefaultTimeout() または Page.setDefaultTimeout() メソッドを使用して変更できます。
- setTrial boolean (オプション)#
  
  設定すると、このメソッドはアクション可能性チェックのみを実行し、アクションはスキップします。デフォルトは false です。アクションを実行せずに要素がアクションの準備が整うまで待機するのに便利です。キーボードの modifiers は、それらのキーが押されたときにのみ表示される要素をテストできるように、trial にかかわらず押されることに注意してください。

戻り値

void #

詳細

このメソッドは、以下の手順を実行して要素の上にホバーします

アクション可能性チェックを待機します。ただし、setForceオプションが設定されている場合を除きます。
必要に応じて、要素をビューにスクロールします。
Page.mouse()を使用して要素の中央、または指定されたsetPositionの位置にホバーします。

アクション中に要素がDOMからデタッチされた場合、このメソッドは例外をスローします。

指定されたsetTimeoutの間にすべての手順が完了しない場合、このメソッドはTimeoutErrorをスローします。タイムアウトをゼロに設定すると、この機能は無効になります。

innerHTML

追加バージョン: v1.14

locator.innerHTML

element.innerHTMLを返します。

使用方法

Locator.innerHTML();
Locator.innerHTML(options);

引数

options Locator.InnerHTMLOptions (オプション)
- setTimeout double (オプション)#
  
  ミリ秒単位の最大時間。デフォルトは 30000 (30秒) です。0 を渡すとタイムアウトを無効にします。デフォルト値は BrowserContext.setDefaultTimeout() または Page.setDefaultTimeout() メソッドを使用して変更できます。

戻り値

String #

innerText

追加バージョン: v1.14

locator.innerText

element.innerTextを返します。

テキストのアサーション

使用方法

Locator.innerText();
Locator.innerText(options);

引数

options Locator.InnerTextOptions (オプション)
- setTimeout double (オプション)#
  
  ミリ秒単位の最大時間。デフォルトは 30000 (30秒) です。0 を渡すとタイムアウトを無効にします。デフォルト値は BrowserContext.setDefaultTimeout() または Page.setDefaultTimeout() メソッドを使用して変更できます。

戻り値

String #

inputValue

追加バージョン: v1.14

locator.inputValue

一致する<input>、<textarea>、または<select>要素の値を返します。

値のアサーション

入力値をアサートする必要がある場合は、不安定さを回避するためにassertThat(locator).hasValue()の使用を推奨します。詳細については、アサーションガイドを参照してください。

使用方法

String value = page.getByRole(AriaRole.TEXTBOX).inputValue();

引数

options Locator.InputValueOptions (オプション)
- setTimeout double (オプション)#
  
  ミリ秒単位の最大時間。デフォルトは 30000 (30秒) です。0 を渡すとタイムアウトを無効にします。デフォルト値は BrowserContext.setDefaultTimeout() または Page.setDefaultTimeout() メソッドを使用して変更できます。

戻り値

String #

詳細

input、textarea、または select ではない要素の場合、エラーをスローします。ただし、要素が関連するコントロールを持つ<label>要素内にある場合、コントロールの値を返します。

isChecked

追加バージョン: v1.14

locator.isChecked

要素がチェックされているかどうかを返します。要素がチェックボックスまたはラジオ入力ではない場合、エラーをスローします。

チェック状態のアサーション

チェックボックスがチェックされていることをアサートする必要がある場合は、不安定さを回避するためにassertThat(locator).isChecked()の使用を推奨します。詳細については、アサーションガイドを参照してください。

使用方法

boolean checked = page.getByRole(AriaRole.CHECKBOX).isChecked();

引数

options Locator.IsCheckedOptions (オプション)
- setTimeout double (オプション)#
  
  ミリ秒単位の最大時間。デフォルトは 30000 (30秒) です。0 を渡すとタイムアウトを無効にします。デフォルト値は BrowserContext.setDefaultTimeout() または Page.setDefaultTimeout() メソッドを使用して変更できます。

戻り値

boolean #

isDisabled

追加バージョン: v1.14

locator.isDisabled

要素が無効になっているかどうかを返します。有効な状態の反対です。

無効状態のアサーション

要素が無効であることをアサートする必要がある場合は、不安定さを回避するためにassertThat(locator).isDisabled()の使用を推奨します。詳細については、アサーションガイドを参照してください。

使用方法

boolean disabled = page.getByRole(AriaRole.BUTTON).isDisabled();

引数

options Locator.IsDisabledOptions (オプション)
- setTimeout double (オプション)#
  
  ミリ秒単位の最大時間。デフォルトは 30000 (30秒) です。0 を渡すとタイムアウトを無効にします。デフォルト値は BrowserContext.setDefaultTimeout() または Page.setDefaultTimeout() メソッドを使用して変更できます。

戻り値

boolean #

isEditable

追加バージョン: v1.14

locator.isEditable

要素が編集可能であるかどうかを返します。対象の要素が<input>、<textarea>、<select>、[contenteditable]ではなく、[aria-readonly]を許可するロールを持たない場合、このメソッドはエラーをスローします。

編集可能状態のアサーション

要素が編集可能であることをアサートする必要がある場合は、不安定さを回避するためにassertThat(locator).isEditable()の使用を推奨します。詳細については、アサーションガイドを参照してください。

使用方法

boolean editable = page.getByRole(AriaRole.TEXTBOX).isEditable();

引数

options Locator.IsEditableOptions (オプション)
- setTimeout double (オプション)#
  
  ミリ秒単位の最大時間。デフォルトは 30000 (30秒) です。0 を渡すとタイムアウトを無効にします。デフォルト値は BrowserContext.setDefaultTimeout() または Page.setDefaultTimeout() メソッドを使用して変更できます。

戻り値

boolean #

isEnabled

追加バージョン: v1.14

locator.isEnabled

要素が有効であるかどうかを返します。

有効状態のアサーション

要素が有効であることをアサートする必要がある場合は、不安定さを回避するためにassertThat(locator).isEnabled()の使用を推奨します。詳細については、アサーションガイドを参照してください。

使用方法

boolean enabled = page.getByRole(AriaRole.BUTTON).isEnabled();

引数

options Locator.IsEnabledOptions (オプション)
- setTimeout double (オプション)#
  
  ミリ秒単位の最大時間。デフォルトは 30000 (30秒) です。0 を渡すとタイムアウトを無効にします。デフォルト値は BrowserContext.setDefaultTimeout() または Page.setDefaultTimeout() メソッドを使用して変更できます。

戻り値

boolean #

isHidden

追加バージョン: v1.14

locator.isHidden

要素が非表示になっているかどうかを返します。表示されている状態の反対です。

可視性のアサーション

要素が非表示であることをアサートする必要がある場合は、不安定さを回避するためにassertThat(locator).isHidden()の使用を推奨します。詳細については、アサーションガイドを参照してください。

使用方法

boolean hidden = page.getByRole(AriaRole.BUTTON).isHidden();

引数

options Locator.IsHiddenOptions (オプション)
- setTimeout double (オプション)#
  
  非推奨
  このオプションは無視されます。Locator.isHidden()は要素が非表示になるのを待たずに、すぐに返します。

戻り値

boolean #

isVisible

追加バージョン: v1.14

locator.isVisible

要素が表示されているかどうかを返します。

可視性のアサーション

要素が表示されていることをアサートする必要がある場合は、不安定さを回避するためにassertThat(locator).isVisible()の使用を推奨します。詳細については、アサーションガイドを参照してください。

使用方法

boolean visible = page.getByRole(AriaRole.BUTTON).isVisible();

引数

options Locator.IsVisibleOptions (オプション)
- setTimeout double (オプション)#
  
  非推奨
  このオプションは無視されます。Locator.isVisible()は要素が表示されるのを待たずに、すぐに返します。

戻り値

boolean #

last

追加バージョン: v1.14

locator.last

最後に一致する要素のロケーターを返します。

使用方法

Locator banana = page.getByRole(AriaRole.LISTITEM).last();

戻り値

Locator #

locator

追加バージョン: v1.14

locator.locator

このメソッドは、ロケーターのサブツリー内で指定されたセレクターに一致する要素を検索します。また、Locator.filter()メソッドと同様に、フィルターオプションも受け入れます。

ロケーターについて詳しく知る.

使用方法

Locator.locator(selectorOrLocator);
Locator.locator(selectorOrLocator, options);

引数

selectorOrLocator String | Locator #

DOM要素を解決する際に使用するセレクターまたはロケーター。
options Locator.LocatorOptions (オプション)
- setHas Locator (オプション)#
  
  この相対ロケーターに一致する要素を含む結果にメソッドの結果を絞り込みます。たとえば、text=Playwright を持つ article は <article><div>Playwright</div></article> に一致します。
  
  内部ロケーターは、外部ロケーターに**相対的**である必要があり、ドキュメントルートからではなく、外部ロケーターの一致からクエリが開始されます。たとえば、<article><content><div>Playwright</div></content></article> 内の div を持つ content を見つけることができます。ただし、article div を持つ content を探すと失敗します。これは、内部ロケーターが相対的である必要があり、content の外部の要素を使用してはならないためです。
  
  外部ロケーターと内部ロケーターは同じフレームに属している必要があることに注意してください。内部ロケーターは FrameLocator を含んでいてはなりません。
- setHasNot Locator (任意)追加バージョン: v1.33#
  
  内部ロケーターに一致する要素を含まない要素に一致します。内部ロケーターは外部ロケーターに対してクエリされます。たとえば、div を持たない article は <article><span>Playwright</span></article> に一致します。
  
  外部ロケーターと内部ロケーターは同じフレームに属している必要があることに注意してください。内部ロケーターは FrameLocator を含んでいてはなりません。
- setHasNotText String | Pattern (任意)追加バージョン: v1.33#
  
  指定されたテキストをどこかに（子要素または子孫要素内に）含まない要素に一致します。文字列が渡された場合、大文字小文字を区別せず、部分文字列を検索して一致させます。
- setHasText String | Pattern (オプション)#
  
  指定されたテキストをどこかに（子要素または子孫要素内に）含む要素に一致します。文字列が渡された場合、大文字小文字を区別せず、部分文字列を検索して一致させます。たとえば、"Playwright" は <article><div>Playwright</div></article> に一致します。

戻り値

Locator #

nth

追加バージョン: v1.14

locator.nth

N番目に一致する要素のロケーターを返します。ゼロベースであり、nth(0)は最初の要素を選択します。

使用方法

Locator banana = page.getByRole(AriaRole.LISTITEM).nth(2);

引数

index int #

戻り値

Locator #

or

追加バージョン: v1.33

locator.or

2つのロケーターのうち、いずれか一方または両方に一致するすべての要素に一致するロケーターを作成します。

両方のロケーターが何かに一致する場合、結果のロケーターには複数のマッチが含まれ、これによりロケーターの厳密性違反が発生する可能性があることに注意してください。

使用方法

「新しいメール」ボタンをクリックしたいが、代わりにセキュリティ設定ダイアログが表示されることがあるシナリオを考えてみましょう。この場合、「新しいメール」ボタンまたはダイアログのいずれかを待ち、それに応じて操作することができます。

注

画面に「新しいメール」ボタンとセキュリティダイアログの両方が表示された場合、「or」ロケーターは両方に一致し、場合によっては「strict mode violation」エラーをスローする可能性があります。この場合、Locator.first()を使用して、どちらか一方にのみ一致させることができます。

Locator newEmail = page.getByRole(AriaRole.BUTTON, new Page.GetByRoleOptions().setName("New"));
Locator dialog = page.getByText("Confirm security settings");
assertThat(newEmail.or(dialog).first()).isVisible();
if (dialog.isVisible())
  page.getByRole(AriaRole.BUTTON, new Page.GetByRoleOptions().setName("Dismiss")).click();
newEmail.click();

引数

locator Locator #

一致させる代替ロケーター。

戻り値

Locator #

page

追加バージョン: v1.19

locator.page

このロケーターが属するページ。

使用方法

Locator.page();

戻り値

Page #

press

追加バージョン: v1.14

locator.press

一致する要素にフォーカスし、キーの組み合わせを押します。

使用方法

page.getByRole(AriaRole.TEXTBOX).press("Backspace");

引数

key String #

押すキーの名前、または生成する文字。例: ArrowLeft や a。
options Locator.PressOptions (オプション)
- setDelay double (オプション)#
  
  keydownとkeyup間の待機時間 (ミリ秒)。デフォルトは0です。
- setNoWaitAfter boolean (オプション)#
  
  非推奨
  このオプションは将来的にデフォルトで true になります。
  
  ナビゲーションを開始するアクションは、これらのナビゲーションが発生し、ページの読み込みが開始されるのを待ちます。このフラグを設定することで、待機をオプトアウトできます。このオプションは、アクセスできないページへのナビゲーションなどの例外的な場合にのみ必要です。デフォルトは false です。
- setTimeout double (オプション)#
  
  ミリ秒単位の最大時間。デフォルトは 30000 (30秒) です。0 を渡すとタイムアウトを無効にします。デフォルト値は BrowserContext.setDefaultTimeout() または Page.setDefaultTimeout() メソッドを使用して変更できます。

戻り値

void #

詳細

要素にフォーカスし、その後Keyboard.down()とKeyboard.up()を使用します。

keyは、目的のkeyboardEvent.key値、またはテキストを生成するための単一の文字を指定できます。key値のスーパーセットはこちらにあります。キーの例は次のとおりです。

F1 - F12, Digit0- Digit9, KeyA- KeyZ, Backquote, Minus, Equal, Backslash, Backspace, Tab, Delete, Escape, ArrowDown, End, Enter, Home, Insert, PageDown, PageUp, ArrowRight, ArrowUp, など。

以下の修飾キーのショートカットもサポートされています: Shift, Control, Alt, Meta, ShiftLeft, ControlOrMeta。ControlOrMetaはWindowsおよびLinuxではControlに、macOSではMetaに解決されます。

Shiftを押し続けると、keyに対応するテキストが大文字で入力されます。

もしkeyが単一の文字である場合、大文字と小文字は区別され、したがってaとAの値はそれぞれ異なるテキストを生成します。

key: "Control+o"、key: "Control++、またはkey: "Control+Shift+T"のようなショートカットもサポートされています。修飾キーを指定した場合、後続のキーが押されている間、修飾キーは押されたままになります。

pressSequentially

追加バージョン: v1.38

locator.pressSequentially

ヒント

ほとんどの場合、代わりにLocator.fill()を使用する必要があります。ページに特別なキーボード処理がある場合にのみ、キーを1つずつ押す必要があります。

要素にフォーカスし、その後、テキスト内の各文字に対してkeydown、keypress/input、およびkeyupイベントを送信します。

ControlやArrowDownのような特殊キーを押すには、Locator.press()を使用します。

使用方法

locator.pressSequentially("Hello"); // Types instantly
locator.pressSequentially("World", new Locator.pressSequentiallyOptions().setDelay(100)); // Types slower, like a user

テキストフィールドに入力し、フォームを送信する例

Locator locator = page.getByLabel("Password");
locator.pressSequentially("my password");
locator.press("Enter");

引数

text String #

フォーカスされた要素に順次押す文字の文字列。
options Locator.PressSequentiallyOptions (オプション)
- setDelay double (オプション)#
  
  キー押下間の待機時間 (ミリ秒)。デフォルトは0です。
- setNoWaitAfter boolean (オプション)#
  
  非推奨
  このオプションは効果がありません。
  
  このオプションは効果がありません。
- setTimeout double (オプション)#
  
  ミリ秒単位の最大時間。デフォルトは 30000 (30秒) です。0 を渡すとタイムアウトを無効にします。デフォルト値は BrowserContext.setDefaultTimeout() または Page.setDefaultTimeout() メソッドを使用して変更できます。

戻り値

void #

screenshot

追加バージョン: v1.14

locator.screenshot

ロケーターに一致する要素のスクリーンショットを撮ります。

使用方法

page.getByRole(AriaRole.LINK).screenshot();

アニメーションを無効にしてスクリーンショットをファイルに保存

page.getByRole(AriaRole.LINK).screenshot(new Locator.ScreenshotOptions()
    .setAnimations(ScreenshotAnimations.DISABLED)
    .setPath(Paths.get("example.png")));

引数

options Locator.ScreenshotOptions (オプション)
- setAnimations enum ScreenshotAnimations { DISABLED, ALLOW } (オプション)#
  
  "disabled"が設定されている場合、CSSアニメーション、CSSトランジション、Webアニメーションを停止します。アニメーションは持続時間に応じて異なる扱いを受けます。
  - 有限アニメーションは完了まで早送りされるため、transitionendイベントを発火します。
  - 無限アニメーションは初期状態にキャンセルされ、スクリーンショット撮影後に再生されます。
  デフォルトは"allow"であり、アニメーションはそのまま残されます。
- setCaret enum ScreenshotCaret { HIDE, INITIAL } (オプション)#
  
  "hide"が設定されている場合、スクリーンショットはテキストカーソルを非表示にします。"initial"が設定されている場合、テキストカーソルの動作は変更されません。デフォルトは"hide"です。
- setMask List<Locator> (オプション)#
  
  スクリーンショットを撮る際にマスクするロケーターを指定します。マスクされた要素は、境界ボックスを完全に覆うピンク色のボックス#FF00FF（setMaskColorでカスタマイズ可能）でオーバーレイされます。マスクは非表示の要素にも適用されます。これを無効にするには、表示要素のみを一致させるを参照してください。
- setMaskColor String (オプション)追加バージョン: v1.35#
  
  マスクされた要素のオーバーレイボックスの色をCSSカラー形式で指定します。デフォルトの色はピンク色の#FF00FFです。
- setOmitBackground boolean (オプション)#
  
  デフォルトの白い背景を非表示にし、透明なスクリーンショットのキャプチャを許可します。jpeg画像には適用されません。デフォルトはfalseです。
- setPath Path (オプション)#
  
  画像を保存するファイルパス。スクリーンショットの種類はファイル拡張子から推測されます。もしsetPathが相対パスの場合、現在の作業ディレクトリからの相対パスとして解決されます。パスが提供されない場合、画像はディスクに保存されません。
- setQuality int (オプション)#
  
  画像の品質 (0～100)。png画像には適用されません。
- setScale enum ScreenshotScale { CSS, DEVICE } (オプション)#
  
  "css"が設定されている場合、スクリーンショットは、ページ上の各CSSピクセルに対して1ピクセルを持つスクリーンショットになります。高DPIデバイスの場合、これによりスクリーンショットが小さく保たれます。"device"オプションを使用すると、各デバイスピクセルに対して1ピクセルが生成されるため、高DPIデバイスのスクリーンショットは2倍以上大きくなります。
  
  デフォルトは"device"です。
- setStyle String (オプション)追加バージョン: v1.41#
  
  スクリーンショットを撮る際に適用するスタイルシートのテキスト。ここでは、動的な要素を非表示にしたり、要素を見えなくしたり、そのプロパティを変更したりして、再現可能なスクリーンショットを作成するのに役立てることができます。このスタイルシートはShadow DOMを貫通し、内部フレームにも適用されます。
- setTimeout double (オプション)#
  
  ミリ秒単位の最大時間。デフォルトは 30000 (30秒) です。0 を渡すとタイムアウトを無効にします。デフォルト値は BrowserContext.setDefaultTimeout() または Page.setDefaultTimeout() メソッドを使用して変更できます。
- setType enum ScreenshotType { PNG, JPEG } (オプション)#
  
  スクリーンショットのタイプを指定します。デフォルトはpngです。

戻り値

byte[]#

詳細

このメソッドは、ロケーターに一致する特定の要素のサイズと位置に合わせて切り取られたページのスクリーンショットをキャプチャします。要素が他の要素で覆われている場合、スクリーンショットには実際には表示されません。要素がスクロール可能なコンテナである場合、現在スクロールされているコンテンツのみがスクリーンショットに表示されます。

このメソッドは、アクション可能性チェックを待ち、スクリーンショットを撮る前に要素をビュー内にスクロールします。要素がDOMからデタッチされている場合、このメソッドはエラーをスローします。

キャプチャされたスクリーンショットを含むバッファを返します。

scrollIntoViewIfNeeded

追加バージョン: v1.14

locator.scrollIntoViewIfNeeded

このメソッドは、アクション可能性チェックを待ち、IntersectionObserverのratioで定義されているように完全に可視である場合を除き、要素をビュー内にスクロールしようとします。

スクロールの他の方法については、スクロールを参照してください。

使用方法

Locator.scrollIntoViewIfNeeded();
Locator.scrollIntoViewIfNeeded(options);

引数

options Locator.ScrollIntoViewIfNeededOptions (オプション)
- setTimeout double (オプション)#
  
  ミリ秒単位の最大時間。デフォルトは 30000 (30秒) です。0 を渡すとタイムアウトを無効にします。デフォルト値は BrowserContext.setDefaultTimeout() または Page.setDefaultTimeout() メソッドを使用して変更できます。

戻り値

void #

selectOption

追加バージョン: v1.14

locator.selectOption

<select>要素のオプションを選択します。

使用方法

<select multiple>
  <option value="red">Red</option>
  <option value="green">Green</option>
  <option value="blue">Blue</option>
</select>

// single selection matching the value or label
element.selectOption("blue");
// single selection matching the label
element.selectOption(new SelectOption().setLabel("Blue"));
// multiple selection for blue, red and second option
element.selectOption(new String[] {"red", "green", "blue"});

引数

values null | String | ElementHandle | String[] | SelectOption | ElementHandle[] | SelectOption[]#
- setValue String (オプション)
  
  option.valueで一致させます。オプション。
- setLabel String (オプション)
  
  option.labelで一致させます。オプション。
- setIndex int (オプション)
  
  インデックスで一致させます。オプション。
選択するオプション。もし<select>がmultiple属性を持っている場合、一致するすべてのオプションが選択されます。そうでない場合は、渡されたオプションのいずれかに一致する最初のオプションのみが選択されます。文字列値は値とラベルの両方に一致します。すべての指定されたプロパティが一致する場合、オプションは一致していると見なされます。
options Locator.SelectOptionOptions (オプション)
- setForce boolean (オプション)#
  
  アクション可能性チェックをバイパスするかどうか。デフォルトは false です。
- setNoWaitAfter boolean (オプション)#
  
  非推奨
  このオプションは効果がありません。
  
  このオプションは効果がありません。
- setTimeout double (オプション)#
  
  ミリ秒単位の最大時間。デフォルトは 30000 (30秒) です。0 を渡すとタイムアウトを無効にします。デフォルト値は BrowserContext.setDefaultTimeout() または Page.setDefaultTimeout() メソッドを使用して変更できます。

戻り値

List<String>#

詳細

このメソッドは、アクション可能性チェックを待ち、指定されたすべてのオプションが<select>要素に存在するまで待機し、これらのオプションを選択します。

対象の要素が<select>要素ではない場合、このメソッドはエラーをスローします。ただし、要素が関連するコントロールを持つ<label>要素内にある場合、コントロールが代わりに使用されます。

正常に選択されたオプション値の配列を返します。

すべての指定されたオプションが選択されると、changeおよびinputイベントをトリガーします。

selectText

追加バージョン: v1.14

locator.selectText

このメソッドは、アクション可能性チェックを待ち、その後要素にフォーカスし、そのテキストコンテンツ全体を選択します。

要素が関連するコントロールを持つ<label>要素内にある場合、代わりにコントロールにフォーカスし、テキストを選択します。

使用方法

Locator.selectText();
Locator.selectText(options);

引数

options Locator.SelectTextOptions (オプション)
- setForce boolean (オプション)#
  
  アクション可能性チェックをバイパスするかどうか。デフォルトは false です。
- setTimeout double (オプション)#
  
  ミリ秒単位の最大時間。デフォルトは 30000 (30秒) です。0 を渡すとタイムアウトを無効にします。デフォルト値は BrowserContext.setDefaultTimeout() または Page.setDefaultTimeout() メソッドを使用して変更できます。

戻り値

void #

setChecked

追加バージョン: v1.15

locator.setChecked

チェックボックスまたはラジオ要素の状態を設定します。

使用方法

page.getByRole(AriaRole.CHECKBOX).setChecked(true);

引数

checked boolean #

チェックボックスをチェックするか、チェックを外すか。
options Locator.SetCheckedOptions (オプション)
- setForce boolean (オプション)#
  
  アクション可能性チェックをバイパスするかどうか。デフォルトは false です。
- setNoWaitAfter boolean (オプション)#
  
  非推奨
  このオプションは効果がありません。
  
  このオプションは効果がありません。
- setPosition Position (オプション)#
  - setX double
  - setY double
  要素のパディングボックスの左上隅を基準に使用する点。指定されていない場合は、要素の表示可能な点のいずれかが使用されます。
- setTimeout double (オプション)#
  
  ミリ秒単位の最大時間。デフォルトは 30000 (30秒) です。0 を渡すとタイムアウトを無効にします。デフォルト値は BrowserContext.setDefaultTimeout() または Page.setDefaultTimeout() メソッドを使用して変更できます。
- setTrial boolean (オプション)#
  
  設定すると、このメソッドはアクション可能性チェックのみを実行し、アクションはスキップします。デフォルトは false です。アクションを実行せずに要素がアクションの準備が整うまで待機するのに便利です。

戻り値

void #

詳細

このメソッドは、以下の手順を実行して要素をチェックまたはチェック解除します

一致する要素がチェックボックスまたはラジオ入力であることを確認します。そうでない場合、このメソッドはエラーをスローします。
要素がすでに正しいチェック状態である場合、このメソッドはすぐに返します。
アクション可能性チェックを待機します。ただし、setForceオプションが設定されている場合を除きます。チェック中に要素がデタッチされた場合、すべてのアクションが再試行されます。
必要に応じて、要素をビューにスクロールします。
要素の中央をクリックするために Page.mouse() を使用します。
要素が現在チェックされているか、またはチェック解除されていることを確認します。そうでない場合、このメソッドはエラーをスローします。

setInputFiles

追加バージョン: v1.14

locator.setInputFiles

<input type=file>にファイルまたは複数のファイルをアップロードします。[webkitdirectory]属性を持つ入力の場合、単一のディレクトリパスのみがサポートされます。

使用方法

// Select one file
page.getByLabel("Upload file").setInputFiles(Paths.get("myfile.pdf"));

// Select multiple files
page.getByLabel("Upload files").setInputFiles(new Path[] {Paths.get("file1.txt"), Paths.get("file2.txt")});

// Select a directory
page.getByLabel("Upload directory").setInputFiles(Paths.get("mydir"));

// Remove all the selected files
page.getByLabel("Upload file").setInputFiles(new Path[0]);

// Upload buffer from memory
page.getByLabel("Upload file").setInputFiles(new FilePayload(
  "file.txt", "text/plain", "this is test".getBytes(StandardCharsets.UTF_8)));

引数

files Path | Path[] | FilePayload | FilePayload[]#
- setName String
  
  ファイル名
- setMimeType String
  
  ファイルタイプ
- setBuffer byte[]
  
  ファイルの内容
options Locator.SetInputFilesOptions (オプション)
- setNoWaitAfter boolean (オプション)#
  
  非推奨
  このオプションは効果がありません。
  
  このオプションは効果がありません。
- setTimeout double (オプション)#
  
  ミリ秒単位の最大時間。デフォルトは 30000 (30秒) です。0 を渡すとタイムアウトを無効にします。デフォルト値は BrowserContext.setDefaultTimeout() または Page.setDefaultTimeout() メソッドを使用して変更できます。

戻り値

void #

詳細

ファイル入力の値をこれらのファイルパスまたはファイルに設定します。filePathsの一部が相対パスの場合、現在の作業ディレクトリからの相対パスとして解決されます。空の配列の場合、選択されたファイルをクリアします。

このメソッドは、Locatorがinput要素を指すことを期待します。ただし、要素が関連するコントロールを持つ<label>要素内にある場合、コントロールを代わりにターゲットとします。

tap

追加バージョン: v1.14

locator.tap

ロケーターに一致する要素でタップジェスチャーを実行します。手動でタッチイベントをディスパッチして他のジェスチャーをエミュレートする例については、レガシータッチイベントのエミュレーションページを参照してください。

使用方法

Locator.tap();
Locator.tap(options);

引数

options Locator.TapOptions (オプション)
- setForce boolean (オプション)#
  
  アクション可能性チェックをバイパスするかどうか。デフォルトは false です。
- setModifiers List<enum KeyboardModifier { ALT, CONTROL, CONTROLORMETA, META, SHIFT }> (オプション)#
  
  押す修飾キー。操作中はこれらの修飾キーのみが押され、その後現在の修飾キーが元に戻ることを保証します。指定されていない場合、現在押されている修飾キーが使用されます。「ControlOrMeta」は、WindowsおよびLinuxでは「Control」に、macOSでは「Meta」に解決されます。
- setNoWaitAfter boolean (オプション)#
  
  非推奨
  このオプションは効果がありません。
  
  このオプションは効果がありません。
- setPosition Position (オプション)#
  - setX double
  - setY double
  要素のパディングボックスの左上隅を基準に使用する点。指定されていない場合は、要素の表示可能な点のいずれかが使用されます。
- setTimeout double (オプション)#
  
  ミリ秒単位の最大時間。デフォルトは 30000 (30秒) です。0 を渡すとタイムアウトを無効にします。デフォルト値は BrowserContext.setDefaultTimeout() または Page.setDefaultTimeout() メソッドを使用して変更できます。
- setTrial boolean (オプション)#
  
  設定すると、このメソッドはアクション可能性チェックのみを実行し、アクションはスキップします。デフォルトは false です。アクションを実行せずに要素がアクションの準備が整うまで待機するのに便利です。キーボードの modifiers は、それらのキーが押されたときにのみ表示される要素をテストできるように、trial にかかわらず押されることに注意してください。

戻り値

void #

詳細

このメソッドは、以下の手順を実行して要素をタップします

アクション可能性チェックを待機します。ただし、setForceオプションが設定されている場合を除きます。
必要に応じて、要素をビューにスクロールします。
Page.touchscreen()を使用して要素の中央、または指定されたsetPositionの位置をタップします。

アクション中に要素がDOMからデタッチされた場合、このメソッドは例外をスローします。

注

element.tap()は、ブラウザコンテキストのhasTouchオプションがtrueに設定されている必要があります。

textContent

追加バージョン: v1.14

locator.textContent

node.textContentを返します。

テキストのアサーション

使用方法

Locator.textContent();
Locator.textContent(options);

引数

options Locator.TextContentOptions (オプション)
- setTimeout double (オプション)#
  
  ミリ秒単位の最大時間。デフォルトは 30000 (30秒) です。0 を渡すとタイムアウトを無効にします。デフォルト値は BrowserContext.setDefaultTimeout() または Page.setDefaultTimeout() メソッドを使用して変更できます。

戻り値

null | String #

uncheck

追加バージョン: v1.14

locator.uncheck

チェックボックスまたはラジオ要素がチェック解除されていることを確認します。

使用方法

page.getByRole(AriaRole.CHECKBOX).uncheck();

引数

options Locator.UncheckOptions (オプション)
- setForce boolean (オプション)#
  
  アクション可能性チェックをバイパスするかどうか。デフォルトは false です。
- setNoWaitAfter boolean (オプション)#
  
  非推奨
  このオプションは効果がありません。
  
  このオプションは効果がありません。
- setPosition Position (オプション)#
  - setX double
  - setY double
  要素のパディングボックスの左上隅を基準に使用する点。指定されていない場合は、要素の表示可能な点のいずれかが使用されます。
- setTimeout double (オプション)#
  
  ミリ秒単位の最大時間。デフォルトは 30000 (30秒) です。0 を渡すとタイムアウトを無効にします。デフォルト値は BrowserContext.setDefaultTimeout() または Page.setDefaultTimeout() メソッドを使用して変更できます。
- setTrial boolean (オプション)#
  
  設定すると、このメソッドはアクション可能性チェックのみを実行し、アクションはスキップします。デフォルトは false です。アクションを実行せずに要素がアクションの準備が整うまで待機するのに便利です。

戻り値

void #

詳細

このメソッドは、以下の手順を実行して要素のチェックを解除します

要素がチェックボックスまたはラジオ入力であることを確認します。そうでない場合、このメソッドはエラーをスローします。要素がすでにチェック解除されている場合、このメソッドはすぐに返します。
アクション可能性チェックを待機します。ただし、setForceオプションが設定されている場合を除きます。
必要に応じて、要素をビューにスクロールします。
要素の中央をクリックするために Page.mouse() を使用します。
要素が現在チェック解除されていることを確認します。そうでない場合、このメソッドはエラーをスローします。

アクション中に要素がDOMからデタッチされた場合、このメソッドは例外をスローします。

waitFor

追加バージョン: v1.16

locator.waitFor

ロケーターで指定された要素がsetStateオプションを満たした場合に返します。

対象の要素がすでに条件を満たしている場合、このメソッドはすぐに返します。そうでない場合、setTimeoutミリ秒まで待機し、条件が満たされるまで待ちます。

使用方法

Locator orderSent = page.locator("#order-sent");
orderSent.waitFor();

引数

options Locator.WaitForOptions (オプション)
- setState enum WaitForSelectorState { ATTACHED, DETACHED, VISIBLE, HIDDEN } (オプション)#
  
  デフォルトは'visible'です。次のいずれかになります。
  - 'attached' - 要素がDOMに存在することを確認します。
  - 'detached' - 要素がDOMに存在しないことを確認します。
  - 'visible' - 要素が空でない境界ボックスを持ち、visibility:hiddenではないことを確認します。コンテンツがない要素、またはdisplay:noneを持つ要素は空の境界ボックスを持つため、可視とは見なされないことに注意してください。
  - 'hidden' - 要素がDOMからデタッチされている、または空の境界ボックスを持つ、またはvisibility:hiddenであることのいずれかを確認します。これは'visible'オプションの反対です。
- setTimeout double (オプション)#
  
  ミリ秒単位の最大時間。デフォルトは 30000 (30秒) です。0 を渡すとタイムアウトを無効にします。デフォルト値は BrowserContext.setDefaultTimeout() または Page.setDefaultTimeout() メソッドを使用して変更できます。

戻り値

void #

非推奨

elementHandle

追加バージョン: v1.14

locator.elementHandle

推奨されません

ElementHandleは本質的に競合状態になりやすいため、Locatorとウェブアサーションの使用を常に優先してください。

指定されたロケーターを、最初に一致するDOM要素に解決します。一致する要素がない場合は、一致するまで待機します。複数の要素がロケーターに一致する場合は、エラーをスローします。

使用方法

Locator.elementHandle();
Locator.elementHandle(options);

引数

options Locator.ElementHandleOptions (オプション)
- setTimeout double (オプション)#
  
  ミリ秒単位の最大時間。デフォルトは 30000 (30秒) です。0 を渡すとタイムアウトを無効にします。デフォルト値は BrowserContext.setDefaultTimeout() または Page.setDefaultTimeout() メソッドを使用して変更できます。

戻り値

ElementHandle #

elementHandles

追加バージョン: v1.14

locator.elementHandles

推奨されません

ElementHandleは本質的に競合状態になりやすいため、Locatorとウェブアサーションの使用を常に優先してください。

指定されたロケーターを、一致するすべてのDOM要素に解決します。一致する要素がない場合は、空のリストを返します。

使用方法

Locator.elementHandles();

戻り値

List<ElementHandle>#

type

追加バージョン: v1.14

locator.type

非推奨

ほとんどの場合、代わりにLocator.fill()を使用する必要があります。ページで特別なキーボード処理がある場合にのみ、キーを1つずつ押す必要があります。その場合はLocator.pressSequentially()を使用してください。

要素にフォーカスし、その後、テキスト内の各文字に対してkeydown、keypress/input、およびkeyupイベントを送信します。

ControlやArrowDownのような特殊キーを押すには、Locator.press()を使用します。

使用方法

引数

text String #

フォーカスされた要素に入力するテキスト。
options Locator.TypeOptions (オプション)
- setDelay double (オプション)#
  
  キー押下間の待機時間 (ミリ秒)。デフォルトは0です。
- setNoWaitAfter boolean (オプション)#
  
  非推奨
  このオプションは効果がありません。
  
  このオプションは効果がありません。
- setTimeout double (オプション)#
  
  ミリ秒単位の最大時間。デフォルトは 30000 (30秒) です。0 を渡すとタイムアウトを無効にします。デフォルト値は BrowserContext.setDefaultTimeout() または Page.setDefaultTimeout() メソッドを使用して変更できます。

戻り値

void #

メソッド​

all​

allInnerTexts​

allTextContents​

and​

ariaSnapshot​

blur​

boundingBox​

check​

clear​

click​

contentFrame​

count​

dblclick​

dispatchEvent​

dragTo​

evaluate​

evaluateAll​

evaluateHandle​

fill​

filter​

first​

focus​

frameLocator​

getAttribute​

getByAltText​

getByLabel​

getByPlaceholder​

getByRole​

getByTestId​

getByText​

getByTitle​

highlight​

hover​

innerHTML​

innerText​

inputValue​

isChecked​

isDisabled​

isEditable​

isEnabled​

isHidden​

isVisible​

last​

locator​

nth​

or​

page​

press​

pressSequentially​

screenshot​

scrollIntoViewIfNeeded​

selectOption​

selectText​

setChecked​

setInputFiles​

tap​

textContent​

uncheck​

waitFor​

非推奨

elementHandle

elementHandles

type

メソッド

all

allInnerTexts

allTextContents

and

ariaSnapshot

blur

boundingBox

check

clear

click

contentFrame

count

dblclick

dispatchEvent

dragTo

evaluate

evaluateAll

evaluateHandle

fill

filter

first

focus

frameLocator

getAttribute

getByAltText

getByLabel

getByPlaceholder

getByRole

getByTestId

getByText

getByTitle

highlight

hover

innerHTML

innerText

inputValue

isChecked

isDisabled

isEditable

isEnabled

isHidden

isVisible

last

locator

nth

or

page

press

pressSequentially

screenshot

scrollIntoViewIfNeeded

selectOption

selectText

setChecked

setInputFiles

tap

textContent

uncheck

waitFor