Getting started with theme app extensions

After you've finished this tutorial, you'll have accomplished the following tasks:

• Created a theme app extension
• Previewed a theme app extension
• Deployed the theme app extension
• Tested the theme app extension
• Added onboarding instructions in your app
• Published the theme app extension

• You've created a Partner account.
• You've created a development store.
• You've created an app that uses Shopify CLI 3.0 or higher, or you've migrated your existing app so it's compatible with Shopify CLI 3.0 or higher.
• You've populated your store with test products.
• You've installed an Online Store 2.0 theme, such as Dawn, that uses JSON templates and supports app blocks.
• You understand the theme app extensions framework.

You'll use Shopify CLI to generate a new extension.

1. Navigate to the directory of the app that you want to add your extension to.

2. Run the following command to start creating the extension:

3. Select Theme app extension as the extension type.

4. Provide a name for your extension.

You should now have a new extension directory that includes a working example of a theme app extension that displays product ratings.

The generated extension requires a metafield definition with the following properties:

• Area: Products
• Namespace: demo
• Key: avg_rating
• Type: Integer

After you create the metafield definition, set a value for the metafield on at least one product in your development store.

You can preview your extension by running the dev command, which starts a local development server that supports hot reloading. This preview is available only in Google Chrome.

1. Navigate to your app directory.

2. Run one of the following commands:

   
   You can specify which theme you want to use to host your theme app extension using the --theme <ID or name> flag. If you don't specify a theme, then the command will upload Dawn, Shopify's example theme, to the development store.

   
   When you run the dev command, the CLI builds your app and bundles your app extensions. It also walks you through multiple configuration steps. If you've already run dev or deploy for this app, then some of these steps are skipped.

   To learn about the processes that are executed when you run dev, refer to the Shopify CLI command reference.

3. Follow the instructions in the CLI output to preview the theme app extension. This includes the following steps:

   • Enabling development store preview for the extension in the Partner Dashboard.
   • Opening the host theme in the theme editor, adding your app block to the theme, and saving it.

4. Click the URL that's printed at the bottom of the CLI output to preview your extension.

After your extension is created, you can deploy your extension code to Shopify. The deploy command pushes app updates to draft versions on your development store. You can test your theme app extension in a sandbox environment before publishing to online stores.

1. Navigate to your app directory.

2. Run one of the following commands:

   
   

   When you run the deploy command, the CLI builds your app, bundles your app extensions, and deploys the extensions to Shopify as drafts. It also guides you through multiple configuration steps. If you've already run dev or deploy for this app, then some of these steps are skipped.

   To learn about the processes that are executed when you run deploy, refer to the Shopify CLI command reference.

3. After you deploy the extension to Shopify, navigate to your app in the Partner Dashboard, click Extensions, and click the name of the extension.

4. In the Development Store Preview section, click Enable.

Verify that your app looks and behaves correctly by testing your changes on a theme in your development store.

1. In your development store, go to an Online Store 2.0 theme and navigate to the theme editor.

2. Follow the procedures for:

   • Adding app blocks
   • Activating app embed blocks

3. Verify the app behaves as expected. For some examples of what to look for, refer to the recommendations for lifecycle management.

Provide instructions for what merchants need to do to after installing your app. For more information, refer to the UX guidelines.

After your theme app extension is ready for online stores, you can deploy the latest code and make the app extension public.

1. Navigate to your app directory.

2. Run one of the following commands:

3. After you deploy the extension to Shopify, navigate to your app in the Partner Dashboard, click Extensions, and click the name of the extension.

4. Click Create version to create a version of your theme app extension.

5. Click Publish beside the version that you want to publish, and click Publish in the popup modal to confirm.

   It might take up to five minutes for merchants using the app to be upgraded to the new version. For more information about extension versioning and publishing, refer to Deploy and publish an app extension.