App Settings

The webflow.json file is used to configure a Webflow app and define parameters that control its behavior. This file allows developers to include important details such as the app’s name, size, and public directory.

Parameters

name (string, required)

The name parameter specifies the name of the Webflow app. It should be a descriptive and unique name that helps identify the app.

JSON
1{
2  "name": "My Awesome Webflow App"
3}

apiVersion (string, required)

The apiVersion parameter specifies the version of the Designer APIs you’re using.

1{
2	"apiVersion": "2"
3}

size (string, optional)

The size parameter defines the size of the Designer Extension window. Available sizes include:

  • default: 240px by 360px - Great for simple apps that don’t require much real estate
  • comfortable: 320px by 460px - For apps like form submissions that may require a bit more room
  • large: 800px by 600px - For apps that require in-depth work flows, previews, or in depth control

If a size is not declared in the webflow.json file, the Designer Extension window will open to the default size of 240px by 360px. To be explicit about this behavior, you can add { "size": "default"} to your manifest file.

{
  ...
  "size": "default"
}

publicDir (string, optional)

The publicDir parameter determines the directory from which the Webflow app will be served. By defining a custom publicDir, developers have more control over the organization and structure of their web application’s static files.

If a publicDir is not declared in the webflow.json file, the Designer Extension will expect to load the designer extension from the /public directory. To be explicit about this behavior, you can add { "publicDir": "public" } to your manifest file.

{
  ...
  "publicDir": "dist"
}