FrameLocator

FrameLocatorは、ページ上のiframeへのビューを表します。iframeを取得し、そのiframe内の要素を特定するのに十分なロジックをカプセル化します。FrameLocatorは、Locator.contentFrame()、Page.frameLocator()、またはLocator.frameLocator()メソッドのいずれかで作成できます。

Locator locator = page.locator("#my-frame").contentFrame().getByText("Submit");
locator.click();

厳格性

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

// Throws if there are several frames in DOM:
page.locator(".result-frame").contentFrame().getByRole(AriaRole.BUTTON).click();

// Works because we explicitly tell locator to pick the first frame:
page.locator(".result-frame").first().contentFrame().getByRole(AriaRole.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'>

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

引数

text String | Pattern #

要素を特定するためのテキスト。
options FrameLocator.GetByAltTextOptions (optional)
- setExact boolean (optional)#
  
  完全一致（大文字小文字を区別し、文字列全体）を見つけるかどうか。デフォルトは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">

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

引数

text String | Pattern #

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

戻り値

Locator #

getByPlaceholder

追加バージョン: v1.27

frameLocator.getByPlaceholder

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

使用法

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

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

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

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

引数

text String | Pattern #

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

戻り値

Locator #

getByRole

追加バージョン: v1.27

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

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

引数

testId String | Pattern #

要素を特定するID。

戻り値

Locator #

詳細

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

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", 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 FrameLocator.GetByTextOptions (optional)
- setExact boolean (optional)#
  
  完全一致（大文字小文字を区別し、文字列全体）を見つけるかどうか。デフォルトは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>

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

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

引数

text String | Pattern #

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

戻り値

Locator #

locator

追加バージョン: v1.17

frameLocator.locator

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

ロケーターの詳細.

使用法

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

引数

selectorOrLocator String | Locator #

DOM要素を解決するときに使用するセレクターまたはロケーター。
options FrameLocator.LocatorOptions (optional)
- setHas Locator (optional)#
  
  この相対ロケーターに一致する要素を含む結果にメソッドの結果を絞り込みます。例えば、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 (optional)#
  
  指定されたテキストを内部、子、または子孫要素のどこかに含む要素と一致します。文字列が渡された場合、大文字と小文字を区別せずに部分文字列を検索します。たとえば、"Playwright" は <article><div>Playwright</div></article> と一致します。

戻り値

Locator #

owner

追加バージョン: v1.43

frameLocator.owner

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

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

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

使用法

FrameLocator frameLocator = page.locator("iframe[name=\"embedded\"]").contentFrame();
// ...
Locator locator = frameLocator.owner();
assertThat(locator).isVisible();

戻り値

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 int #

戻り値

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