Class PageParam<T, TInput>Abstract

Page navigation parameter.

Can applied before navigation happened (i.e. to LeavePageEvent). Then it will be available to the target page both before and after navigation.

Type Parameters

  • T

    Parameter value type.

  • TInput

    Parameter input type.

Hierarchy

Implements

Constructors

Accessors

Methods

Constructors

  • Type Parameters

    • T

    • TInput

    Returns PageParam<T, TInput>

Accessors

Methods

  • Creates default page parameter handle.

    This method is called when requesting page parameter which value is not present in the page. The value handle returned is assigned to the page.

    Returns nothing by default.

    Returns

    New page parameter value handle or nothing if there is no default value.

    Parameters

    • _page: Page

      A page to assign navigation parameter to.

    • _bsContext: BootstrapContext

      Bootstrap context.

    Returns undefined | Handle<T, TInput>

  • Creates page parameter handle.

    This method is called when assigning new page parameter. It is called at most once per request, unless this parameter is assigned already. A put method will be called instead in the latter case.

    Returns

    New page parameter value handle.

    Parameters

    • page: Page

      A page to assign navigation parameter to.

    • input: TInput

      Parameter input used to construct its initial value.

    • bsContext: BootstrapContext

      Bootstrap context.

    Returns Handle<T, TInput>

Generated using TypeDoc