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)

# openModal

Opens a modal component.

## Signature

```ts
(componentId: string, componentParams?: Record<string, any>) => { modalClosed: Promise<Serializable> }
```

## Parameters

| Name              | Type                  | Description                                                                                                                   |
|:------------------|:----------------------|:------------------------------------------------------------------------------------------------------------------------------|
| `componentId`     | `string`              | ID of the component to show in the modal, as defined in Wix Developer Center.                                                 |
| `componentParams` | `Record<string, any>` | Optional. Custom data to pass into the component, the component may consume this data using [observeState](resourceId::8a52c81b-a8bc-4f21-8433-2bcaac9e53aa*fallback::https://github.com/wix-private/developer-docs/blob/fac95c63c028345807bb3b881d2151707658367d/js-sdk-docs/dashboard/observeState.md) |

## Returns

```
{ modalClosed: Promise<Serializable> }
```

> **Note:** Do not use relative CSS height units such as `vh` in the components passed to this function. The SDK adjusts component heights automatically. If your component uses relative height units by default, make sure to turn them off. 

## 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/fac95c63c028345807bb3b881d2151707658367d/js-sdk-docs/dashboard/intro.md#setup) guide.

### Open a modal

```ts
client.dashboard.openModal('component-id');
```

### Pass extra data when opening a modal

```ts
const onNameChange = (newName: string) => {
  console.log('Name was changed.');
};
client.dashboard.openModal('component-id', { firstName: 'Name', onNameChange });
```
* This data can be consumed using the [observeState](resourceId::8a52c81b-a8bc-4f21-8433-2bcaac9e53aa*fallback::https://github.com/wix-private/developer-docs/blob/fac95c63c028345807bb3b881d2151707658367d/js-sdk-docs/dashboard/observeState.md) function.
* Note: Changes to the data passed into the modal won't trigger an update with [observeState](resourceId::8a52c81b-a8bc-4f21-8433-2bcaac9e53aa*fallback::https://github.com/wix-private/developer-docs/blob/fac95c63c028345807bb3b881d2151707658367d/js-sdk-docs/dashboard/observeState.md) (unlike the regular behavior of this method, that allows to obeserve to data changes).

### Get notified when the modal is closed
```ts
const { modalClosed } = client.dashboard.openModal('component-id');

modalClosed.then(result => {
  if(result) {
    console.log('The modal was closed and returned the value:', result);
  } else {
    console.log('The modal was closed without any data.'); 
  }
})
```

名称	タイプ	説明
`componentId`	`ストリング`	ID of the component to show in the modal, as defined in Wix Developer Center.
`componentParams`	`Record<string, any>`	Optional. Custom data to pass into the component, the component may consume this data using observeState