Configure editor extension collections
An editor extension collection groups related extensions from the same app, so that merchants know to enable them together. A collection is a config-only extension: it has no source code of its own, and is defined entirely in a shopify.extension.toml file.
To generate a collection, run shopify app generate extension and select Editor extension collection. For a full walkthrough, refer to Build an editor extension collection.
Anchor to Configuration fileConfiguration file
The following example shows a shopify.extension.toml file for an editor extension collection:
shopify.extension.toml
[[extensions]]
name = "t:collection_name"
type = "editor_extension_collection"
handle = "editor-extension-collection"
uid = "8723da04-b91d-e812-2091-52c161b3b2892fa89479"
includes = ["customer-account-ui", "checkout-ui-extension"]
The following table describes the properties in the file:
| Property | Required? | Description |
|---|---|---|
name | Yes | The merchant-facing name of the collection. The name property is translatable if it starts with t: and uses a key defined in your translation data. For example, t:collection_name matches a translation key called collection_name. |
type | Yes | The extension type. For an editor extension collection, this value is always editor_extension_collection. |
handle | Yes | A unique reference name for the collection within your app. Used when referencing the collection in configuration, APIs, and the Dev Dashboard. |
uid | Yes | The extension user identifier. An app-scoped identifier that shopify app deploy uses to determine whether an extension is being created, updated, or deleted. uid is created and managed by Shopify: it's generated automatically when you scaffold the extension with Shopify CLI, so you don't need to set or edit it manually. It must be unique within the app. |
includes | Yes | An array of the handle values of the extensions to group in the collection.Limitations:
|
Anchor to Next stepsNext steps
Was this page helpful?