Type Alias AppsOptions

Config for the apps that are available in the studio.

type AppsOptions = {
canvas?: { enabled: boolean; fallbackStudioOrigin?: string };
}

Index

Properties

Properties

`Optional`canvas

canvas?: { enabled: boolean; fallbackStudioOrigin?: string }

Type declaration

enabled: boolean
OptionalfallbackStudioOrigin?: string
To allow the "Link to canvas" action on localhost, or in studios not listed under Studios in https://www.sanity.io/manage provide a fallback origin as a string.

The string must be the exactly equal name as shown for the Studio in manage, and the studio must have create-manifest.json available.

If the provided fallback Studio does not expose create-manifest.json "Link to canvas" will fail when using the fallback.

Example: wonderful.sanity.studio

Keep in mind that when fallback origin is used, Canvas will use the schema types and dataset in the deployed Studio, not from localhost.

To see data synced from Canvas in your localhost Studio, you must ensure that the deployed fallback studio uses the same workspace and schemas as your local configuration.