Frame

どの時点でも、ページは現在のフレームツリーを page.mainFrame() および frame.childFrames() メソッドを介して公開します。

Frame オブジェクトのライフサイクルは、ページオブジェクトでディスパッチされる3つのイベントによって制御されます。

page.on('frameattached') - フレームがページにアタッチされると発生します。フレームはページに一度だけアタッチできます。
page.on('framenavigated') - フレームが異なるURLへのナビゲーションをコミットすると発生します。
page.on('framedetached') - フレームがページからデタッチされると発生します。フレームはページから一度だけデタッチできます。

フレームツリーのダンプ例

const { firefox } = require('playwright');  // Or 'chromium' or 'webkit'.

(async () => {
  const browser = await firefox.launch();
  const page = await browser.newPage();
  await page.goto('https://www.google.com/chrome/browser/canary.html');
  dumpFrameTree(page.mainFrame(), '');
  await browser.close();

  function dumpFrameTree(frame, indent) {
    console.log(indent + frame.url());
    for (const child of frame.childFrames())
      dumpFrameTree(child, indent + '  ');
  }
})();

メソッド

addScriptTag

v1.9より前に追加

frame.addScriptTag

スクリプトのonloadが発火したとき、またはスクリプトコンテンツがフレームに挿入されたときに、追加されたタグを返します。

目的のURLまたはコンテンツを持つ <script> タグをページに追加します。

使用法

await frame.addScriptTag();
await frame.addScriptTag(options);

引数

options Object (オプション)
- content string (オプション)#
  
  フレームに挿入される生のJavaScriptコンテンツ。
- path string (オプション)#
  
  フレームに挿入されるJavaScriptファイルへのパス。path が相対パスの場合、現在のワーキングディレクトリからの相対パスとして解決されます。
- type string (オプション)#
  
  スクリプトタイプ。JavaScript ES6モジュールをロードするには 'module' を使用します。詳細については script を参照してください。
- url string (オプション)#
  
  追加されるスクリプトのURL。

戻り値

Promise<ElementHandle>#

addStyleTag

v1.9より前に追加

frame.addStyleTag

スタイルシートのonloadが発火したとき、またはCSSコンテンツがフレームに挿入されたときに、追加されたタグを返します。

目的のURLを持つ <link rel="stylesheet"> タグ、またはコンテンツを持つ <style type="text/css"> タグをページに追加します。

使用法

await frame.addStyleTag();
await frame.addStyleTag(options);

引数

options Object (オプション)
- content string (オプション)#
  
  フレームに挿入される生のCSSコンテンツ。
- path string (オプション)#
  
  フレームに挿入されるCSSファイルへのパス。path が相対パスの場合、現在のワーキングディレクトリからの相対パスとして解決されます。
- url string (オプション)#
  
  <link> タグのURL。

戻り値

Promise<ElementHandle>#

childFrames

v1.9より前に追加

frame.childFrames

使用法

frame.childFrames();

戻り値

Array<Frame>#

content

v1.9より前に追加

frame.content

doctypeを含む、フレームの完全なHTMLコンテンツを取得します。

使用法

await frame.content();

戻り値

Promise<string>#

dragAndDrop

追加バージョン: v1.13

frame.dragAndDrop

使用法

await frame.dragAndDrop(source, target);
await frame.dragAndDrop(source, target, options);

引数

source string #

ドラッグする要素を検索するセレクター。セレクターを満たす要素が複数ある場合は、最初の要素が使用されます。
target string #

ドロップ先の要素を検索するセレクター。セレクターを満たす要素が複数ある場合は、最初の要素が使用されます。
options Object (オプション)
- force boolean (オプション)#
  
  実行可能性チェックをバイパスするかどうか。デフォルトは false です。
- noWaitAfter boolean (オプション)#
  
  非推奨
  このオプションは効果がありません。
  
  このオプションは効果がありません。
- sourcePosition Object (オプション)追加バージョン: v1.14#
  - x number
  - y number
  要素のパディングボックスの左上隅を基準としたこの位置で、ソース要素をクリックします。指定しない場合、要素の可視点が使用されます。
- strict boolean (オプション)追加バージョン: v1.14#
  
  trueの場合、この呼び出しでは、セレクターが単一の要素に解決される必要があります。指定されたセレクターが複数の要素に解決される場合、この呼び出しは例外をスローします。
- targetPosition Object (オプション)追加バージョン: v1.14#
  - x number
  - y number
  要素のパディングボックスの左上隅を基準としたこの位置で、ターゲット要素にドロップします。指定しない場合、要素の可視点が使用されます。
- timeout number (オプション)#
  
  最大時間（ミリ秒単位）。デフォルトは 0 - タイムアウトなし。デフォルト値は、configの actionTimeout オプション、または browserContext.setDefaultTimeout() メソッドまたは page.setDefaultTimeout() メソッドを使用して変更できます。
- trial boolean (オプション)#
  
  設定すると、このメソッドは実行可能性チェックのみを実行し、アクションをスキップします。デフォルトは false です。アクションを実行せずに、要素がアクションの準備ができるまで待機するのに役立ちます。

戻り値

Promise<void>#

evaluate

v1.9より前に追加

frame.evaluate

pageFunction の戻り値を返します。

frame.evaluate() に渡された関数が Promise を返す場合、frame.evaluate() はPromiseが解決されるのを待って、その値を返します。

frame.evaluate() に渡された関数がシリアライズ可能でない値を返す場合、frame.evaluate() は undefined を返します。Playwrightは、JSON でシリアライズできない追加の値（-0、NaN、Infinity、-Infinity）の転送もサポートしています。

使用法

const result = await frame.evaluate(([x, y]) => {
  return Promise.resolve(x * y);
}, [7, 8]);
console.log(result); // prints "56"

関数の代わりに文字列を渡すこともできます。

console.log(await frame.evaluate('1 + 2')); // prints "3"

ElementHandle インスタンスは、frame.evaluate() の引数として渡すことができます。

const bodyHandle = await frame.evaluate('document.body');
const html = await frame.evaluate(([body, suffix]) =>
  body.innerHTML + suffix, [bodyHandle, 'hello'],
);
await bodyHandle.dispose();

引数

pageFunction function | string #

ページコンテキストで評価される関数。
arg EvaluationArgument (オプション)#

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

戻り値

Promise<Serializable>#

evaluateHandle

v1.9より前に追加

frame.evaluateHandle

pageFunction の戻り値を JSHandle として返します。

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

frame.evaluateHandle() に渡された関数が Promise を返す場合、frame.evaluateHandle() はPromiseが解決されるのを待って、その値を返します。

使用法

// Handle for the window object
const aWindowHandle = await frame.evaluateHandle(() => Promise.resolve(window));

関数の代わりに文字列を渡すこともできます。

const aHandle = await frame.evaluateHandle('document'); // Handle for the 'document'.

JSHandle インスタンスは、frame.evaluateHandle() の引数として渡すことができます。

const aHandle = await frame.evaluateHandle(() => document.body);
const resultHandle = await frame.evaluateHandle(([body, suffix]) =>
  body.innerHTML + suffix, [aHandle, 'hello'],
);
console.log(await resultHandle.jsonValue());
await resultHandle.dispose();

引数

pageFunction function | string #

ページコンテキストで評価される関数。
arg EvaluationArgument (オプション)#

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

戻り値

Promise<JSHandle>#

frameElement

v1.9より前に追加

frame.frameElement

このフレームに対応する frame または iframe 要素ハンドルを返します。

これは elementHandle.contentFrame() の逆です。返されるハンドルは実際には親フレームに属していることに注意してください。

このメソッドは、frameElement() が戻る前にフレームがデタッチされた場合、エラーをスローします。

使用法

const frameElement = await frame.frameElement();
const contentFrame = await frameElement.contentFrame();
console.log(frame === contentFrame);  // -> true

戻り値

Promise<ElementHandle>#

frameLocator

追加バージョン: v1.17

frame.frameLocator

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

使用法

次のスニペットは、<iframe id="my-frame"> のように、id my-frame を持つiframe内の "Submit" というテキストを持つ要素を特定します。

const locator = frame.frameLocator('#my-iframe').getByText('Submit');
await locator.click();

引数

selector string #

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

戻り値

FrameLocator #

getByAltText

追加バージョン: v1.27

frame.getByAltText

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

使用法

たとえば、このメソッドはaltテキスト "Playwright logo" で画像を検索します。

<img alt='Playwright logo'>

await page.getByAltText('Playwright logo').click();

引数

text string | RegExp #

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

戻り値

Locator #

getByLabel

追加バージョン: v1.27

frame.getByLabel

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

使用法

たとえば、このメソッドは次のDOMでラベル "Username" および "Password" で入力を検索します。

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

await page.getByLabel('Username').fill('john');
await page.getByLabel('Password').fill('secret');

引数

text string | RegExp #

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

戻り値

Locator #

getByPlaceholder

追加バージョン: v1.27

frame.getByPlaceholder

プレースホルダーテキストで入力要素を特定できます。

使用法

たとえば、次のDOM構造を考えてください。

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

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

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

引数

text string | RegExp #

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

戻り値

Locator #

getByRole

追加バージョン: v1.27

frame.getByRole

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

使用法

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

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

各要素を暗黙的なロールで特定できます。

await expect(page.getByRole('heading', { name: 'Sign up' })).toBeVisible();

await page.getByRole('checkbox', { name: 'Subscribe' }).check();

await page.getByRole('button', { name: /submit/i }).click();

引数

role "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 Object (オプション)
- checked boolean (オプション)#
  
  通常、aria-checked またはネイティブ <input type=checkbox> コントロールによって設定される属性。
  
  aria-checked の詳細をご覧ください。
- disabled boolean (オプション)#
  
  通常、aria-disabled または disabled によって設定される属性。
  
  注
  他のほとんどの属性とは異なり、disabled はDOM階層を介して継承されます。aria-disabled の詳細をご覧ください。
- exact boolean (オプション)追加バージョン: v1.28#
  
  name が完全に一致するかどうか：大文字と小文字を区別し、文字列全体を比較します。デフォルトはfalseです。name が正規表現の場合は無視されます。完全一致でも空白文字はトリムされることに注意してください。
- expanded boolean (オプション)#
  
  通常、aria-expanded によって設定される属性。
  
  aria-expanded の詳細をご覧ください。
- includeHidden boolean (オプション)#
  
  非表示要素を一致させるかどうかを制御するオプション。デフォルトでは、ARIA で定義されているように、非表示でない要素のみがロールセレクターによって一致します。
  
  aria-hidden の詳細をご覧ください。
- level number (オプション)#
  
  通常、heading、listitem、row、treeitem ロールに存在する数値属性。<h1>-<h6> 要素のデフォルト値。
  
  aria-level の詳細をご覧ください。
- name string | RegExp (オプション)#
  
  アクセシブルネームを一致させるオプション。デフォルトでは、マッチングは大文字と小文字を区別せず、部分文字列を検索します。exact を使用してこの動作を制御します。
  
  アクセシブルネームの詳細をご覧ください。
- pressed boolean (オプション)#
  
  通常、aria-pressed によって設定される属性。
  
  aria-pressed の詳細をご覧ください。
- selected boolean (オプション)#
  
  通常、aria-selected によって設定される属性。
  
  aria-selected の詳細をご覧ください。

戻り値

Locator #

詳細

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

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

getByTestId

追加バージョン: v1.27

frame.getByTestId

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

使用法

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

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

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

await page.getByTestId('directions').click();

引数

testId string | RegExp #

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

戻り値

Locator #

詳細

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

// Set custom test id attribute from @playwright/test config:
import { defineConfig } from '@playwright/test';

export default defineConfig({
  use: {
    testIdAttribute: 'data-pw'
  },
});

getByText

追加バージョン: v1.27

frame.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', { exact: true });

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

// Matches second <div>
page.getByText(/^hello$/i);

引数

text string | RegExp #

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

戻り値

Locator #

詳細

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

button および submit タイプの入力要素は、テキストコンテンツの代わりに value によってマッチングされます。例えば、テキスト "Log in" で位置を特定すると、<input type=button value="Log in"> にマッチングします。

getByTitle

追加バージョン: v1.27

frame.getByTitle

title属性で要素を特定できます。

使用法

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

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

タイトルのテキストで位置を特定した後、問題の数を確認できます

await expect(page.getByTitle('Issues count')).toHaveText('25 issues');

引数

text string | RegExp #

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

戻り値

Locator #

goto

v1.9より前に追加

frame.goto

メインリソースのレスポンスを返します。複数のリダイレクトがある場合、ナビゲーションは最後のリダイレクトのレスポンスで解決されます。

このメソッドは、以下の場合にエラーをスローします。

SSLエラーがある場合（自己署名証明書の場合など）。
ターゲットURLが無効な場合。
timeout がナビゲーション中に超過した場合。
リモートサーバーが応答しないか、到達不能な場合。
メインリソースのロードに失敗した場合。

このメソッドは、リモートサーバーから有効なHTTPステータスコード（404 "Not Found" や 500 "Internal Server Error" を含む）が返された場合、エラーをスローしません。このようなレスポンスのステータスコードは、response.status() を呼び出すことで取得できます。

注

このメソッドは、エラーをスローするか、メインリソースのレスポンスを返します。唯一の例外は、about:blank へのナビゲーション、またはハッシュが異なる同じURLへのナビゲーションで、これらは成功し、null を返します。

注

ヘッドレスモードでは、PDFドキュメントへのナビゲーションはサポートされていません。 upstream issue を参照してください。

使用法

await frame.goto(url);
await frame.goto(url, options);

引数

url string #

フレームをナビゲートするURL。URLにはスキーム（例: https://）を含める必要があります。
options Object (オプション)
- referer string (オプション)#
  
  Refererヘッダーの値。page.setExtraHTTPHeaders() で設定されたrefererヘッダー値よりも優先されます（提供されている場合）。
- timeout number (オプション)#
  
  最大操作時間（ミリ秒単位）。デフォルトは 0 - タイムアウトなし。デフォルト値は、config の navigationTimeout オプション、または browserContext.setDefaultNavigationTimeout(), browserContext.setDefaultTimeout(), page.setDefaultNavigationTimeout() または page.setDefaultTimeout() メソッドを使用して変更できます。
- waitUntil "load" | "domcontentloaded" | "networkidle" | "commit" (オプション)#
  
  操作が成功したと見なすタイミング。デフォルトは load。イベントは以下のいずれかです。
  - 'domcontentloaded' - DOMContentLoaded イベントが発行されたときに操作が完了したと見なします。
  - 'load' - load イベントが発行されたときに操作が完了したと見なします。
  - 'networkidle' - 非推奨 ネットワーク接続が少なくとも 500 ms なくなったときに操作が完了したと見なします。テストにはこのメソッドを使用せず、代わりに準備状態を評価するためにウェブアサーションに依存してください。
  - 'commit' - ネットワークレスポンスが受信され、ドキュメントのロードが開始されたときに操作が完了したと見なします。

戻り値

Promise<null | Response>#

isDetached

v1.9より前に追加

frame.isDetached

フレームがデタッチされている場合は true、そうでない場合は false を返します。

使用法

frame.isDetached();

戻り値

boolean #

isEnabled

v1.9より前に追加

frame.isEnabled

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

使用法

await frame.isEnabled(selector);
await frame.isEnabled(selector, options);

引数

selector string #

要素を検索するセレクター。セレクターに一致する要素が複数ある場合は、最初の要素が使用されます。
options Object (オプション)
- strict boolean (オプション)追加バージョン: v1.14#
  
  trueの場合、この呼び出しでは、セレクターが単一の要素に解決される必要があります。指定されたセレクターが複数の要素に解決される場合、この呼び出しは例外をスローします。
- timeout number (オプション)#
  
  最大時間（ミリ秒単位）。デフォルトは 0 - タイムアウトなし。デフォルト値は、configの actionTimeout オプション、または browserContext.setDefaultTimeout() メソッドまたは page.setDefaultTimeout() メソッドを使用して変更できます。

戻り値

Promise<boolean>#

locator

追加バージョン: v1.14

frame.locator

このメソッドは、このページ/フレームでアクションを実行するために使用できる要素ロケーターを返します。ロケーターは、アクションを実行する直前に要素に解決されるため、同じロケーターに対する一連のアクションは、実際には異なるDOM要素で実行される可能性があります。これは、それらのアクション間のDOM構造が変更された場合に発生します。

ロケーターの詳細はこちら.

使用法

frame.locator(selector);
frame.locator(selector, options);

引数

selector string #

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

戻り値

Locator #

name

v1.9より前に追加

frame.name

タグで指定されたフレームの名前属性を返します。

名前が空の場合、代わりにid属性を返します。

注

この値は、フレームが作成されたときに一度計算され、後で属性が変更されても更新されません。

使用法

frame.name();

戻り値

string #

page

v1.9より前に追加

frame.page

このフレームを含むページを返します。

使用法

frame.page();

戻り値

Page #

parentFrame

v1.9より前に追加

frame.parentFrame

親フレーム（存在する場合）。デタッチされたフレームとメインフレームは null を返します。

使用法

frame.parentFrame();

戻り値

null | Frame #

setContent

v1.9より前に追加

frame.setContent

このメソッドは、内部的に document.write() を呼び出し、そのすべての特定の特性と動作を継承します。

使用法

await frame.setContent(html);
await frame.setContent(html, options);

引数

html string #

ページに割り当てるHTMLマークアップ。
options Object (オプション)
- timeout number (オプション)#
  
  最大操作時間（ミリ秒単位）。デフォルトは 0 - タイムアウトなし。デフォルト値は、config の navigationTimeout オプション、または browserContext.setDefaultNavigationTimeout(), browserContext.setDefaultTimeout(), page.setDefaultNavigationTimeout() または page.setDefaultTimeout() メソッドを使用して変更できます。
- waitUntil "load" | "domcontentloaded" | "networkidle" | "commit" (オプション)#
  
  操作が成功したと見なすタイミング。デフォルトは load。イベントは以下のいずれかです。
  - 'domcontentloaded' - DOMContentLoaded イベントが発行されたときに操作が完了したと見なします。
  - 'load' - load イベントが発行されたときに操作が完了したと見なします。
  - 'networkidle' - 非推奨 ネットワーク接続が少なくとも 500 ms なくなったときに操作が完了したと見なします。テストにはこのメソッドを使用せず、代わりに準備状態を評価するためにウェブアサーションに依存してください。
  - 'commit' - ネットワークレスポンスが受信され、ドキュメントのロードが開始されたときに操作が完了したと見なします。

戻り値

Promise<void>#

title

v1.9より前に追加

frame.title

ページタイトルを返します。

使用法

await frame.title();

戻り値

Promise<string>#

url

v1.9より前に追加

frame.url

フレームのURLを返します。

使用法

frame.url();

戻り値

string #

waitForFunction

v1.9より前に追加

frame.waitForFunction

pageFunction が真の値を返すと、その値を返します。

使用法

frame.waitForFunction() は、ビューポートサイズの変更を監視するために使用できます

const { firefox } = require('playwright');  // Or 'chromium' or 'webkit'.

(async () => {
  const browser = await firefox.launch();
  const page = await browser.newPage();
  const watchDog = page.mainFrame().waitForFunction('window.innerWidth < 100');
  await page.setViewportSize({ width: 50, height: 50 });
  await watchDog;
  await browser.close();
})();

frame.waitForFunction 関数の述語に引数を渡すには

const selector = '.foo';
await frame.waitForFunction(selector => !!document.querySelector(selector), selector);

引数

pageFunction function | string #

ページコンテキストで評価される関数。
arg EvaluationArgument (オプション)#

pageFunction に渡すオプションの引数。
options Object (オプション)
- polling number | "raf" (オプション)#
  
  polling が 'raf' の場合、pageFunction は requestAnimationFrame コールバックで継続的に実行されます。polling が数値の場合、関数が実行される間隔（ミリ秒単位）として扱われます。デフォルトは raf です。
- timeout number (オプション)#
  
  最大待機時間（ミリ秒単位）。デフォルトは 0 - タイムアウトなし。デフォルト値は、config の actionTimeout オプション、または browserContext.setDefaultTimeout() または page.setDefaultTimeout() メソッドを使用して変更できます。

戻り値

Promise<JSHandle>#

waitForLoadState

v1.9より前に追加

frame.waitForLoadState

必要なロード状態に達するまで待機します。

これは、フレームが必要なロード状態（デフォルトでは load）に達すると返されます。ナビゲーションは、このメソッドが呼び出されたときにコミットされている必要があります。現在のドキュメントがすでに必要な状態に達している場合は、すぐに解決されます。

注

ほとんどの場合、Playwrightはすべてのアクションの前に自動的に待機するため、このメソッドは必要ありません。

使用法

await frame.click('button'); // Click triggers navigation.
await frame.waitForLoadState(); // Waits for 'load' state by default.

引数

state "load" | "domcontentloaded" | "networkidle" (オプション)#

待機するオプションのロード状態。デフォルトは load。現在のドキュメントのロード中に状態がすでに到達している場合、メソッドはすぐに解決されます。以下のいずれかになります。
- 'load' - load イベントが発行されるのを待ちます。
- 'domcontentloaded' - DOMContentLoaded イベントが発行されるのを待ちます。
- 'networkidle' - 非推奨 ネットワーク接続が少なくとも 500 ms なくなるまで待ちます。テストにはこのメソッドを使用せず、代わりに準備状態を評価するためにウェブアサーションに依存してください。
options Object (オプション)
- timeout number (オプション)#
  
  最大操作時間（ミリ秒単位）。デフォルトは 0 - タイムアウトなし。デフォルト値は、config の navigationTimeout オプション、または browserContext.setDefaultNavigationTimeout(), browserContext.setDefaultTimeout(), page.setDefaultNavigationTimeout() または page.setDefaultTimeout() メソッドを使用して変更できます。

戻り値

Promise<void>#

waitForURL

追加: v1.11

frame.waitForURL

フレームが指定されたURLにナビゲートするのを待ちます。

使用法

await frame.click('a.delayed-navigation'); // Clicking the link will indirectly cause a navigation
await frame.waitForURL('**/target.html');

引数

url string | RegExp | function(URL):boolean #

ナビゲーションを待機中に一致させるためのグロブパターン、正規表現パターン、または URL を受信する述語。パラメータがワイルドカード文字を含まない文字列である場合、メソッドは文字列と完全に等しいURLへのナビゲーションを待機することに注意してください。
options Object (オプション)
- timeout number (オプション)#
  
  最大操作時間（ミリ秒単位）。デフォルトは 0 - タイムアウトなし。デフォルト値は、config の navigationTimeout オプション、または browserContext.setDefaultNavigationTimeout(), browserContext.setDefaultTimeout(), page.setDefaultNavigationTimeout() または page.setDefaultTimeout() メソッドを使用して変更できます。
- waitUntil "load" | "domcontentloaded" | "networkidle" | "commit" (オプション)#
  
  操作が成功したと見なすタイミング。デフォルトは load。イベントは以下のいずれかです。
  - 'domcontentloaded' - DOMContentLoaded イベントが発行されたときに操作が完了したと見なします。
  - 'load' - load イベントが発行されたときに操作が完了したと見なします。
  - 'networkidle' - 非推奨 ネットワーク接続が少なくとも 500 ms なくなったときに操作が完了したと見なします。テストにはこのメソッドを使用せず、代わりに準備状態を評価するためにウェブアサーションに依存してください。
  - 'commit' - ネットワークレスポンスが受信され、ドキュメントのロードが開始されたときに操作が完了したと見なします。

戻り値

Promise<void>#

非推奨

$

追加: v1.9

frame.$

非推奨

代わりにロケーターベースの frame.locator() を使用してください。ロケーターの詳細をご覧ください。

フレーム要素を指す ElementHandle を返します。

注意

ElementHandle の使用は推奨されません。代わりに Locator オブジェクトとウェブファーストアサーションを使用してください。

このメソッドは、フレーム内で指定されたセレクターに一致する要素を見つけます。セレクターに一致する要素がない場合、null を返します。

使用法

await frame.$(selector);
await frame.$(selector, options);

引数

selector string #

クエリするセレクター。
options Object (オプション)
- strict boolean (オプション)追加バージョン: v1.14#
  
  trueの場合、この呼び出しでは、セレクターが単一の要素に解決される必要があります。指定されたセレクターが複数の要素に解決される場合、この呼び出しは例外をスローします。

戻り値

Promise<null | ElementHandle>#

$$

追加: v1.9

frame.$$

非推奨

代わりにロケーターベースの frame.locator() を使用してください。ロケーターの詳細をご覧ください。

フレーム要素を指す ElementHandle を返します。

注意

ElementHandle の使用は推奨されません。代わりに Locator オブジェクトを使用してください。

このメソッドは、フレーム内で指定されたセレクターに一致するすべての要素を見つけます。セレクターに一致する要素がない場合、空の配列を返します。

使用法

await frame.$$(selector);

引数

selector string #

クエリするセレクター。

戻り値

Promise<Array<ElementHandle>>#

$eval

追加: v1.9

frame.$eval

非推奨

このメソッドは、要素が操作性チェックに合格するのを待機しないため、テストが不安定になる可能性があります。代わりに locator.evaluate()、その他の Locator ヘルパーメソッド、またはウェブファーストアサーションを使用してください。

pageFunction の戻り値を返します。

このメソッドは、フレーム内で指定されたセレクターに一致する要素を見つけ、それを最初の引数として pageFunction に渡します。セレクターに一致する要素がない場合、メソッドはエラーをスローします。

pageFunction が Promise を返す場合、frame.$eval() はPromiseが解決されるのを待機し、その値を返します。

使用法

const searchValue = await frame.$eval('#search', el => el.value);
const preloadHref = await frame.$eval('link[rel=preload]', el => el.href);
const html = await frame.$eval('.main-container', (e, suffix) => e.outerHTML + suffix, 'hello');

引数

selector string #

クエリするセレクター。
pageFunction function(Element) | string #

ページコンテキストで評価される関数。
arg EvaluationArgument (オプション)#

pageFunction に渡すオプションの引数。
options Object (オプション)
- strict boolean (オプション)追加バージョン: v1.14#
  
  trueの場合、この呼び出しでは、セレクターが単一の要素に解決される必要があります。指定されたセレクターが複数の要素に解決される場合、この呼び出しは例外をスローします。

戻り値

Promise<Serializable>#

$$eval

追加: v1.9

frame.$$eval

非推奨

ほとんどの場合、locator.evaluateAll()、その他の Locator ヘルパーメソッド、およびウェブファーストアサーションの方が適しています。

pageFunction の戻り値を返します。

このメソッドは、フレーム内で指定されたセレクターに一致するすべての要素を見つけ、一致した要素の配列を最初の引数として pageFunction に渡します。

pageFunction が Promise を返す場合、frame.$$eval() はPromiseが解決されるのを待機し、その値を返します。

使用法

const divsCounts = await frame.$$eval('div', (divs, min) => divs.length >= min, 10);

引数

selector string #

クエリするセレクター。
pageFunction function(Array<Element>) | string #

ページコンテキストで評価される関数。
arg EvaluationArgument (オプション)#

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

戻り値

Promise<Serializable>#

check

v1.9より前に追加

frame.check

非推奨

代わりにロケーターベースの locator.check() を使用してください。ロケーターの詳細をご覧ください。

このメソッドは、selector に一致する要素を、以下の手順でチェックします。

selector に一致する要素を見つけます。存在しない場合は、一致する要素が DOM に追加されるまで待機します。
一致した要素がチェックボックスまたはラジオ入力であることを確認します。そうでない場合、このメソッドは例外をスローします。要素がすでにチェックされている場合、このメソッドはすぐに返ります。
操作可能性チェックが、force オプションが設定されていない限り、一致した要素に対して実行されるのを待ちます。チェック中に要素がデタッチされた場合、アクション全体が再試行されます。
必要に応じて、要素をビューにスクロールします。
page.mouse を使用して、要素の中央をクリックします。
要素がチェックされたことを確認します。そうでない場合、このメソッドは例外をスローします。

指定された timeout 時間内にすべての手順が完了しなかった場合、このメソッドは TimeoutError をスローします。タイムアウトにゼロを渡すと、これが無効になります。

使用法

await frame.check(selector);
await frame.check(selector, options);

引数

selector string #

要素を検索するセレクター。セレクターに一致する要素が複数ある場合は、最初の要素が使用されます。
options Object (オプション)
- force boolean (オプション)#
  
  実行可能性チェックをバイパスするかどうか。デフォルトは false です。
- noWaitAfter boolean (オプション)#
  
  非推奨
  このオプションは効果がありません。
  
  このオプションは効果がありません。
- position Object (オプション)追加: v1.11#
  - x number
  - y number
  要素のパディングボックスの左上隅を基準に使用するポイント。指定しない場合は、要素の可視点を使用します。
- strict boolean (オプション)追加バージョン: v1.14#
  
  trueの場合、この呼び出しでは、セレクターが単一の要素に解決される必要があります。指定されたセレクターが複数の要素に解決される場合、この呼び出しは例外をスローします。
- timeout number (オプション)#
  
  最大時間（ミリ秒単位）。デフォルトは 0 - タイムアウトなし。デフォルト値は、configの actionTimeout オプション、または browserContext.setDefaultTimeout() メソッドまたは page.setDefaultTimeout() メソッドを使用して変更できます。
- trial boolean (オプション)追加: v1.11#
  
  設定すると、このメソッドは実行可能性チェックのみを実行し、アクションをスキップします。デフォルトは false です。アクションを実行せずに、要素がアクションの準備ができるまで待機するのに役立ちます。

戻り値

Promise<void>#

click

v1.9より前に追加

frame.click

非推奨

代わりにロケーターベースの locator.click() を使用してください。ロケーターの詳細をお読みください。

このメソッドは、selector に一致する要素を、以下の手順でクリックします。

selector に一致する要素を見つけます。存在しない場合は、一致する要素が DOM に追加されるまで待機します。
操作可能性チェックが、force オプションが設定されていない限り、一致した要素に対して実行されるのを待ちます。チェック中に要素がデタッチされた場合、アクション全体が再試行されます。
必要に応じて、要素をビューにスクロールします。
page.mouse を使用して、要素の中央、または指定された position をクリックします。
noWaitAfter オプションが設定されていない限り、開始されたナビゲーションが成功または失敗するのを待ちます。

使用法

await frame.click(selector);
await frame.click(selector, options);

引数

selector string #

要素を検索するセレクター。セレクターに一致する要素が複数ある場合は、最初の要素が使用されます。
options Object (オプション)
- button "left" | "right" | "middle" (オプション)#
  
  デフォルトは left です。
- clickCount number (オプション)#
  
  デフォルトは 1 です。UIEvent.detail を参照してください。
- delay number (オプション)#
  
  mousedown と mouseup の間の待機時間（ミリ秒）。デフォルトは 0 です。
- force boolean (オプション)#
  
  実行可能性チェックをバイパスするかどうか。デフォルトは false です。
- modifiers Array<"Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift"> (オプション)#
  
  押すモディファイキー。操作中にこれらのモディファイキーのみが押されていることを確認し、その後、現在のモディファイキーを元に戻します。指定しない場合、現在押されているモディファイキーが使用されます。"ControlOrMeta" は、Windows および Linux では "Control" に、macOS では "Meta" に解決されます。
- noWaitAfter boolean (オプション)#
  
  非推奨
  このオプションは、将来 true がデフォルトになります。
  
  ナビゲーションを開始するアクションは、これらのナビゲーションが発生し、ページのロードが開始されるのを待機しています。このフラグを設定することで、待機をオプトアウトできます。このオプションは、アクセスできないページにナビゲートする場合など、例外的な場合にのみ必要になります。デフォルトは false です。
- position Object (オプション)#
  - x number
  - y number
  要素のパディングボックスの左上隅を基準に使用するポイント。指定しない場合は、要素の可視点を使用します。
- strict boolean (オプション)追加バージョン: v1.14#
  
  trueの場合、この呼び出しでは、セレクターが単一の要素に解決される必要があります。指定されたセレクターが複数の要素に解決される場合、この呼び出しは例外をスローします。
- timeout number (オプション)#
  
  最大時間（ミリ秒単位）。デフォルトは 0 - タイムアウトなし。デフォルト値は、configの actionTimeout オプション、または browserContext.setDefaultTimeout() メソッドまたは page.setDefaultTimeout() メソッドを使用して変更できます。
- trial boolean (オプション)追加: v1.11#
  
  設定すると、このメソッドは操作可能性チェックのみを実行し、アクションをスキップします。デフォルトは false です。要素がアクションを実行する準備ができるまで待機する場合に便利です。キーボードの modifiers は、それらのキーが押されたときにのみ表示される要素をテストできるように、trial に関係なく押されることに注意してください。

戻り値

Promise<void>#

dblclick

v1.9より前に追加

frame.dblclick

非推奨

代わりにロケーターベースの locator.dblclick() を使用してください。ロケーターの詳細をお読みください。

このメソッドは、selector に一致する要素を、以下の手順でダブルクリックします。

selector に一致する要素を見つけます。存在しない場合は、一致する要素が DOM に追加されるまで待機します。
操作可能性チェックが、force オプションが設定されていない限り、一致した要素に対して実行されるのを待ちます。チェック中に要素がデタッチされた場合、アクション全体が再試行されます。
必要に応じて、要素をビューにスクロールします。
page.mouse を使用して、要素の中央、または指定された position をダブルクリックします。dblclick() の最初のクリックがナビゲーションイベントをトリガーした場合、このメソッドは例外をスローします。

注

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

使用法

await frame.dblclick(selector);
await frame.dblclick(selector, options);

引数

selector string #

要素を検索するセレクター。セレクターに一致する要素が複数ある場合は、最初の要素が使用されます。
options Object (オプション)
- button "left" | "right" | "middle" (オプション)#
  
  デフォルトは left です。
- delay number (オプション)#
  
  mousedown と mouseup の間の待機時間（ミリ秒）。デフォルトは 0 です。
- force boolean (オプション)#
  
  実行可能性チェックをバイパスするかどうか。デフォルトは false です。
- modifiers Array<"Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift"> (オプション)#
  
  押すモディファイキー。操作中にこれらのモディファイキーのみが押されていることを確認し、その後、現在のモディファイキーを元に戻します。指定しない場合、現在押されているモディファイキーが使用されます。"ControlOrMeta" は、Windows および Linux では "Control" に、macOS では "Meta" に解決されます。
- noWaitAfter boolean (オプション)#
  
  非推奨
  このオプションは効果がありません。
  
  このオプションは効果がありません。
- position Object (オプション)#
  - x number
  - y number
  要素のパディングボックスの左上隅を基準に使用するポイント。指定しない場合は、要素の可視点を使用します。
- strict boolean (オプション)追加バージョン: v1.14#
  
  trueの場合、この呼び出しでは、セレクターが単一の要素に解決される必要があります。指定されたセレクターが複数の要素に解決される場合、この呼び出しは例外をスローします。
- timeout number (オプション)#
  
  最大時間（ミリ秒単位）。デフォルトは 0 - タイムアウトなし。デフォルト値は、configの actionTimeout オプション、または browserContext.setDefaultTimeout() メソッドまたは page.setDefaultTimeout() メソッドを使用して変更できます。
- trial boolean (オプション)追加: v1.11#
  
  設定すると、このメソッドは操作可能性チェックのみを実行し、アクションをスキップします。デフォルトは false です。要素がアクションを実行する準備ができるまで待機する場合に便利です。キーボードの modifiers は、それらのキーが押されたときにのみ表示される要素をテストできるように、trial に関係なく押されることに注意してください。

戻り値

Promise<void>#

dispatchEvent

v1.9より前に追加

frame.dispatchEvent

非推奨

代わりにロケーターベースの locator.dispatchEvent() を使用してください。ロケーターの詳細をお読みください。

以下のスニペットは、要素に click イベントをディスパッチします。要素の可視状態に関係なく、click がディスパッチされます。これは、element.click() を呼び出すことと同等です。

使用法

await frame.dispatchEvent('button#submit', 'click');

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

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

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

// Note you can only create DataTransfer in Chromium and Firefox
const dataTransfer = await frame.evaluateHandle(() => new DataTransfer());
await frame.dispatchEvent('#source', 'dragstart', { dataTransfer });

引数

selector string #

要素を検索するセレクター。セレクターに一致する要素が複数ある場合は、最初の要素が使用されます。
type string #

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

オプションのイベント固有の初期化プロパティ。
options Object (オプション)
- strict boolean (オプション)追加バージョン: v1.14#
  
  trueの場合、この呼び出しでは、セレクターが単一の要素に解決される必要があります。指定されたセレクターが複数の要素に解決される場合、この呼び出しは例外をスローします。
- timeout number (オプション)#
  
  最大時間（ミリ秒単位）。デフォルトは 0 - タイムアウトなし。デフォルト値は、configの actionTimeout オプション、または browserContext.setDefaultTimeout() メソッドまたは page.setDefaultTimeout() メソッドを使用して変更できます。

戻り値

Promise<void>#

fill

v1.9より前に追加

frame.fill

非推奨

代わりにロケーターベースの locator.fill() を使用してください。ロケーターの詳細をお読みください。

このメソッドは、selector に一致する要素を待機し、操作可能性チェックを待機し、要素にフォーカスを当て、それを入力し、入力後に input イベントをトリガーします。入力フィールドをクリアするために、空の文字列を渡すことができることに注意してください。

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

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

使用法

await frame.fill(selector, value);
await frame.fill(selector, value, options);

引数

selector string #

要素を検索するセレクター。セレクターに一致する要素が複数ある場合は、最初の要素が使用されます。
value string #

<input>、<textarea>、または [contenteditable] 要素に入力する値。
options Object (オプション)
- force boolean (オプション)追加バージョン: v1.13#
  
  実行可能性チェックをバイパスするかどうか。デフォルトは false です。
- noWaitAfter boolean (オプション)#
  
  非推奨
  このオプションは効果がありません。
  
  このオプションは効果がありません。
- strict boolean (オプション)追加バージョン: v1.14#
  
  trueの場合、この呼び出しでは、セレクターが単一の要素に解決される必要があります。指定されたセレクターが複数の要素に解決される場合、この呼び出しは例外をスローします。
- timeout number (オプション)#
  
  最大時間（ミリ秒単位）。デフォルトは 0 - タイムアウトなし。デフォルト値は、configの actionTimeout オプション、または browserContext.setDefaultTimeout() メソッドまたは page.setDefaultTimeout() メソッドを使用して変更できます。

戻り値

Promise<void>#

focus

v1.9より前に追加

frame.focus

非推奨

代わりにロケーターベースの locator.focus() を使用してください。ロケーターの詳細をお読みください。

このメソッドは、selector を持つ要素を取得し、それにフォーカスを当てます。selector に一致する要素がない場合、メソッドは一致する要素が DOM に表示されるまで待機します。

使用法

await frame.focus(selector);
await frame.focus(selector, options);

引数

selector string #

要素を検索するセレクター。セレクターに一致する要素が複数ある場合は、最初の要素が使用されます。
options Object (オプション)
- strict boolean (オプション)追加バージョン: v1.14#
  
  trueの場合、この呼び出しでは、セレクターが単一の要素に解決される必要があります。指定されたセレクターが複数の要素に解決される場合、この呼び出しは例外をスローします。
- timeout number (オプション)#
  
  最大時間（ミリ秒単位）。デフォルトは 0 - タイムアウトなし。デフォルト値は、configの actionTimeout オプション、または browserContext.setDefaultTimeout() メソッドまたは page.setDefaultTimeout() メソッドを使用して変更できます。

戻り値

Promise<void>#

getAttribute

v1.9より前に追加

frame.getAttribute

非推奨

代わりにロケーターベースの locator.getAttribute() を使用してください。ロケーターの詳細をお読みください。

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

使用法

await frame.getAttribute(selector, name);
await frame.getAttribute(selector, name, options);

引数

selector string #

要素を検索するセレクター。セレクターに一致する要素が複数ある場合は、最初の要素が使用されます。
name string #

値を取得する属性名。
options Object (オプション)
- strict boolean (オプション)追加バージョン: v1.14#
  
  trueの場合、この呼び出しでは、セレクターが単一の要素に解決される必要があります。指定されたセレクターが複数の要素に解決される場合、この呼び出しは例外をスローします。
- timeout number (オプション)#
  
  最大時間（ミリ秒単位）。デフォルトは 0 - タイムアウトなし。デフォルト値は、configの actionTimeout オプション、または browserContext.setDefaultTimeout() メソッドまたは page.setDefaultTimeout() メソッドを使用して変更できます。

戻り値

Promise<null | string>#

hover

v1.9より前に追加

frame.hover

非推奨

代わりにロケーターベースの locator.hover() を使用してください。ロケーターの詳細をお読みください。

このメソッドは、selector に一致する要素を、以下の手順でホバーします。

selector に一致する要素を見つけます。存在しない場合は、一致する要素が DOM に追加されるまで待機します。
操作可能性チェックが、force オプションが設定されていない限り、一致した要素に対して実行されるのを待ちます。チェック中に要素がデタッチされた場合、アクション全体が再試行されます。
必要に応じて、要素をビューにスクロールします。
page.mouse を使用して、要素の中央、または指定された position にホバーします。

使用法

await frame.hover(selector);
await frame.hover(selector, options);

引数

selector string #

要素を検索するセレクター。セレクターに一致する要素が複数ある場合は、最初の要素が使用されます。
options Object (オプション)
- force boolean (オプション)#
  
  実行可能性チェックをバイパスするかどうか。デフォルトは false です。
- modifiers Array<"Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift"> (オプション)#
  
  押すモディファイキー。操作中にこれらのモディファイキーのみが押されていることを確認し、その後、現在のモディファイキーを元に戻します。指定しない場合、現在押されているモディファイキーが使用されます。"ControlOrMeta" は、Windows および Linux では "Control" に、macOS では "Meta" に解決されます。
- noWaitAfter boolean (オプション)追加バージョン: v1.28#
  
  非推奨
  このオプションは効果がありません。
  
  このオプションは効果がありません。
- position Object (オプション)#
  - x number
  - y number
  要素のパディングボックスの左上隅を基準に使用するポイント。指定しない場合は、要素の可視点を使用します。
- strict boolean (オプション)追加バージョン: v1.14#
  
  trueの場合、この呼び出しでは、セレクターが単一の要素に解決される必要があります。指定されたセレクターが複数の要素に解決される場合、この呼び出しは例外をスローします。
- timeout number (オプション)#
  
  最大時間（ミリ秒単位）。デフォルトは 0 - タイムアウトなし。デフォルト値は、configの actionTimeout オプション、または browserContext.setDefaultTimeout() メソッドまたは page.setDefaultTimeout() メソッドを使用して変更できます。
- trial boolean (オプション)追加: v1.11#
  
  設定すると、このメソッドは操作可能性チェックのみを実行し、アクションをスキップします。デフォルトは false です。要素がアクションを実行する準備ができるまで待機する場合に便利です。キーボードの modifiers は、それらのキーが押されたときにのみ表示される要素をテストできるように、trial に関係なく押されることに注意してください。

戻り値

Promise<void>#

innerHTML

v1.9より前に追加

frame.innerHTML

非推奨

代わりにロケーターベースの locator.innerHTML() を使用してください。ロケーターの詳細をお読みください。

element.innerHTML を返します。

使用法

await frame.innerHTML(selector);
await frame.innerHTML(selector, options);

引数

selector string #

要素を検索するセレクター。セレクターに一致する要素が複数ある場合は、最初の要素が使用されます。
options Object (オプション)
- strict boolean (オプション)追加バージョン: v1.14#
  
  trueの場合、この呼び出しでは、セレクターが単一の要素に解決される必要があります。指定されたセレクターが複数の要素に解決される場合、この呼び出しは例外をスローします。
- timeout number (オプション)#
  
  最大時間（ミリ秒単位）。デフォルトは 0 - タイムアウトなし。デフォルト値は、configの actionTimeout オプション、または browserContext.setDefaultTimeout() メソッドまたは page.setDefaultTimeout() メソッドを使用して変更できます。

戻り値

Promise<string>#

innerText

v1.9より前に追加

frame.innerText

非推奨

代わりにロケーターベースの locator.innerText() を使用してください。ロケーターの詳細をお読みください。

element.innerText を返します。

使用法

await frame.innerText(selector);
await frame.innerText(selector, options);

引数

selector string #

要素を検索するセレクター。セレクターに一致する要素が複数ある場合は、最初の要素が使用されます。
options Object (オプション)
- strict boolean (オプション)追加バージョン: v1.14#
  
  trueの場合、この呼び出しでは、セレクターが単一の要素に解決される必要があります。指定されたセレクターが複数の要素に解決される場合、この呼び出しは例外をスローします。
- timeout number (オプション)#
  
  最大時間（ミリ秒単位）。デフォルトは 0 - タイムアウトなし。デフォルト値は、configの actionTimeout オプション、または browserContext.setDefaultTimeout() メソッドまたは page.setDefaultTimeout() メソッドを使用して変更できます。

戻り値

Promise<string>#

inputValue

追加バージョン: v1.13

frame.inputValue

非推奨

代わりにロケーターベースの locator.inputValue() を使用してください。ロケーターの詳細をお読みください。

選択された <input>、<textarea>、または <select> 要素の input.value を返します。

入力要素以外の場合は例外をスローします。ただし、要素が関連付けられた control を持つ <label> 要素内にある場合、control の値を返します。

使用法

await frame.inputValue(selector);
await frame.inputValue(selector, options);

引数

selector string #

要素を検索するセレクター。セレクターに一致する要素が複数ある場合は、最初の要素が使用されます。
options Object (オプション)
- strict boolean (オプション)追加バージョン: v1.14#
  
  trueの場合、この呼び出しでは、セレクターが単一の要素に解決される必要があります。指定されたセレクターが複数の要素に解決される場合、この呼び出しは例外をスローします。
- timeout number (オプション)#
  
  最大時間（ミリ秒単位）。デフォルトは 0 - タイムアウトなし。デフォルト値は、configの actionTimeout オプション、または browserContext.setDefaultTimeout() メソッドまたは page.setDefaultTimeout() メソッドを使用して変更できます。

戻り値

Promise<string>#

isChecked

v1.9より前に追加

frame.isChecked

非推奨

代わりにロケーターベースの locator.isChecked() を使用してください。ロケーターの詳細をお読みください。

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

使用法

await frame.isChecked(selector);
await frame.isChecked(selector, options);

引数

selector string #

要素を検索するセレクター。セレクターに一致する要素が複数ある場合は、最初の要素が使用されます。
options Object (オプション)
- strict boolean (オプション)追加バージョン: v1.14#
  
  trueの場合、この呼び出しでは、セレクターが単一の要素に解決される必要があります。指定されたセレクターが複数の要素に解決される場合、この呼び出しは例外をスローします。
- timeout number (オプション)#
  
  最大時間（ミリ秒単位）。デフォルトは 0 - タイムアウトなし。デフォルト値は、configの actionTimeout オプション、または browserContext.setDefaultTimeout() メソッドまたは page.setDefaultTimeout() メソッドを使用して変更できます。

戻り値

Promise<boolean>#

isDisabled

v1.9より前に追加

frame.isDisabled

非推奨

代わりにロケーターベースの locator.isDisabled() を使用してください。ロケーターの詳細をお読みください。

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

使用法

await frame.isDisabled(selector);
await frame.isDisabled(selector, options);

引数

selector string #

要素を検索するセレクター。セレクターに一致する要素が複数ある場合は、最初の要素が使用されます。
options Object (オプション)
- strict boolean (オプション)追加バージョン: v1.14#
  
  trueの場合、この呼び出しでは、セレクターが単一の要素に解決される必要があります。指定されたセレクターが複数の要素に解決される場合、この呼び出しは例外をスローします。
- timeout number (オプション)#
  
  最大時間（ミリ秒単位）。デフォルトは 0 - タイムアウトなし。デフォルト値は、configの actionTimeout オプション、または browserContext.setDefaultTimeout() メソッドまたは page.setDefaultTimeout() メソッドを使用して変更できます。

戻り値

Promise<boolean>#

isEditable

v1.9より前に追加

frame.isEditable

非推奨

代わりにロケーターベースの locator.isEditable() を使用してください。ロケーターの詳細をお読みください。

要素が編集可能かどうかを返します。

使用法

await frame.isEditable(selector);
await frame.isEditable(selector, options);

引数

selector string #

要素を検索するセレクター。セレクターに一致する要素が複数ある場合は、最初の要素が使用されます。
options Object (オプション)
- strict boolean (オプション)追加バージョン: v1.14#
  
  trueの場合、この呼び出しでは、セレクターが単一の要素に解決される必要があります。指定されたセレクターが複数の要素に解決される場合、この呼び出しは例外をスローします。
- timeout 数値 (任意)#
  
  最大時間（ミリ秒単位）。デフォルトは 0 - タイムアウトなし。デフォルト値は、configの actionTimeout オプション、または browserContext.setDefaultTimeout() メソッドまたは page.setDefaultTimeout() メソッドを使用して変更できます。

戻り値

Promise<真偽値>#

isHidden

v1.9より前に追加

frame.isHidden

非推奨

代わりにロケーターベースの locator.isHidden() を使用してください。ロケーターの詳細をご覧ください。

要素が非表示かどうかを返します。表示の反対です。要素に一致しない selector は非表示とみなされます。

使用法

await frame.isHidden(selector);
await frame.isHidden(selector, options);

引数

selector 文字列 #

要素を検索するセレクター。セレクターに一致する要素が複数ある場合は、最初の要素が使用されます。
options Object (オプション)
- strict boolean (オプション)追加バージョン: v1.14#
  
  trueの場合、この呼び出しでは、セレクターが単一の要素に解決される必要があります。指定されたセレクターが複数の要素に解決される場合、この呼び出しは例外をスローします。
- timeout 数値 (任意)#
  
  非推奨
  このオプションは無視されます。frame.isHidden() は要素が非表示になるのを待たずに、すぐに戻ります。

戻り値

Promise<真偽値>#

isVisible

v1.9より前に追加

frame.isVisible

非推奨

代わりにロケーターベースの locator.isVisible() を使用してください。ロケーターの詳細をご覧ください。

要素が表示されているかどうかを返します。要素に一致しない selector は非表示とみなされます。

使用法

await frame.isVisible(selector);
await frame.isVisible(selector, options);

引数

selector 文字列 #

要素を検索するセレクター。セレクターに一致する要素が複数ある場合は、最初の要素が使用されます。
options Object (オプション)
- strict boolean (オプション)追加バージョン: v1.14#
  
  trueの場合、この呼び出しでは、セレクターが単一の要素に解決される必要があります。指定されたセレクターが複数の要素に解決される場合、この呼び出しは例外をスローします。
- timeout 数値 (任意)#
  
  非推奨
  このオプションは無視されます。frame.isVisible() は要素が表示されるのを待たずに、すぐに戻ります。

戻り値

Promise<真偽値>#

press

v1.9より前に追加

frame.press

非推奨

代わりにロケーターベースの locator.press() を使用してください。ロケーターの詳細をご覧ください。

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" などのショートカットもサポートされています。修飾子で指定すると、後続のキーが押されている間、修飾子が押されたままになります。

使用法

await frame.press(selector, key);
await frame.press(selector, key, options);

引数

selector 文字列 #

要素を検索するセレクター。セレクターに一致する要素が複数ある場合は、最初の要素が使用されます。
key 文字列 #

押すキーの名前または生成する文字 (ArrowLeft や a など)。
options Object (オプション)
- delay 数値 (任意)#
  
  keydown と keyup の間の待ち時間 (ミリ秒単位)。デフォルトは 0 です。
- noWaitAfter 真偽値 (任意)#
  
  非推奨
  このオプションは、将来 true がデフォルトになります。
  
  ナビゲーションを開始するアクションは、これらのナビゲーションが発生し、ページのロードが開始されるのを待機しています。このフラグを設定することで、待機をオプトアウトできます。このオプションは、アクセスできないページにナビゲートする場合など、例外的な場合にのみ必要になります。デフォルトは false です。
- strict boolean (オプション)追加バージョン: v1.14#
  
  trueの場合、この呼び出しでは、セレクターが単一の要素に解決される必要があります。指定されたセレクターが複数の要素に解決される場合、この呼び出しは例外をスローします。
- timeout 数値 (任意)#
  
  最大時間（ミリ秒単位）。デフォルトは 0 - タイムアウトなし。デフォルト値は、configの actionTimeout オプション、または browserContext.setDefaultTimeout() メソッドまたは page.setDefaultTimeout() メソッドを使用して変更できます。

戻り値

Promise<void>#

selectOption

v1.9より前に追加

frame.selectOption

非推奨

代わりにロケーターベースの locator.selectOption() を使用してください。ロケーターの詳細をご覧ください。

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

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

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

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

使用法

// Single selection matching the value or label
frame.selectOption('select#colors', 'blue');

// single selection matching both the value and the label
frame.selectOption('select#colors', { label: 'Blue' });

// multiple selection
frame.selectOption('select#colors', 'red', 'green', 'blue');

引数

selector 文字列 #

クエリするセレクター。
values null | 文字列 | ElementHandle | Array<文字列> | Object | Array<ElementHandle> | Array<Object>#
- value 文字列 (任意)
  
  option.value で一致させます。任意。
- label 文字列 (任意)
  
  option.label で一致させます。任意。
- index 数値 (任意)
  
  インデックスで一致させます。任意。
選択するオプション。<select> に multiple 属性がある場合、一致するすべてのオプションが選択されます。それ以外の場合は、渡されたオプションのいずれかに一致する最初のオプションのみが選択されます。文字列値は、値とラベルの両方に一致します。指定されたすべてのプロパティが一致する場合、オプションは一致すると見なされます。
options Object (オプション)
- force boolean (オプション)追加バージョン: v1.13#
  
  実行可能性チェックをバイパスするかどうか。デフォルトは false です。
- noWaitAfter 真偽値 (任意)#
  
  非推奨
  このオプションは効果がありません。
  
  このオプションは効果がありません。
- strict boolean (オプション)追加バージョン: v1.14#
  
  trueの場合、この呼び出しでは、セレクターが単一の要素に解決される必要があります。指定されたセレクターが複数の要素に解決される場合、この呼び出しは例外をスローします。
- timeout 数値 (任意)#
  
  最大時間（ミリ秒単位）。デフォルトは 0 - タイムアウトなし。デフォルト値は、configの actionTimeout オプション、または browserContext.setDefaultTimeout() メソッドまたは page.setDefaultTimeout() メソッドを使用して変更できます。

戻り値

Promise<Array<文字列>>#

setChecked

追加: v1.15

frame.setChecked

非推奨

代わりにロケーターベースの locator.setChecked() を使用してください。ロケーターの詳細をご覧ください。

このメソッドは、次の手順を実行して、selector に一致する要素をチェックまたはチェック解除します。

selector に一致する要素を見つけます。存在しない場合は、一致する要素が DOM にアタッチされるまで待機します。
一致する要素がチェックボックスまたはラジオ入力であることを確認します。そうでない場合、このメソッドは例外をスローします。
要素がすでに正しいチェック状態になっている場合、このメソッドはすぐに戻ります。
force オプションが設定されていない限り、一致する要素の操作性チェックを待ちます。チェック中に要素がデタッチされた場合、アクション全体が再試行されます。
必要に応じて、要素をビューにスクロールします。
page.mouse を使用して、要素の中央をクリックします。
要素がチェックまたはチェック解除されたことを確認します。そうでない場合、このメソッドは例外をスローします。

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

使用法

await frame.setChecked(selector, checked);
await frame.setChecked(selector, checked, options);

引数

selector 文字列 #

要素を検索するセレクター。セレクターに一致する要素が複数ある場合は、最初の要素が使用されます。
checked 真偽値 #

チェックボックスをチェックまたはチェック解除するかどうか。
options Object (オプション)
- force 真偽値 (任意)#
  
  実行可能性チェックをバイパスするかどうか。デフォルトは false です。
- noWaitAfter 真偽値 (任意)#
  
  非推奨
  このオプションは効果がありません。
  
  このオプションは効果がありません。
- position Object (任意)#
  - x number
  - y number
  要素のパディングボックスの左上隅を基準に使用するポイント。指定しない場合は、要素の可視点を使用します。
- strict 真偽値 (任意)#
  
  trueの場合、この呼び出しでは、セレクターが単一の要素に解決される必要があります。指定されたセレクターが複数の要素に解決される場合、この呼び出しは例外をスローします。
- timeout 数値 (任意)#
  
  最大時間（ミリ秒単位）。デフォルトは 0 - タイムアウトなし。デフォルト値は、configの actionTimeout オプション、または browserContext.setDefaultTimeout() メソッドまたは page.setDefaultTimeout() メソッドを使用して変更できます。
- trial 真偽値 (任意)#
  
  設定すると、このメソッドは実行可能性チェックのみを実行し、アクションをスキップします。デフォルトは false です。アクションを実行せずに、要素がアクションの準備ができるまで待機するのに役立ちます。

戻り値

Promise<void>#

setInputFiles

v1.9より前に追加

frame.setInputFiles

非推奨

代わりにロケーターベースの locator.setInputFiles() を使用してください。ロケーターの詳細をご覧ください。

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

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

使用法

await frame.setInputFiles(selector, files);
await frame.setInputFiles(selector, files, options);

引数

selector 文字列 #

要素を検索するセレクター。セレクターに一致する要素が複数ある場合は、最初の要素が使用されます。
files 文字列 | Array<文字列> | Object | Array<Object>#
- name 文字列
  
  ファイル名
- mimeType 文字列
  
  ファイルタイプ
- buffer Buffer
  
  ファイルコンテンツ
options Object (オプション)
- noWaitAfter 真偽値 (任意)#
  
  非推奨
  このオプションは効果がありません。
  
  このオプションは効果がありません。
- strict boolean (オプション)追加バージョン: v1.14#
  
  trueの場合、この呼び出しでは、セレクターが単一の要素に解決される必要があります。指定されたセレクターが複数の要素に解決される場合、この呼び出しは例外をスローします。
- timeout 数値 (任意)#
  
  最大時間（ミリ秒単位）。デフォルトは 0 - タイムアウトなし。デフォルト値は、configの actionTimeout オプション、または browserContext.setDefaultTimeout() メソッドまたは page.setDefaultTimeout() メソッドを使用して変更できます。

戻り値

Promise<void>#

tap

v1.9より前に追加

frame.tap

非推奨

代わりにロケーターベースの locator.tap() を使用してください。ロケーターの詳細をご覧ください。

このメソッドは、次の手順を実行して、selector に一致する要素をタップします。

selector に一致する要素を見つけます。存在しない場合は、一致する要素が DOM にアタッチされるまで待機します。
force オプションが設定されていない限り、一致する要素の操作性チェックを待ちます。チェック中に要素がデタッチされた場合、アクション全体が再試行されます。
必要に応じて、要素をビューにスクロールします。
page.touchscreen を使用して、要素の中央、または指定された position をタップします。

注

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

使用法

await frame.tap(selector);
await frame.tap(selector, options);

引数

selector 文字列 #

要素を検索するセレクター。セレクターに一致する要素が複数ある場合は、最初の要素が使用されます。
options Object (オプション)
- force 真偽値 (任意)#
  
  実行可能性チェックをバイパスするかどうか。デフォルトは false です。
- modifiers Array<"Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift"> (任意)#
  
  押すモディファイキー。操作中にこれらのモディファイキーのみが押されていることを確認し、その後、現在のモディファイキーを元に戻します。指定しない場合、現在押されているモディファイキーが使用されます。"ControlOrMeta" は、Windows および Linux では "Control" に、macOS では "Meta" に解決されます。
- noWaitAfter 真偽値 (任意)#
  
  非推奨
  このオプションは効果がありません。
  
  このオプションは効果がありません。
- position Object (任意)#
  - x number
  - y number
  要素のパディングボックスの左上隅を基準に使用するポイント。指定しない場合は、要素の可視点を使用します。
- strict boolean (オプション)追加バージョン: v1.14#
  
  trueの場合、この呼び出しでは、セレクターが単一の要素に解決される必要があります。指定されたセレクターが複数の要素に解決される場合、この呼び出しは例外をスローします。
- timeout 数値 (任意)#
  
  最大時間（ミリ秒単位）。デフォルトは 0 - タイムアウトなし。デフォルト値は、configの actionTimeout オプション、または browserContext.setDefaultTimeout() メソッドまたは page.setDefaultTimeout() メソッドを使用して変更できます。
- trial boolean (オプション)追加: v1.11#
  
  設定すると、このメソッドは操作可能性チェックのみを実行し、アクションをスキップします。デフォルトは false です。要素がアクションを実行する準備ができるまで待機する場合に便利です。キーボードの modifiers は、それらのキーが押されたときにのみ表示される要素をテストできるように、trial に関係なく押されることに注意してください。

戻り値

Promise<void>#

textContent

v1.9より前に追加

frame.textContent

非推奨

代わりにロケーターベースの locator.textContent() を使用してください。ロケーターの詳細をご覧ください。

element.textContent を返します。

使用法

await frame.textContent(selector);
await frame.textContent(selector, options);

引数

selector 文字列 #

要素を検索するセレクター。セレクターに一致する要素が複数ある場合は、最初の要素が使用されます。
options Object (オプション)
- strict boolean (オプション)追加バージョン: v1.14#
  
  trueの場合、この呼び出しでは、セレクターが単一の要素に解決される必要があります。指定されたセレクターが複数の要素に解決される場合、この呼び出しは例外をスローします。
- timeout 数値 (任意)#
  
  最大時間（ミリ秒単位）。デフォルトは 0 - タイムアウトなし。デフォルト値は、configの actionTimeout オプション、または browserContext.setDefaultTimeout() メソッドまたは page.setDefaultTimeout() メソッドを使用して変更できます。

戻り値

Promise<null | 文字列>#

type

v1.9より前に追加

frame.type

非推奨

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

テキスト内の各文字に対して、keydown、keypress/input、および keyup イベントを送信します。frame.type は、きめ細かいキーボードイベントを送信するために使用できます。フォームフィールドに値を入力するには、frame.fill() を使用してください。

Control や ArrowDown などの特殊キーを押すには、keyboard.press() を使用してください。

使用法

引数

selector 文字列 #

要素を検索するセレクター。セレクターに一致する要素が複数ある場合は、最初の要素が使用されます。
text 文字列 #

フォーカスされた要素に入力するテキスト。
options Object (オプション)
- delay 数値 (任意)#
  
  キーを押す間の待ち時間 (ミリ秒単位)。デフォルトは 0 です。
- noWaitAfter 真偽値 (任意)#
  
  非推奨
  このオプションは効果がありません。
  
  このオプションは効果がありません。
- strict boolean (オプション)追加バージョン: v1.14#
  
  trueの場合、この呼び出しでは、セレクターが単一の要素に解決される必要があります。指定されたセレクターが複数の要素に解決される場合、この呼び出しは例外をスローします。
- timeout 数値 (任意)#
  
  最大時間（ミリ秒単位）。デフォルトは 0 - タイムアウトなし。デフォルト値は、configの actionTimeout オプション、または browserContext.setDefaultTimeout() メソッドまたは page.setDefaultTimeout() メソッドを使用して変更できます。

戻り値

Promise<void>#

uncheck

v1.9より前に追加

frame.uncheck

非推奨

代わりにロケーターベースの locator.uncheck() を使用してください。ロケーターの詳細をご覧ください。

このメソッドは、次の手順を実行して、selector に一致する要素をチェックします。

selector に一致する要素を見つけます。存在しない場合は、一致する要素が DOM にアタッチされるまで待機します。
一致する要素がチェックボックスまたはラジオ入力であることを確認します。そうでない場合、このメソッドは例外をスローします。要素が既にチェック解除されている場合、このメソッドはすぐに戻ります。
force オプションが設定されていない限り、一致する要素の操作性チェックを待ちます。チェック中に要素がデタッチされた場合、アクション全体が再試行されます。
必要に応じて、要素をビューにスクロールします。
page.mouse を使用して、要素の中央をクリックします。
要素がチェック解除されたことを確認します。そうでない場合、このメソッドは例外をスローします。

使用法

await frame.uncheck(selector);
await frame.uncheck(selector, options);

引数

selector 文字列 #

要素を検索するセレクター。セレクターに一致する要素が複数ある場合は、最初の要素が使用されます。
options Object (オプション)
- force 真偽値 (任意)#
  
  実行可能性チェックをバイパスするかどうか。デフォルトは false です。
- noWaitAfter 真偽値 (任意)#
  
  非推奨
  このオプションは効果がありません。
  
  このオプションは効果がありません。
- position Object (オプション)追加: v1.11#
  - x number
  - y number
  要素のパディングボックスの左上隅を基準に使用するポイント。指定しない場合は、要素の可視点を使用します。
- strict boolean (オプション)追加バージョン: v1.14#
  
  trueの場合、この呼び出しでは、セレクターが単一の要素に解決される必要があります。指定されたセレクターが複数の要素に解決される場合、この呼び出しは例外をスローします。
- timeout 数値 (任意)#
  
  最大時間（ミリ秒単位）。デフォルトは 0 - タイムアウトなし。デフォルト値は、configの actionTimeout オプション、または browserContext.setDefaultTimeout() メソッドまたは page.setDefaultTimeout() メソッドを使用して変更できます。
- trial boolean (オプション)追加: v1.11#
  
  設定すると、このメソッドは実行可能性チェックのみを実行し、アクションをスキップします。デフォルトは false です。アクションを実行せずに、要素がアクションの準備ができるまで待機するのに役立ちます。

戻り値

Promise<void>#

v1.9より前に追加

frame.waitForNavigation

非推奨

このメソッドは本質的に競合状態が発生しやすいため、代わりに frame.waitForURL() を使用してください。

フレームナビゲーションを待機し、メインリソースレスポンスを返します。複数のリダイレクトの場合、ナビゲーションは最後のリダイレクトのレスポンスで解決されます。別のアンカーへのナビゲーションまたは History API の使用によるナビゲーションの場合、ナビゲーションは null で解決されます。

使用法

このメソッドは、フレームが新しい URL にナビゲートするのを待ちます。これは、フレームを間接的にナビゲートさせるコードを実行する場合に役立ちます。次の例を考えてください。

// Start waiting for navigation before clicking. Note no await.
const navigationPromise = page.waitForNavigation();
await page.getByText('Navigate after timeout').click();
await navigationPromise;

注

URL を変更するための History API の使用は、ナビゲーションと見なされます。

引数

options Object (オプション)
- timeout 数値 (任意)#
  
  最大操作時間（ミリ秒単位）。デフォルトは 0 - タイムアウトなし。デフォルト値は、config の navigationTimeout オプション、または browserContext.setDefaultNavigationTimeout(), browserContext.setDefaultTimeout(), page.setDefaultNavigationTimeout() または page.setDefaultTimeout() メソッドを使用して変更できます。
- url 文字列 | RegExp | function(URL):真偽値 (任意)#
  
  ナビゲーションを待機中に一致させるためのグロブパターン、正規表現パターン、または URL を受信する述語。パラメータがワイルドカード文字を含まない文字列である場合、メソッドは文字列と完全に等しいURLへのナビゲーションを待機することに注意してください。
- waitUntil "load" | "domcontentloaded" | "networkidle" | "commit" (任意)#
  
  操作が成功したと見なすタイミング。デフォルトは load。イベントは以下のいずれかです。
  - 'domcontentloaded' - DOMContentLoaded イベントが発行されたときに操作が完了したと見なします。
  - 'load' - load イベントが発行されたときに操作が完了したと見なします。
  - 'networkidle' - 非推奨 ネットワーク接続が少なくとも 500 ms なくなったときに操作が完了したと見なします。テストにはこのメソッドを使用せず、代わりに準備状態を評価するためにウェブアサーションに依存してください。
  - 'commit' - ネットワークレスポンスが受信され、ドキュメントのロードが開始されたときに操作が完了したと見なします。

戻り値

Promise<null | Response>#

waitForSelector

v1.9より前に追加

frame.waitForSelector

非推奨

可視性をアサートするウェブアサーションまたはロケーターベースの locator.waitFor() を代わりに使用してください。ロケーターの詳細をご覧ください。

selector で指定された要素が state オプションを満たすと戻ります。hidden または detached を待機している場合は null を返します。

注

Playwright は、アクションを実行する前に要素が準備完了になるのを自動的に待ちます。Locator オブジェクトとウェブファーストアサーションを使用すると、コードは wait-for-selector-free になります。

selector が state オプション (DOM に表示/非表示になるか、表示/非表示になるかのいずれか) を満たすのを待ちます。メソッドを呼び出した時点で selector が既に条件を満たしている場合、メソッドはすぐに戻ります。セレクターが timeout ミリ秒間条件を満たさない場合、関数は例外をスローします。

使用法

このメソッドはナビゲーションをまたいで機能します

const { chromium } = require('playwright');  // Or 'firefox' or 'webkit'.

(async () => {
  const browser = await chromium.launch();
  const page = await browser.newPage();
  for (const currentURL of ['https://google.com', 'https://bbc.com']) {
    await page.goto(currentURL);
    const element = await page.mainFrame().waitForSelector('img');
    console.log('Loaded image: ' + await element.getAttribute('src'));
  }
  await browser.close();
})();

引数

selector 文字列 #

クエリするセレクター。
options Object (オプション)
- state "attached" | "detached" | "visible" | "hidden" (任意)#
  
  デフォルトは 'visible' です。次のいずれかになります。
  - 'attached' - 要素が DOM に存在するのを待ちます。
  - 'detached' - 要素が DOM に存在しないのを待ちます。
  - 'visible' - 要素に空でないバウンディングボックスがあり、visibility:hidden がないのを待ちます。コンテンツがない要素または display:none が設定された要素は、空のバウンディングボックスを持ち、表示されているとは見なされません。
  - 'hidden' - 要素が DOM からデタッチされるか、空のバウンディングボックスを持つか、または visibility:hidden を持つかのいずれかを待ちます。これは 'visible' オプションの反対です。
- strict boolean (オプション)追加バージョン: v1.14#
  
  trueの場合、この呼び出しでは、セレクターが単一の要素に解決される必要があります。指定されたセレクターが複数の要素に解決される場合、この呼び出しは例外をスローします。
- timeout 数値 (任意)#
  
  最大時間（ミリ秒単位）。デフォルトは 0 - タイムアウトなし。デフォルト値は、configの actionTimeout オプション、または browserContext.setDefaultTimeout() メソッドまたは page.setDefaultTimeout() メソッドを使用して変更できます。

戻り値

Promise<null | ElementHandle>#

waitForTimeout

v1.9より前に追加

frame.waitForTimeout

非推奨

実稼働環境でタイムアウトを待機しないでください。時間を待機するテストは本質的に不安定です。Locator アクションと自動的に待機するウェブアサーションを使用してください。

指定された timeout (ミリ秒単位) を待機します。

frame.waitForTimeout() はデバッグ専用で使用する必要があることに注意してください。実稼働環境でタイマーを使用するテストは不安定になります。代わりに、ネットワークイベント、セレクターが表示されるなどのシグナルを使用してください。

使用法

await frame.waitForTimeout(timeout);

引数

timeout 数値 #

待機するタイムアウト

戻り値

Promise<void>#

メソッド​

addScriptTag​

addStyleTag​

childFrames​

content​

dragAndDrop​

evaluate​

evaluateHandle​

frameElement​

frameLocator​

getByAltText​

getByLabel​

getByPlaceholder​

getByRole​

getByTestId​

getByText​

getByTitle​

goto​

isDetached​

isEnabled​

locator​

name​

page​

parentFrame​

setContent​

title​

url​

waitForFunction​

waitForLoadState​

waitForURL​

非推奨​

$​

$$​

$eval​

$$eval​

check​

click​

dblclick​

dispatchEvent​

fill​

focus​

getAttribute​

hover​

innerHTML​

innerText​

inputValue​

isChecked​

isDisabled​

isEditable​

isHidden​

isVisible​

press​

selectOption​

setChecked​

setInputFiles​

tap​

textContent​

type​

uncheck​

waitForNavigation​

waitForSelector​

waitForTimeout​

メソッド

addScriptTag

addStyleTag

childFrames

content

dragAndDrop

evaluate

evaluateHandle

frameElement

frameLocator

getByAltText

getByLabel

getByPlaceholder

getByRole

getByTestId

getByText

getByTitle

goto

isDetached

isEnabled

locator

name

page

parentFrame

setContent

title

url

waitForFunction

waitForLoadState

waitForURL

非推奨

$

$$

$eval

$$eval

check

click

dblclick

dispatchEvent

fill

focus

getAttribute

hover

innerHTML

innerText

inputValue

isChecked

isDisabled

isEditable

isHidden

isVisible

press

selectOption

setChecked

setInputFiles

tap

textContent

type

uncheck

waitForNavigation

waitForSelector

waitForTimeout