observeState

Allows to receive contextual state and environmental information of the dashboard. The callback function provided to observeState receives the state data. The function is triggered when dashboard component initializes and whenever the state data is updated.

Common use cases for this method

  1. A dashboard page in an app's backoffice, receiving environment data from the host such as the user's locale.
  2. A widget rendered within the dashboard, receiving contextual data from the page that's hosting it.
  3. A modal opened from a dashboard page or from a widget, receiving data from either.

Signature

Copy

Function Parameters

NameTypeDescription
observerObserverCallback function for receiving state data that takes two parameters:
componentParams: The data that is sent to your component by your host, who is responsible for rendering it.
environmentState: General information about the user's present environment.

Observer

Copy
NameTypeDescription
componentParamsPA generic type parameter that indicates the data that is sent to your component by your host, who is responsible for rendering the component.
environmentStateEnvironmentStateState of the dashboard's environment.

EnvironmentState

Copy
NameTypeDescription
localestringUser's locale in ISO 639-1 format.
pageLocationPageLocationInformation about the currently rendered page location.

PageLocation

Copy
NameTypeDescription
pageIdstringID of the current page.
pathnamestringAny parts of the current URL path appended to the page's full URL path. Learn more.
searchstringOptional. The current URL's query string.
hashstringOptional. The current URL's fragment identifier.
About pathname

The value of pathname is any part of the URL path that comes after the route to the current dashboard page.

For third-party app dashboard pages, this is anything appended to the URL after the Relative route value that you set when creating the dashboard page extension in the Wix Developers Center.

Examples

To set up a dashboard client, refer to the setup guide.

Receive state passed by your host

Copy

Receive user's locale

Copy
Was this helpful?
Yes
No