Skip to content

Latest commit

 

History

History
110 lines (86 loc) · 8.59 KB

index.md

File metadata and controls

110 lines (86 loc) · 8.59 KB
title slug
webNavigation
Mozilla/Add-ons/WebExtensions/API/webNavigation

{{AddonSidebar}}

ナビゲーションのいろいろな段階でイベントリスナーを追加します。ナビゲーションにはある URL から他に移動するブラウザーフレームにより成り立っていて、それは(いつもではなく)通常はリンクのクリックやロケーションバーへの URL 入力といったユーザー操作の応答として発生します。

{{WebExtAPIRef("webRequest")}} API と比較して: ナビゲーションは通常、ブラウザーにウェブリクエストを発生させますが、webRequest API は HTTP 層からの低レベルな観点に関心を持っており、一方で webNavigation API はブラウザー UI 自身に対して、より関心を持っています。

それぞれのイベントはナビゲーションの特定のステージに対応しています。イベントシーケンスは次の通りです:

  • 主なフローは次の通り:

    • {{WebExtAPIRef("webNavigation.onBeforeNavigate", "onBeforeNavigate")}}
    • {{WebExtAPIRef("webNavigation.onCommitted", "onCommitted")}}
    • {{WebExtAPIRef("webNavigation.onDOMContentLoaded", "onDOMContentLoaded")}}
    • {{WebExtAPIRef("webNavigation.onCompleted", "onCompleted")}}.

  • 追加のものは次の通り:

    • {{WebExtAPIRef("webNavigation.onCreatedNavigationTarget", "onCreatedNavigationTarget")}} は、ブラウザーがナビゲーション用にタブやウィンドウを作成する必要がある場合 (例えば、ユーザーがリンクを新しいタブで開いたために)、onBeforeNavigate の前に発火します。
    • {{WebExtAPIRef("webNavigation.onHistoryStateUpdated", "onHistoryStateUpdated")}} はページが history API を使ってブラウザーのロケーションバーに表示された URL を更新する場合に発火します。
    • {{WebExtAPIRef("webNavigation.onReferenceFragmentUpdated", "onReferenceFragmentUpdated")}} はページの fragment identifier が変更された場合に発火します。
    • {{WebExtAPIRef("webNavigation.onErrorOccurred", "onErrorOccurred")}} はあらゆる場所で発火します。

それぞれのナビゲーションは特定のブラウザーフレーム内の URL の遷移です。ブラウザーフレームはタブ ID とフレーム ID で識別されます。フレームはタブ内の再上位の閲覧コンテキストである場合や、iframe として実装されたネストされた閲覧コンテキストである場合があります。

それぞれのイベントの addListener() の呼び出しはオプションの filter パラメーターを受け入れます。filter は 1 つ以上の URL パターンを指定し、イベントはターゲット URL がパターンにマッチしたナビゲーションの時だけに発火します。

onCommitted イベントリスナーには 2 つの追加プロパティが渡されます: ナビゲーションの原因 (例えばユーザーがリンクをクリックしたり、ユーザーがブックマークを選んだり) を示す{{WebExtAPIRef("webNavigation.TransitionType","TransitionType")}} と、ナビゲーションの詳細情報を提供する{{WebExtAPIRef("webNavigation.TransitionQualifier","TransitionQualifier")}} です。

この API を使うには"webNavigation" パーミッションが必要です。

型

  • {{WebExtAPIRef("webNavigation.TransitionType")}}
    • : ナビゲーションの原因: 例えば、ユーザーがリンクをクリックしたり、アドレスを入力したり、ブックマークをクリックしたりなど。
  • {{WebExtAPIRef("webNavigation.TransitionQualifier")}}
    • : 遷移の追加情報

関数

  • {{WebExtAPIRef("webNavigation.getFrame()")}}
    • : 特定フレームについての情報を取得します。フレームにはタブ内のトップレベルのフレームや、ネストされた iframe であり、タブ ID とフレーム ID でユニークに識別されます。
  • {{WebExtAPIRef("webNavigation.getAllFrames()")}}
    • : タブ ID を指定すると、そのタブに含まれているすべてのフレームの情報を取得します。

イベント

  • {{WebExtAPIRef("webNavigation.onBeforeNavigate")}}
    • : ブラウザーがナビゲーションイベントを開始する直前に発火します。
  • {{WebExtAPIRef("webNavigation.onCommitted")}}
    • : ナビゲーションがコミットされたときに発火します。少なくともサーバーから新しい document がいくらか取得されてブラウザーが新 document に切り替えると決めたとき。
  • {{WebExtAPIRef("webNavigation.onDOMContentLoaded")}}
    • : ページ内で DOMContentLoaded イベントが発火したときに発火します。
  • {{WebExtAPIRef("webNavigation.onCompleted")}}
    • : document と、それが参照するリソースが完全にロードされて初期化されたときに発火します。これは DOM load イベントと等価です。
  • {{WebExtAPIRef("webNavigation.onErrorOccurred")}}
    • : エラーが起こってナビゲーションが停止したときに発火します。これはネットワークエラーが起きたときや、ユーザーがナビゲーションを停止したときのいずれかで起こりえます。
  • {{WebExtAPIRef("webNavigation.onCreatedNavigationTarget")}}
    • : 新しいウィンドウや、既存のウィンドウ内の新規タブが作成されてナビゲーションをホストするときに発火します: 例えば、ユーザーが新しいタブでリンクを開いた場合。
  • {{WebExtAPIRef("webNavigation.onReferenceFragmentUpdated")}}
  • {{WebExtAPIRef("webNavigation.onTabReplaced")}}
    • : タブのコンテンツが別のタブ (通常は以前レンダリング済みのもの) に置き換えられるときに発火します。
  • {{WebExtAPIRef("webNavigation.onHistoryStateUpdated")}}
    • : ページで history API を使ってブラウザーのロケーションバーの URL が更新されたときに発火します。

ブラウザーの互換性

{{Compat}}

{{WebExtExamples("h2")}}

Note

This API is based on Chromium's chrome.webNavigation API. This documentation is derived from web_navigation.json in the Chromium code.Microsoft Edge compatibility data is supplied by Microsoft Corporation and is included here under the Creative Commons Attribution 3.0 United States License.