FrameLocator

FrameLocatorは、ページ上のiframeへのビューを表します。これは、iframeを取得し、そのiframe内の要素を特定するのに十分なロジックをキャプチャします。FrameLocatorは、locator.contentFrame()、page.frameLocator()、またはlocator.frameLocator()メソッドで作成できます。

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

厳格性

フレームロケーターは厳格です。これは、指定されたセレクターに複数の要素が一致する場合、フレームロケーターに対するすべての操作が例外をスローすることを意味します。

// Throws if there are several frames in DOM:
await page.locator('.result-frame').contentFrame().getByRole('button').click();

// Works because we explicitly tell locator to pick the first frame:
await page.locator('.result-frame').contentFrame().first().getByRole('button').click();

LocatorをFrameLocatorに変換する

iframeを指すLocatorオブジェクトがある場合、locator.contentFrame()を使用してFrameLocatorに変換できます。

FrameLocatorをLocatorに変換する

FrameLocatorオブジェクトがある場合、frameLocator.owner()を使用して、同じiframeを指すLocatorに変換できます。

メソッド

frameLocator

追加バージョン: v1.17

frameLocator.frameLocator

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

使用法

frameLocator.frameLocator(selector);

引数

selector string #

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

戻り値

FrameLocator #

getByAltText

追加バージョン: v1.27

frameLocator.getByAltText

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

使用法

例えば、このメソッドはaltテキスト「Playwright logo」で画像を見つけます。

<img alt='Playwright logo'>

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

引数

text string | RegExp #

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

戻り値

Locator #

getByLabel

追加バージョン: v1.27

frameLocator.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 (optional)
- exact boolean (オプション)#
  
  完全一致（大文字小文字を区別し、文字列全体）を見つけるかどうか。デフォルトはfalse。正規表現で特定する場合は無視されます。正確な一致でも空白はトリムされることに注意してください。

戻り値

Locator #

getByPlaceholder

追加バージョン: v1.27

frameLocator.getByPlaceholder

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

使用法

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

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

プレースホルダーテキストで入力を見つけてから、入力できます。

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

引数

text string | RegExp #

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

戻り値

Locator #

getByRole

追加バージョン: v1.27

frameLocator.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 (optional)
- 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

frameLocator.getByTestId

テストIDによって要素を特定します。

使用法

以下のDOM構造を考えてみましょう。

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

テストIDによって要素を特定できます。

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

引数

testId string | RegExp #

要素を特定するID。

戻り値

Locator #

詳細

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

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

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

getByText

追加バージョン: v1.27

frameLocator.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 (optional)
- exact boolean (オプション)#
  
  完全一致（大文字小文字を区別し、文字列全体）を見つけるかどうか。デフォルトはfalse。正規表現で特定する場合は無視されます。正確な一致でも空白はトリムされることに注意してください。

戻り値

Locator #

詳細

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

buttonおよびsubmit型の入力要素は、テキストコンテンツの代わりにそのvalueによって一致します。例えば、テキスト"Log in"で特定すると、<input type=button value="Log in">が一致します。

getByTitle

追加バージョン: v1.27

frameLocator.getByTitle

要素をそのタイトル属性で特定できます。

使用法

以下のDOM構造を考えてみましょう。

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

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

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

引数

text string | RegExp #

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

戻り値

Locator #

locator

追加バージョン: v1.17

frameLocator.locator

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

ロケーターの詳細.

使用法

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

引数

selectorOrLocator string | Locator #

DOM要素を解決するときに使用するセレクターまたはロケーター。
options Object (optional)
- 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 #

owner

追加バージョン: v1.43

frameLocator.owner

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

どこかで取得したFrameLocatorオブジェクトがあり、後でiframe要素と対話したい場合に便利です。

逆の操作には、locator.contentFrame()を使用します。

使用法

const frameLocator = page.locator('iframe[name="embedded"]').contentFrame();
// ...
const locator = frameLocator.owner();
await expect(locator).toBeVisible();

戻り値

Locator #

非推奨

first

追加バージョン: v1.17

frameLocator.first

非推奨

代わりにlocator.first()の後にlocator.contentFrame()を使用してください。

最初の一致するフレームへのロケーターを返します。

使用法

frameLocator.first();

戻り値

FrameLocator #

last

追加バージョン: v1.17

frameLocator.last

非推奨

代わりにlocator.last()の後にlocator.contentFrame()を使用してください。

最後の一致するフレームへのロケーターを返します。

使用法

frameLocator.last();

戻り値

FrameLocator #

nth

追加バージョン: v1.17

frameLocator.nth

非推奨

代わりにlocator.nth()の後にlocator.contentFrame()を使用してください。

n番目の一致するフレームへのロケーターを返します。0ベースで、nth(0)は最初のフレームを選択します。

使用法

frameLocator.nth(index);

引数

index number #

戻り値

FrameLocator #

メソッド​

frameLocator​

getByAltText​

getByLabel​

getByPlaceholder​

getByRole​

getByTestId​

getByText​

getByTitle​

locator​

owner​

非推奨​

first​

last​

nth​

メソッド

frameLocator

getByAltText

getByLabel

getByPlaceholder

getByRole

getByTestId

getByText

getByTitle

locator

owner

非推奨

first

last

nth