Skip to main content

App structure

Apps are structured to work seamlessly with the Shopify admin and to provide an intuitive experience for merchants.

An app in the Shopify admin. Numbered indicators show the Shopify admin (labeled 1), app nav (labeled 2), app header (labeled 3), page header (labeled 4), overflow menu (labeled 5), and app body (labeled 6).

Anatomy

  1. The Shopify admin
  2. App nav
  3. App header
  4. Page header
  5. Overflow menu
  6. App body

Apps consist of a few navigation elements and the app body, which is the center of your app's experience.

App navigation is strictly configured, and it's an important part of providing a great merchant experience. For more details, refer to the navigation guidelines.

The app body highlighted within the Shopify admin.

App body

The app body is where your app's main experience lives.

Be sure to follow the layout guidelines when you choose a layout for the app body.

Max modal

Max modal is a focused environment for specific immersive tasks. Refer to Polaris for guidance on overlays.

The modal utilizes the following areas of the app interface:

  1. Modal header: The max modal can contain a top bar element to render a primary and a secondary action.
  2. App body: The modal body is where you can add all the content for a full-screen experience.
An empty max modal with the modal header at the top and an empty modal body below.

When to use max modal

Use max modal when merchants need to complete a focused task, where leveraging the full viewport improves the user experience.

The following are some example use cases:

  • Complex editing experiences, such as an editor for creating newsletter content
  • Immersive experiences, such as an editor for cropping and modifying images
  • Previews, such as an app that adds elements to a product page and enables merchants to preview changes
The Puzzlify template editor in a max modal with a wireframed title bar.

Behavior

Max modal launches only after merchants interact with a button that indicates the entire canvas will be used.

A modal header with a secondary button labeled 'Change puzzle template' and a primary button labeled 'Save'.

Primary navigation for the app should be shown in the top bar of the modal and the primary actions should not be duplicated. This applies to developers using the latest version of App Bridge.

A dialog box that reads "Your template has unsaved changes. Changes will be lost if you leave without saving". There is a primary button that's labeled "Save Changes" and a secondary button that's labeled "Leave without saving".

If there are unsaved changes, prompt merchants to save before exiting full-screen mode.

A modal with the title "Are you sure you want to exit?" and text "You're about to leave the template editor and go back to the Puzzlify home page.". The modal has a secondary button with the label "No, I want to stay" and a primary button with the label "Yes, I"m sure".

Avoid unnecessarily interrupting a merchant's workflow when exiting modal.

An image of a link in the Shopify navigation bar launching a full-screen experience.

Your app should not launch full-screen or the max modal from the app nav. Instead, they should launch from the app body. This is an app store requirement.

A max modal that contains a fullscreen bar.

Avoid using the FullscreenBar within a max modal, as it results in redundant mechanisms to dismiss the modal.

Admin UI extensions

Use admin UI extensions to integrate more deeply with the Shopify admin and create seamless merchant workflows.

Choose from the following extensions:

  1. Admin block
  2. Admin action
  3. Admin link
  4. Bulk action

Additional admin extensions are available for more specific use cases.

Admin blocks (labeled 1) live in the body area of the admin. Admin actions (labeled 2) live in the more actions dropdown. And Admin links (labeled 3) also live in the more actions dropdown.
An admin action modal.
The bulk action menu at the bottom of an index page.
An app block card being used for promotion. The block is labeled "Install companion app". There is a secondary button that reads "Install companion app" and another secondary button that reads "Write a review".

The extension can't be used to display promotions or advertisements. This includes promoting your app, related apps, or requesting app reviews. This is an app store requirement.

App attribution

Shopify will badge all admin UI extensions with the app icon, name, and a link to your app URL.

Hovering over the app attribution indicator reveals the full app name and color logo.

The app attribution component displays your app's logo and extension name as it displays in the Shopify App Store.

When to use admin blocks

Use admin block extensions to offer your app's functionality or data in the context of a resource detail page. Merchants have the option to add your app block to a page, and arrange it in the page layout.

App blocks can be embedded into Product, Order, or Customer detail pages using these extension targets.

Learn more about admin blocks.

The app blocks card featuring a search input and several apps.
Guidelines indicate the maximum height of an app block.

Contents should be less than 600px in height, to avoid overly tall app blocks. If necessary, implement pagination to ensure that this requirement is met.

A simple form with several input fields.

Input fields should be visible at all times. If necessary, app blocks should trigger app actions to ensure that this requirement is met.

An example of an app block featuring an empty state and a non-empty state.

Your block should have an empty state that informs merchants about what your app block does. For example, it should tell merchants what data will display in the block.

A simple app block form with the Shopify contextual save bar visible. The bar indicates that there are unsaved changes, and includes buttons to discard or save changes.

Inputs in your block can work with the contextual save bar by using the Form component, which provides merchants with a familiar save and validation experience.

When to use admin actions

Use admin action extensions to offer merchants quick access to common actions that they might do with your app. Because apps can add an unlimited number of admin actions, use discrete actions for discrete purposes.

App actions can be targeted to these extension targets.

Learn more about admin actions.

Multiple admin actions from the same app in the "More actions" menu.

Apps can have multiple admin action extensions, which display in the More actions menus.

An app block modal with height guidelines overlayed.

Avoid action content that exceeds 1200px and avoid using more than two steps of pagination. Otherwise, your app can be difficult to navigate.

When to use admin links and bulk actions

If your content doesn't fit well within the format of the block or action, then use an admin link or bulk action instead. If an interaction is complex, such as one that requires more screen space, then routing merchants into your app is a better experience.

Examples include a multi-step process, a very long form with multiple dynamic sections, or a complex editor with several columns.

A wireframe of an open "More actions" menu.

Admin links show up in the More actions menus.

A wireframe of a listing page with a floating "More actions" menu at the bottom.

Bulk actions show up in the More actions menu of bulk actions controls.

Combining extensions

Use app actions and blocks together to provide a more focused merchant experience.

An abstracted image of an app block triggering an app action.

An admin block can trigger an admin action. For more information, refer to the extension custom protocol.

An app block and app action with identical content.

Avoid duplicating the content of your admin blocks and admin actions. Differentiating the functionality and value of your blocks and actions helps merchants understand which extensions to use and when.

Previous
App Design Guidelines

Next
Layout