Interface RouteComponentBeta

Interface for components that are routed to and are registered with the RouteRegistry service.

Hierarchy

Properties

context hash? platform query? state? titleChanged?

Methods

componentDidLoad? componentDidRender? componentDidUpdate? componentShouldUpdate? componentWillLoad? componentWillRender? componentWillUpdate? connectedCallback? disconnectedCallback? render?

Properties

context

context: LimeWebComponentContext

The context this component belongs to

Optional hash

hash?: string

The URL fragment identifier

platform

platform: LimeWebComponentPlatform

Reference to the platform

Optional query

query?: Record<string, unknown>

Query parameters from the route URL

Optional state

state?: unknown

The history state

Optional titleChanged

titleChanged?: {
    emit: ((data?: string) => CustomEvent<string>);
}

When emitted, changes the document title property

Type declaration

  • emit: ((data?: string) => CustomEvent<string>)
      • (data?: string): CustomEvent<string>

      • Parameters

        • Optional data: string

        Returns CustomEvent<string>

Methods

Optional componentDidLoad

  • The component has loaded and has already rendered.

    Updating data in this method will cause the component to re-render.

    componentDidLoad will only be called once.

    Returns void

Optional componentDidRender

Optional componentDidUpdate

  • The component has just re-rendered.

    Called multiple times throughout the life of the component as it updates.

    componentWillUpdate is not called on the first render.

    Returns void

Optional componentShouldUpdate

  • A @Prop or @State property changed and a rerender is about to be requested.

    Called multiple times throughout the life of the component as its properties change.

    componentShouldUpdate is not called on the first render.

    Parameters

    • newVal: any
    • oldVal: any
    • propName: string

    Returns boolean | void

Optional componentWillLoad

  • The component is about to load and it has not rendered yet.

    This is the best place to make any data updates before the first render.

    componentWillLoad will only be called once.

    Returns void | Promise<void>

Optional componentWillRender

Optional componentWillUpdate

  • The component is about to update and re-render.

    Called multiple times throughout the life of the component as it updates.

    componentWillUpdate is not called on the first render.

    Returns void | Promise<void>

Optional connectedCallback

Optional disconnectedCallback

Optional render

Settings

Member Visibility

Theme