A RetroSearch Logo

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Search Query:

Showing content from https://html.spec.whatwg.org/multipage/document-sequences.html below:

HTML Standard

HTML

Living Standard — Last Updated 13 October 2025

← 7.2 APIs related to navigation and session historyTable of Contents7.4 Navigation and session history →
    1. 7.3 Infrastructure for sequences of documents
      1. 7.3.1 Navigables
        1. 7.3.1.1 Traversable navigables
        2. 7.3.1.2 Top-level traversables
        3. 7.3.1.3 Child navigables
        4. 7.3.1.4 Jake diagrams
        5. 7.3.1.5 Related navigable collections
        6. 7.3.1.6 Navigable destruction
        7. 7.3.1.7 Navigable target names
      2. 7.3.2 Browsing contexts
        1. 7.3.2.1 Creating browsing contexts
        2. 7.3.2.2 Related browsing contexts
        3. 7.3.2.3 Groupings of browsing contexts
      3. 7.3.3 Fully active documents
7.3 Infrastructure for sequences of documents

This standard contains several related concepts for grouping sequences of documents. As a brief, non-normative summary:

Most of this standard works in the language of navigables, but certain APIs expose the existence of browsing context switches, and so some parts of the standard need to work in terms of browsing contexts.

7.3.1 Navigables

A navigable presents a Document to the user via its active session history entry. Each navigable has:

The current session history entry and the active session history entry are usually the same, but they get out of sync when:

A navigable's active document is its active session history entry's document.

This can be safely read from within the session history traversal queue of the navigable's top-level traversable. Although a navigable's active history entry can change synchronously, the new entry will always have the same Document.

A navigable's active browsing context is its active document's browsing context. If this navigable is a traversable navigable, then its active browsing context will be a top-level browsing context.

A navigable's active WindowProxy is its active browsing context's associated WindowProxy.

A navigable's active window is its active WindowProxy's [[Window]].

This will always equal the navigable's active document's relevant global object; this is kept in sync by the make active algorithm.

A navigable's target name is its active session history entry's document state's navigable target name.

To get the node navigable of a node node, return the navigable whose active document is node's node document, or null if there is no such navigable.

7.3.1.1 Traversable navigables

A traversable navigable is a navigable that also controls which session history entry should be the current session history entry and active session history entry for itself and its descendant navigables.

In addition to the properties of a navigable, a traversable navigable has:

To get the traversable navigable of a navigable inputNavigable:

  1. Let navigable be inputNavigable.

  2. While navigable is not a traversable navigable, set navigable to navigable's parent.

  3. Return navigable.

7.3.1.2 Top-level traversables

A top-level traversable is a traversable navigable with a null parent.

Currently, all traversable navigables are top-level traversables. Future proposals envision introducing non-top-level traversables.

A user agent holds a top-level traversable set (a set of top-level traversables). These are typically presented to the user in the form of browser windows or browser tabs.

To get the top-level traversable of a navigable inputNavigable:

  1. Let navigable be inputNavigable.

  2. While navigable's parent is not null, set navigable to navigable's parent.

  3. Return navigable.

To create a fresh top-level traversable given a URL initialNavigationURL and an optional POST resource-or-null initialNavigationPostResource (default null):

  1. Let traversable be the result of creating a new top-level traversable given null and the empty string.

  2. Navigate traversable to initialNavigationURL using traversable's active document, with documentResource set to initialNavigationPostResource.

    We treat these initial navigations as traversable navigating itself, which will ensure all relevant security checks pass.

  3. Return traversable.

7.3.1.3 Child navigables

Certain elements (for example, iframe elements) can present a navigable to the user. These elements are called navigable containers.

Each navigable container has a content navigable, which is either a navigable or null. It is initially null.

The container of a navigable navigable is the navigable container whose content navigable is navigable, or null if there is no such element.

A navigable navigable is a child navigable of another navigable potentialParent when navigable's parent is potentialParent. We can also just say that a navigable "is a child navigable", which means that its parent is non-null.

All child navigables are the content navigable of their container.

7.3.1.4 Jake diagrams

A useful method for visualizing sequences of documents, and in particular navigables and their session history entries, is the Jake diagram. A typical Jake diagram is the following:

0 1 2 3 4 top /t-a /t-a#foo /t-b frames[0] /i-0-a /i-0-b frames[1] /i-1-a /i-1-b

Here, each numbered column denotes a possible value for the traversable's session history step. Each labeled row depicts a navigable, as it transitions between different URLs and documents. The first, labeled top, being the top-level traversable, and the others being child navigables. The documents are given by the background color of each cell, with a new background color indicating a new document in that navigable. The URLs are given by the text content of the cells; usually they are given as relative URLs for brevity, unless a cross-origin case is specifically under investigation. A given navigable might not exist at a given step, in which case the corresponding cells are empty. The bold-italic step number depicts the current session history step of the traversable, and all cells with bold-italic URLs represent the current session history entry for that row's navigable.

Thus, the above Jake diagram depicts the following sequence of events:

  1. A top-level traversable is created, starting at the URL /t-a, with two child navigables starting at /i-0-a and /i-1-a respectively.

  2. The first child navigable is navigated to another document, with URL /i-0-b.

  3. The second child navigable is navigated to another document, with URL /i-1-b.

  4. The top-level traversable is navigated to the same document, updating its URL to /t-a#foo.

  5. The top-level traversable is navigated to another document, with URL /t-b. (Notice how this document, of course, does not carry over the old document's child navigables.)

  6. The traversable was traversed by a delta of −3, back to step 1.

Jake diagrams are a powerful tool for visualizing the interactions of multiple navigables, navigations, and traversals. They cannot capture every possible interaction — for example, they only work with a single level of nesting — but we will have ocassion to use them to illustrate several complex situations throughout this standard.

Jake diagrams are named after their creator, the inimitable Jake Archibald.

It is often helpful in this standard's algorithms to look at collections of navigables starting at a given . This section contains a curated set of algorithms for collecting those navigables.

The return values of these algorithms are ordered so that parents appears before their children. Callers rely on this ordering.

Starting with a , rather than a navigable, is generally better because it makes the caller cognizant of whether they are starting with a fully active or not. Although non-fully active s do have ancestor and descendant navigables, they often behave as if they don't (e.g., in the getter).

The ancestor navigables of a document are given by these steps:

  1. Let navigable be document's node navigable's parent.

  2. Let ancestors be an empty list.

  3. While navigable is not null:

    1. Prepend navigable to ancestors.

    2. Set navigable to navigable's parent.

  4. Return ancestors.

These descendant-collecting algorithms are described as looking at the DOM tree of descendant objects. In reality, this is often not feasible since the DOM tree can be in another process from the caller of the algorithm. Instead, implementations generally replicate the appropriate trees across processes.

7.3.1.6 Navigable destruction

User agents may destroy a top-level traversable at any time (typically, in response to user requests).

The close vs. definitely close separation allows other specifications to call close and have it be a no-op if the top-level traversable is already closing due to JavaScript code calling window.close().

7.3.1.7 Navigable target names

Navigables can be given target names, which are strings allowing certain APIs (such as window.open() or the a element's target attribute) to target navigations at that navigable.

A valid navigable target name is any string with at least one character that does not contain both an ASCII tab or newline and a U+003C (<), and it does not start with a U+005F (_). (Names starting with a U+005F (_) are reserved for special keywords.)

A valid navigable target name or keyword is any string that is either a valid navigable target name or that is an ASCII case-insensitive match for one of: _blank, _self, _parent, or _top.

These values have different meanings based on whether the page is sandboxed or not, as summarized in the following (non-normative) table. In this table, "current" means the navigable that the link or script is in, "parent" means the parent of the navigable that the link or script is in, "top" means the top-level traversable of the navigable that the link or script is in, "new" means a new traversable navigable with a null parent (which may use an auxiliary browsing context, subject to various user preferences and user agent policies), "none" means that nothing will happen, and "maybe new" means the same as "new" if the "allow-popups" keyword is also specified on the sandbox attribute (or if the user overrode the sandboxing), and the same as "none" otherwise.

Keyword Ordinary effect Effect in an iframe with... sandbox="" sandbox="allow-top-navigation" none specified, for links and form submissions current current current empty string current current current _blank new maybe new maybe new _self current current current _parent if there isn't a parent current current current _parent if parent is also top parent/top none parent/top _parent if there is one and it's not top parent none none _top if top is current current current current _top if top is not current top none top name that doesn't exist new maybe new maybe new name that exists and is a descendant specified descendant specified descendant specified descendant name that exists and is current current current current name that exists and is an ancestor that is top specified ancestor none specified ancestor/top name that exists and is an ancestor that is not top specified ancestor none none other name that exists with common top specified none none name that exists with different top, if familiar and one permitted sandboxed navigator specified specified specified name that exists with different top, if familiar but not one permitted sandboxed navigator specified none none name that exists with different top, not familiar new maybe new maybe new

Most of the restrictions on sandboxed browsing contexts are applied by other algorithms, e.g. the navigation algorithm, not the rules for choosing a navigable given below.

To find a navigable by target name given a string name and a navigable currentNavigable:

  1. Let currentDocument be currentNavigable's active document.

  2. Let sourceSnapshotParams be the result of snapshotting source snapshot params given currentDocument.

  3. Let subtreesToSearch be an implementation-defined choice of one of the following:

    Issue #10848 tracks settling on one of these two possibilities, to achieve interoperability.

  4. For each subtreeToSearch of subtreesToSearch, in reverse order:

    1. Let documentToSearch be subtreeToSearch's active document.

    2. For each navigable of the inclusive descendant navigables of documentToSearch:

      1. If currentNavigable is not allowed by sandboxing to navigate navigable given sourceSnapshotParams, then optionally continue.

        Issue #10849 tracks making this check required, to achieve interoperability.

      2. If navigable's target name is name, then return navigable.

  5. Let currentTopLevelBrowsingContext be currentNavigable's active browsing context's top-level browsing context.

  6. Let group be currentTopLevelBrowsingContext's group.

  7. For each topLevelBrowsingContext of group's browsing context set, in an implementation-defined order (the user agent should pick a consistent ordering, such as the most recently opened, most recently focused, or more closely related):

    Issue #10850 tracks picking a specific ordering, to achieve interoperability.

    1. If currentTopLevelBrowsingContext is topLevelBrowsingContext, then continue.

    2. Let documentToSearch be topLevelBrowsingContext's active document.

    3. For each navigable of the inclusive descendant navigables of documentToSearch:

      1. If currentNavigable's active browsing context is not familiar with navigable's active browsing context, then continue.

      2. If currentNavigable is not allowed by sandboxing to navigate navigable given sourceSnapshotParams, then optionally continue.

        Issue #10849 tracks making this check required, to achieve interoperability.

      3. If navigable's target name is name, then return navigable.

  8. Return null.

The rules for choosing a navigable, given a string name, a navigable currentNavigable, and a boolean noopener are as follows:

  1. Let chosen be null.

  2. Let windowType be "existing or none".

  3. Let sandboxingFlagSet be currentNavigable's active document's active sandboxing flag set.

  4. If name is the empty string or an ASCII case-insensitive match for "_self", then set chosen to currentNavigable.

  5. Otherwise, if name is an ASCII case-insensitive match for "_parent", set chosen to currentNavigable's parent, if any, and currentNavigable otherwise.

  6. Otherwise, if name is an ASCII case-insensitive match for "_top", set chosen to currentNavigable's traversable navigable.

  7. Otherwise, if name is not an ASCII case-insensitive match for "_blank" and noopener is false, then set chosen to the result of finding a navigable by target name given name and currentNavigable.

  8. If chosen is null, then a new top-level traversable is being requested, and what happens depends on the user agent's configuration and abilities — it is determined by the rules given for the first applicable option from the following list:

    The user agent may inform the user that a popup has been blocked.

    If sandboxingFlagSet has the sandboxed auxiliary navigation browsing context flag set

    The user agent may report to a developer console that a popup has been blocked.

    If the user agent has been configured such that in this instance it will create a new top-level traversable
    1. Consume user activation of currentNavigable's active window.

    2. Set windowType to "new and unrestricted".

    3. Let currentDocument be currentNavigable's active document.

    4. If currentDocument's opener policy's value is "same-origin" or "same-origin-plus-COEP", and currentDocument's origin is not same origin with currentDocument's relevant settings object's top-level origin, then:

      1. Set noopener to true.

      2. Set name to "_blank".

      3. Set windowType to "new with no opener".

      In the presence of an opener policy, nested documents that are cross-origin with their top-level browsing context's active document always set noopener to true.

    5. Let targetName be the empty string.

    6. If name is not an ASCII case-insensitive match for "_blank", then set targetName to name.

    7. If noopener is true, then set chosen to the result of creating a new top-level traversable given null, targetName, and currentNavigable.

    8. Otherwise:

      1. Set chosen to the result of creating a new top-level traversable given currentNavigable's active browsing context, targetName, and currentNavigable.

      2. If sandboxingFlagSet's sandboxed navigation browsing context flag is set, then set chosen's active browsing context's one permitted sandboxed navigator to currentNavigable's active browsing context.

    9. If sandboxingFlagSet's sandbox propagates to auxiliary browsing contexts flag is set, then all the flags that are set in sandboxingFlagSet must be set in chosen's active browsing context's popup sandboxing flag set.

    10. Set chosen's is created by web content to true.

    If the newly created navigable chosen is immediately navigated, then the navigation will be done as a "replace" navigation.

    If the user agent has been configured such that in this instance it will choose currentNavigable

    Set chosen to currentNavigable.

    If the user agent has been configured such that in this instance it will not find a navigable

    Do nothing.

    User agents are encouraged to provide a way for users to configure the user agent to always choose currentNavigable.

  9. Return chosen and windowType.

7.3.2 Browsing contexts

A browsing context is a programmatic representation of a series of documents, multiple of which can live within a single navigable. Each browsing context has a corresponding WindowProxy object, as well as the following:

A browsing context's active window is its WindowProxy object's [[Window]] internal slot value. A browsing context's active document is its active window's associated Document.

A browsing context's top-level traversable is its active document's node navigable's top-level traversable.

A browsing context whose is auxiliary is true is known as an auxiliary browsing context. Auxiliary browsing contexts are always top-level browsing contexts.

It's unclear whether a separate is auxiliary concept is necessary. In issue #5680, it is indicated that we may be able to simplify this by using whether or not the opener browsing context is null.

Modern specifications should avoid using the browsing context concept in most cases, unless they are dealing with the subtleties of browsing context group switches and agent cluster allocation. Instead, the Document and navigable concepts are usually more appropriate.

A Document's browsing context is a browsing context or null, initially null.

A Document does not necessarily have a non-null browsing context. In particular, data mining tools are likely to never instantiate browsing contexts. A Document created using an API such as createDocument() never has a non-null browsing context. And the Document originally created for an iframe element, which has since been removed from the document, has no associated browsing context, since that browsing context was nulled out.

In general, there is a 1-to-1 mapping from the Window object to the Document object, as long as the Document object has a non-null browsing context. There is one exception. A Window can be reused for the presentation of a second Document in the same browsing context, such that the mapping is then 1-to-2. This occurs when a browsing context is navigated from the initial about:blank Document to another, which will be done with replacement.

7.3.2.1 Creating browsing contexts

To create a new browsing context and document, given null or a Document object creator, null or an element embedder, and a browsing context group group:

  1. Let browsingContext be a new browsing context.

  2. Let unsafeContextCreationTime be the .

  3. Let creatorOrigin be null.

  4. Let creatorBaseURL be null.

  5. If creator is non-null, then:

    1. Set creatorOrigin to creator's origin.

    2. Set creatorBaseURL to creator's document base URL.

    3. Set browsingContext's virtual browsing context group ID to creator's browsing context's top-level browsing context's virtual browsing context group ID.

  6. Let sandboxFlags be the result of determining the creation sandboxing flags given browsingContext and embedder.

  7. Let origin be the result of determining the origin given about:blank, sandboxFlags, and creatorOrigin.

  8. Let permissionsPolicy be the result of creating a permissions policy given embedder and origin. [PERMISSIONSPOLICY]

  9. Let agent be the result of obtaining a similar-origin window agent given origin, group, and false.

  10. Let realm execution context be the result of creating a new realm given agent and the following customizations:

  11. Let topLevelCreationURL be about:blank if embedder is null; otherwise embedder's relevant settings object's top-level creation URL.

  12. Let topLevelOrigin be origin if embedder is null; otherwise embedder's relevant settings object's top-level origin.

  13. Set up a window environment settings object with about:blank, realm execution context, null, topLevelCreationURL, and topLevelOrigin.

  14. Let loadTimingInfo be a new document load timing info with its navigation start time set to the result of calling coarsen time with unsafeContextCreationTime and the new environment settings object's cross-origin isolated capability.

  15. Let document be a new Document, with:

    type
    "html"
    content type
    "text/html"
    mode
    "quirks"
    origin
    origin
    browsing context
    browsingContext
    permissions policy
    permissionsPolicy
    active sandboxing flag set
    sandboxFlags
    load timing info
    loadTimingInfo
    is initial about:blank
    true
    about base URL
    creatorBaseURL
    allow declarative shadow roots
    true
    custom element registry
    a new CustomElementRegistry object
  16. If creator is non-null, then:

    1. Set document's referrer to the serialization of creator's URL.

    2. Set document's policy container to a clone of creator's policy container.

    3. If creator's origin is same origin with creator's relevant settings object's top-level origin, then set document's opener policy to creator's browsing context's top-level browsing context's active document's opener policy.

  17. Assert: document's URL and document's relevant settings object's creation URL are about:blank.

  18. Mark document as ready for post-load tasks.

  19. Populate with html/head/body given document.

  20. Make active document.

  21. Completely finish loading document.

  22. Return browsingContext and document.

7.3.2.2 Related browsing contexts

A browsing context potentialDescendant is said to be an ancestor of a browsing context potentialAncestor if the following algorithm returns true:

  1. Let potentialDescendantDocument be potentialDescendant's active document.

  2. If potentialDescendantDocument is not fully active, then return false.

  3. Let ancestorBCs be the list obtained by taking the browsing context of the active document of each member of potentialDescendantDocument's ancestor navigables.

  4. If ancestorBCs contains potentialAncestor, then return true.

  5. Return false.

A top-level browsing context is a browsing context whose active document's node navigable is a traversable navigable.

It is not required to be a top-level traversable.

7.3.2.3 Groupings of browsing contexts

A top-level browsing context has an associated group (null or a browsing context group). It is initially null.

A user agent holds a browsing context group set (a set of browsing context groups).

A browsing context group holds a browsing context set (a set of top-level browsing contexts).

A top-level browsing context is added to the group when the group is created. All subsequent top-level browsing contexts added to the group will be auxiliary browsing contexts.

A browsing context group has an associated agent cluster map (a weak map of agent cluster keys to agent clusters). User agents are responsible for collecting agent clusters when it is deemed that nothing can access them anymore.

A browsing context group has an associated historical agent cluster key map, which is a map of origins to agent cluster keys. This map is used to ensure the consistency of the origin-keyed agent clusters feature by recording what agent cluster keys were previously used for a given origin.

The historical agent cluster key map only ever gains entries over the lifetime of the browsing context group.

A browsing context group has a cross-origin isolation mode, which is a cross-origin isolation mode. It is initially "none".

A cross-origin isolation mode is one of three possible values: "none", "logical", or "concrete".

Append and remove are primitive operations that help define the lifetime of a browsing context group. They are called by higher-level creation and destruction operations for Documents and browsing contexts.

When there are no Document objects whose browsing context equals a given browsing context (i.e., all such Documents have been destroyed), and that browsing context's WindowProxy is eligible for garbage collection, then the browsing context will never be accessed again. If it is a top-level browsing context, then at this point the user agent must remove it.

7.3.3 Fully active documents

A Document d is said to be fully active when d is the active document of a navigable navigable, and either navigable is a top-level traversable or navigable's container document is fully active.

Because they are associated with an element, child navigables are always tied to a specific Document, their container document, in their parent navigable. User agents must not allow the user to interact with child navigables whose container documents are not themselves fully active.

The following example illustrates how a Document can be the active document of its node navigable, while not being fully active. Here a.html is loaded into a browser window, b-1.html starts out loaded into an iframe as shown, and b-2.html and c.html are omitted (they can simply be an empty document).

<!-- a.html -->
<!DOCTYPE html>
<html lang="en">
<title>Navigable A</title>

<iframe src="b-1.html"></iframe>
<button onclick="frames[0].location.href = 'b-2.html'">Click me</button>

<!-- b-1.html -->
<!DOCTYPE html>
<html lang="en">
<title>Navigable B</title>

<iframe src="c.html"></iframe>

At this point, the documents given by a.html, b-1.html, and c.html are all the active documents of their respective node navigables. They are also all fully active.

After clicking on the button, and thus loading a new Document from b-2.html into navigable B, we have the following results:

← 7.2 APIs related to navigation and session historyTable of Contents7.4 Navigation and session history →

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.5