Router

See the Router guide on how to create a Router component.

Properties

  • Name
    request
    Type
    Request
    Description

    A request when using the router as a controlled component, making the router independent of the browser.

  • Name
    defaultRequest
    Type
    Request
    Description

    An initial request when using the router as an uncontrolled component, making the router independent of the browser.

  • Name
    sticky
    Type
    boolean
    Type
    false
    Description

    The default sticky behavior for all navigations

  • Name
    dataTransform
    Type
    function
    Description

    A function to automatically transform navigation data.

  • Name
    relativeHistory
    Type
    boolean
    Type
    false
    Description

    Make history length relative to the initial history length.

  • Name
    delayLoadingMs
    Type
    integer
    Type
    30
    Description

    The amount of milliseconds to delay a loading indicator.

  • Name
    minimumLoadingMs
    Type
    integer
    Type
    500
    Description

    The minimum amount of milliseconds a loading indicator is visible.

  • Name
    defaultFormMethod
    Type
    string
    Type
    GET
    Description

    The default method property for forms.

  • Name
    onNavigate
    Type
    function
    Description

    A callback that is invoked when a navigation is initiated.

  • Name
    onCanceled
    Type
    function
    Description

    A callback that is invoked when a navigation is canceled.

  • Name
    onNavigateStart
    Type
    function
    Description

    A callback that is invoked when a navigation is not canceled.

  • Name
    onActionError
    Type
    function
    Description

    A callback that is invoked when a navigation action throws an error.

  • Name
    onAborted
    Type
    function
    Description

    A callback that is invoked when a navigation is aborted.

  • Name
    onNavigateEnd
    Type
    function
    Description

    A callback that is invoked when a navigation is finished.