Navigated page representation.

Represents a navigation history entry.

Hierarchy

  • Page

Properties

Methods

Properties

current: boolean

Whether the page is the one opened in browser.

data?: unknown

History entry data.

title?: string

New window title.

url: URL

Page location URL.

visited: boolean

Whether this page is visited at least one.

This is false for target pages before navigating to them.

Methods

  • Requests a page navigation parameter of this page that guaranteed to have value.

    The requested parameter has default value.

    Returns

    The requested parameter value.

    Type Parameters

    • T

      Parameter value type.

    Parameters

    Returns T

  • Requests arbitrary page navigation parameter of this page.

    Returns

    Either requested parameter value, or undefined if requested parameter is not assigned to the page.

    Type Parameters

    • T

      Parameter value type.

    Parameters

    • ref: PageParam.Ref<T, unknown>

      A reference to page navigation parameter to retrieve.

    Returns undefined | T

  • Puts navigation parameter to this page.

    The meaning of putting depends on type parameter implementation. This can be e.g. a value assignment, or appending to the list of values.

    Type Parameters

    • T

      Parameter value type.

    • TInput

      Parameter input type.

    Parameters

    • ref: PageParam.Ref<T, TInput>

      A reference to page navigation parameter to put.

    • input: TInput

      Parameter input to use when constructing its value.

    Returns void

Generated using TypeDoc