Window: open() メソッド

open()Window インターフェイスのメソッドで、指定されたリソースを、新しい、または既存の指定された名前を持った閲覧コンテキスト (ウィンドウ、 iframe、タブ) に読み込みます。

構文

js
open()
open(url)
open(url, target)
open(url, target, windowFeatures)

引数

url 省略可

文字列で、読み込むリソースの URL を示します。これは HTML ページ、画像ファイル、その他のブラウザーが対応しているリソースのパスまたは URL にすることができます。空文字列 ("") がこの時期数に指定されると、対象の閲覧コンテキストに空のページが開きます。

target 省略可

ホワイトスペースのない文字列で、リソースを読み込むための閲覧コンテキストの名前を指定します。その名前で既存のコンテキストが識別できない場合は、新しいコンテキストが指定された名前で作成されます。特殊な target キーワードである _self_blank_parent_top も利用することができます。

この名前は <a><form> 要素の target 属性として使うことができます。

windowFeatures 省略可

name=value の形式、または論理特性の場合は name だけで、ウィンドウの特性をカンマで区切った文字列です。これらの特性には、ウィンドウの既定値や位置、最小限のポップアップウィンドウを開くかどうか、などのオプションが記載されます。以下のようなオプションに対応しています。

この特性を有効にすると、最小限のポップアップウィンドウを使用するように要求されます。ポップアップウィンドウに含まれる UI 機能はブラウザーが自動的に決定し、一般的にはアドレスバーのみを含みます。

もし popup が有効でなく、ウィンドウ機能が宣言されていない場合、新しい閲覧コンテキストはタブになります。

メモ: windowFeatures 引数で noopenernoreferrer 以外の機能を指定すると、ポップアップを要求する効果もあります。

この機能を有効にするには、 popup を指定して値を指定しないか、 yes1true のいずれかに設定します。

例: popup=yes, popup=1, popup=true, popup は同じ結果になります。

width または innerWidth

スクロールバーを含むコンテンツ領域の幅を指定します。必要最小値は 100 です。

height または innerHeight

スクロールバーを含むコンテンツ領域の高さを指定します。必要最小値は 100 です。

left または screenX

新しいウィンドウを生成する、ユーザーのオペレーティングシステムによって定義される作業領域の左側からの距離をピクセル単位で指定します。

top または screenY

新しいウィンドウを生成する、ユーザーのオペレーティングシステムによって定義される作業領域の上側からの距離をピクセル単位で指定します。

noopener

この特性が設定されている場合、新しいウィンドウは Window.opener を介して元のウィンドウにアクセスすることはできず、 null を返します。

noopener を使用した場合、 _top, _self, _parent 以外の空でないターゲット名は、新しい閲覧コンテキストを開くかどうかの判断において、 _blank と同様に扱われます。

noreferrer

この特性が設定されると、ブラウザーは Referer ヘッダーを省略し、 noopener を true に設定します。詳しくは rel="noreferrer" を参照してください。

メモ: 要求する位置 (top, left)、要求する寸法 (width, height) の値が windowFeatures で指定された場合、ブラウザーのポップアップ全体がユーザーのオペレーティングシステムのアプリケーションの作業領域内に表示できないと、修正されます。言い換えれば、新しいポップアップのどの部分も、最初は画面外に配置することはできません。

返値

ブラウザーが新しい閲覧コンテキストを開くことができた場合は、 WindowProxy オブジェクトを返します。返される参照は、同一オリジンポリシーのセキュリティ要件に準拠する限り、新しいコンテキストのプロパティとメソッドにアクセスするために使用することができます。

ブラウザーが新しい閲覧コンテキストを開くために失敗した場合、例えばブラウザーのポップアップブロッカーによってブロックされた場合などには null が返されます。

解説

Window インターフェイスの open() メソッドは、 URL を引数として取り、識別する新規または既存のタブまたはウィンドウにリソースを読み込みます。 target 引数は、リソースを読み込むウィンドウやタブを決定します。また、 windowFeatures 引数は、最小限の UI 機能で新しいポップアップを開き、そのサイズや位置を制御するために使用することができます。

リモートの URL は、すぐには読み込まれません。 window.open() から返ったとき、ウィンドウには常に about:blank を含んでいます。 URL が実際に読み込まれるまでには猶予期間があり、現在のスクリプトブロックが実行を終えた後に開始されます。ウィンドウの生成と参照されるリソースの読み込みは、非同期に行われます。

現代のブラウザーは厳しいポップアップブロッカーポリシーを持っています。ポップアップウィンドウはユーザーの入力に直接反応して開く必要があり、 Window.open() を呼び出すたびに別個のジェスチャーイベントが要求されます。これにより、サイトがたくさんのウィンドウでユーザーをスパムするのを防ぐことができます。しかし、これはマルチウィンドウのアプリケーションでは課題となります。この制限をうまく回避するために、アプリケーションを次のように設計してください。

  • 一度に複数の新しいウィンドウを開かないようにしてください。
  • さまざまなページを表示するために既存のウィンドウを再利用してください。
  • 複数のウィンドウを使用できるようにブラウザー設定を更新する方法をユーザーにアドバイスしてください。

新しいタブを開く

js
window.open("https://www.mozilla.org/", "mozillaTab");

ポップアップを開く

他にも以下の例では、 popup 特性を使用して、ポップアップを開く方法を示しています。

js
window.open("https://www.mozilla.org/", "mozillaWindow", "popup");

新しいポップアップの大きさと位置を操作することが可能です。

js
const windowFeatures = "left=100,top=100,width=320,height=320";
const handle = window.open(
  "https://www.mozilla.org/",
  "mozillaWindow",
  windowFeatures,
);
if (!handle) {
  // ウィンドウを開くことが許可されなかった場合。
  // これは主にポップアップブロッカーによって発生します。
  // …
}

プログレッシブエンハンスメント

JavaScript が無効または利用できない場合、window.open() が動作しないことがあります。この機能の有無だけに頼るのではなく、サイトやアプリケーションが機能するような代替策を提供してください。

JavaScript が無効な場合の代替手段を提供する

JavaScript のサポートが無効または存在しない場合、ユーザーエージェントはそれに応じて副ウィンドウを作成するか、 target 属性の処理に従って参照されるリソースをレンダリングします。目標とアイデアは、参照されるリソースを開く方法をユーザーに提供してください (押し付けないでください) ということです。

HTML

html
<a href="https://www.wikipedia.org/" target="OpenWikipediaWindow">
  Wikipedia, a free encyclopedia (opens in another, possibly already existing,
  tab)
</a>

JavaScript

js
let windowObjectReference = null; // global variable
function openRequestedTab(url, windowName) {
  if (windowObjectReference === null || windowObjectReference.closed) {
    windowObjectReference = window.open(url, windowName);
  } else {
    windowObjectReference.focus();
  }
}

const link = document.querySelector("a[target='OpenWikipediaWindow']");
link.addEventListener(
  "click",
  (event) => {
    openRequestedTab(link.href);
    event.preventDefault();
  },
  false,
);

上記のコードは、リンクがポップアップを開くことに関連するいくつかのユーザビリティの問題を解決しています。コード中の event.preventDefault() の目的は、リンクの既定値のアクションを取り消すことです。click のイベントリスナーが実行されれば、リンクの既定値のアクションを実行する必要はありません。しかし、ユーザーのブラウザーで JavaScript のサポートが無効または存在しない場合、 click のイベントリスナーは無視され、ブラウザーは "WikipediaWindowName" という名前を持つターゲットフレームまたはウィンドウに参照されたリソースを読み込む。フレームやウィンドウに "WikipediaWindowName" という名前がない場合、ブラウザーは新しいウィンドウを作成して "WikipediaWindowName" という名前を付けます。

メモ: target 属性についての詳細は、 <a> または <form> を参照してください。

既存のウィンドウを再利用して target="_blank" を防止する

target 属性の値として "_blank" を使用すると、ユーザーのデスクトップ上にリサイクルや再使用ができない新しい無名のウィンドウがいくつも作成されます。 target 属性に意味のある名前を提供し、ページ内で target 属性を再利用するようにしてください。そうすれば、別のリンクをクリックしたときに、すでに作成・表示されているウィンドウに参照先のリソースが読み込まれ(したがってユーザーの処理速度が速くなり)、第二ウィンドウを作成した当初の理由(およびユーザーのシステムリソース、費やした時間)が正当化されることになります。単一の target 属性値を使用し、それをリンクで再利用することで、第二ウィンドウを一つだけ作成して再利用するので、よりユーザーリソースに優しくなります。

ここでは、第二ウィンドウを開いて、他のリンクに再利用する例を紹介します。

HTML

html
<p>
  <a href="https://www.wikipedia.org/" target="SingleSecondaryWindowName">
    Wikipedia, a free encyclopedia (opens in another, possibly already existing,
    tab)
  </a>
</p>
<p>
  <a
    href="https://support.mozilla.org/products/firefox"
    target="SingleSecondaryWindowName">
    Firefox FAQ (opens in another, possibly already existing, tab)
  </a>
</p>

JavaScript

js
let windowObjectReference = null; // global variable
let previousURL; /* global variable that will store the
                    url currently in the secondary window */
function openRequestedSingleTab(url) {
  if (windowObjectReference === null || windowObjectReference.closed) {
    windowObjectReference = window.open(url, "SingleSecondaryWindowName");
  } else if (previousURL !== url) {
    windowObjectReference = window.open(url, "SingleSecondaryWindowName");
    /* if the resource to load is different,
       then we load it in the already opened secondary window and then
       we bring such window back on top/in front of its parent window. */
    windowObjectReference.focus();
  } else {
    windowObjectReference.focus();
  }
  previousURL = url;
  /* explanation: we store the current url in order to compare url
     in the event of another call of this function. */
}

const links = document.querySelectorAll(
  "a[target='SingleSecondaryWindowName']",
);
for (const link of links) {
  link.addEventListener(
    "click",
    (event) => {
      openRequestedSingleTab(link.href);
      event.preventDefault();
    },
    false,
  );
}

同一オリジンポリシー

新しく開いた閲覧コンテキストが同じオリジンでない場合、開いたスクリプトは閲覧コンテキストの内容とやり取り(読み書き)をすることができません。

js
// Script from example.com
const otherOriginContext = window.open("https://example.org");
// example.com and example.org are not the same origin

console.log(otherOriginContext.origin);
// DOMException: Permission denied to access property "origin" on cross-origin object
js
// Script from example.com
const sameOriginContext = window.open("https://example.com");
// This time, the new browsing context has the same origin

console.log(sameOriginContext.origin);
// https://example.com

詳しくは、同一オリジンポリシーの記事を参照してください。

アクセシビリティの考慮

window.open() への依存の回避

いくつかの理由で、 window.open() への依存を回避することをお勧めします。

  • 最近のブラウザーは、ポップアップブロック機能を備えています。
  • 最近のブラウザーはタブブラウジングを提供しており、タブブラウジングのユーザーはほとんどの状況で新しいウィンドウを開くよりも新しいタブを開くことを好みます。
  • ユーザーは、ブラウザーに組み込まれた機能や拡張機能を使用して、リンクを新しいウィンドウで開くか、同じウィンドウで開くか、新しいタブで開くか、同じタブで開くか、バックグラウンドで開くかを選ぶことができます。 window.open() を使用し、特定の方法で開くことを強制すると、ユーザーを混乱させ、その習慣を無視することになります。
  • ポップアップにはメニューツールバーがありませんが、新しいタブはブラウザーウィンドウのユーザーインターフェースを使用します。したがって、多くのユーザーはインターフェースが安定しているため、タブブラウジングを好みます。

window.open() を HTML のインラインで使用しない

<a href="#" onclick="window.open(…);"><a href="javascript:window.open(…)" …> は避けてください。

これらの偽の href 値は、リンクをコピー/ドラッグしたり、新しいタブ/ウィンドウでリンクを開いたり、ブックマークしたり、 JavaScript の読み込み中、エラー、無効のときに、予期しない動作を発生させます。また、画面の内側から読み取るリーダーなどの支援技術に対しても、誤った意味を伝えてしまいます。

必要であれば、代わりに <button> 要素を使用してください。一般的に、本当の URL へのナビゲーションのためにのみリンクを使用する必要があります

副ウィンドウに案内するリンクを常に識別できるようにする

ユーザーのナビゲーションに役立つように、新しいウィンドウを開くリンクを識別できるようにしてください。

html
<a target="WikipediaWindow" href="https://www.wikipedia.org">
  Wikipedia (opens in new tab)
</a>

コンテキストが変わることをユーザーに警告する目的は、ユーザー側の混乱を最小限にするためです。現在のウィンドウを変更したり、新しいウィンドウをポップアップしたりすると、ユーザーはとても混乱します(ポップアップの場合、ツールバーには前のウィンドウに戻るための「前へ」ボタンが用意されていません)。

極端なコンテキストの変化が起こる前に、明示的に識別することができれば、ユーザーは先に進むかどうかを判断でき、変化に備えることができます。ユーザーは混乱したり方向感覚を失ったりしないだけでなく、経験豊富なユーザーであれば、そうしたリンクを開く方法(新しいウィンドウで開くかどうか、同じウィンドウ、新しいタブ、「バックグラウンド」かどうか)を適切に判断することができます。

仕様書

Specification
HTML Standard
# dom-open-dev
CSSOM View Module
# the-features-argument-to-the-open()-method

ブラウザーの互換性

BCD tables only load in the browser

関連情報