Get to know our frameworks

Select an app template built on your preferred framework.

Build apps on our native app editor. Use drag and drop elements, Velo code and Wix APIs to develop custom features.

Streamline your app development process with the Wix CLI. Get a familiar developer experience with minimal setup and configuration.

Take full control over your app's tech stack, deployment, and hosting.

App templates

Wix Blocks templates

Wix CLI templates

Self-hosted templates

Kickstart your app development with templates built on your preferred Wix developer tool. Browse templates for practical foundation and get to know the Wix ecosystem.

Wix App Templates for Developers

This example apps can be used as a starting point for building your own app, for concrete examples of how to use Wix framework, or for inspiration.

Choose a template.<0 />Build an app.

Browse by:

How to build it step by step:

This template is built with:

Read how this template was built, step by step.

How we built this template

Deployment instructions:

Choose a package manager and run the command in your terminal.

Copy command

Before you get started, make sure you have the following:

Prerequisite steps

Get started with Wix CLI

Begin by setting up your Next.js project with your preferred hosting platform.

Select your hosting service

Start the deployment flow and set up your template repo on Netlify. After you finish set up, come back here and add your Netlify custom domain.

Copy the code from our Git repo to deploy your app on any platform that supports Next.js.

Start the deployment flow and set up your template repo on Vercel. After you finish set up, come back here and add your Vercel generated URL.

Add the base URL and give your app a name.

App details

Go to the app dashboard and test your app to ensure a smooth integration within the Wix ecosystem. <0>Learn more about app checks and testing</0>

Define your environment

Terminal

Related templates

Note

Warning

Your app name will be used as the namespace suffix.

Name your app to generate a namespace. This lets you refer to your app in code later on.

Go Headless

Build Apps

Client

API Preview

Ricos

Develop Websites

REST

Velo

GraphQL (Alpha)

# 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

```ts
observeState<P>(observer: Observer<P>): void
```

## Function Parameters

| Name       | Type       | Description                                    |
|:-----------|:-----------|------------------------------------------------|
| `observer` | `Observer` | Callback function for receiving state data that takes two parameters:<br/>`componentParams`: The data that is sent to your component by your host, who is responsible for rendering it.<br/>`environmentState`: General information about the user's present environment. |

### Observer
```ts
(componentParams: P, environmentState: EnvironmentState) => void
```

| Name        | Type               | Description                                    |
|:------------|:-------------------|------------------------------------------------|
| `componentParams` | `P`                | A generic type parameter that indicates the data that is sent to your component by your host, who is responsible for rendering the component. |
| `environmentState`  | `EnvironmentState` | State of the dashboard's environment.          |


#### EnvironmentState
```ts
{
  locale: string;
  pageLocation: PageLocation;
}
```

| Name           | Type           | Description                                            |
|:---------------|:---------------|--------------------------------------------------------|
| `locale`       | `string`       | User's locale in [ISO 639-1](fallback::https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format.                    |
| `pageLocation` | `PageLocation` | Information about the currently rendered page location. |


#### PageLocation
```ts
{
  pageId: string;
  pathname: string;
  search?: string;
  hash?: string;
}
```

| Name       | Type     | Description                                                   |
|:-----------|:---------|-------------------------------------------------------------------|
| `pageId`   | `string` | ID of the current page.             |
| `pathname` | `string` | Any parts of the current URL path appended to the page's full URL path. [Learn more](fallback::#about-pathname). |
| `search`   | `string` | Optional. The current URL's query string.          |
| `hash`     | `string` | Optional. 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](fallback::https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/docs/build-apps/develop-your-app/frameworks/wix-cli/supported-extensions/dashboard-extensions/dashboard-pages/add-dashboard-page-extensions-with-the-cli) extension in the Wix Developers Center.




## Examples
To set up a dashboard client, refer to the [setup](resourceId::b5088d52-82f9-44cc-b1a2-fea83606d85d#setup*fallback::https://github.com/wix-private/developer-docs/blob/8a0746815bf80b35980f3010e9502431748b1da2/js-sdk-docs/dashboard/intro.md#setup*original::./intro.md#setup) guide.

### Receive state passed by your host

```javascript
client.dashboard.observeState((componentParams) => {
  // This value is logged on initialization and whenever the `observer` object changes. 
  console.log(componentParams.customPageParameter);
});
```

### Receive user's locale

```javascript
client.dashboard.observeState((_, environmentState) => {
  // This value is logged on initialization and whenever the `observer` object changes. 
  console.log(environmentState.locale);  
});
```

名称	タイプ	説明
`componentParams`	`P`	A generic type parameter that indicates the data that is sent to your component by your host, who is responsible for rendering the component.
`environmentState`	`EnvironmentState`	State of the dashboard's environment.

名称	タイプ	説明
`locale`	`ストリング`	User's locale in ISO 639-1 format.
`pageLocation`	`PageLocation`	Information about the currently rendered page location.

名称	タイプ	説明
`pageId`	`ストリング`	ID of the current page.
`pathname`	`ストリング`	Any parts of the current URL path appended to the page's full URL path. Learn more.
`探索`	`ストリング`	Optional. The current URL's query string.
`hash`	`ストリング`	Optional. The current URL's fragment identifier.

observeState

Common use cases for this method

署名

Function Parameters

Observer

EnvironmentState

PageLocation

について `pathname`

例

Receive state passed by your host

Receive user's locale