Skip to main content

Navigation

Navigation enables merchants to move between sections of your app.

Anchor to Why is navigation important?Why is navigation important?

Navigation is how merchants move from task to task. A good navigation structure enables merchants to complete tasks easily and without friction. Build your app's navigation around what merchants need to do.

Navigation elements display in the following areas:

  1. App nav

    Moves merchants between your app's pages.

  2. App header

    Holds the app icon, name, page title, and actions.

  3. Page title

    Names the current page and describes its purpose.

Anchor to Information architectureInformation architecture

Information architecture (IA) is the practice of organizing sections so that they make sense as a whole.

Anchor to Why is IA important?Why is IA important?

IA shows merchants where they currently are, and how to navigate the rest of the app. It should be obvious what previously happened and what will happen next.

Rely on the relationship between the app nav and app body components to guide merchants where they need to go.

Use the fewest possible categories to define what your app does.

Anchor to App HomeApp Home

The app URL specified in the Dev Dashboard should point to your app homepage. This page is the default view when your app's name is selected in the Shopify admin.

If you're building an app that's made entirely of extensions, then a default App Home URL and homepage is provided.

Anchor to App navApp nav

The app nav gives merchants a way to move between pages of your app.

The app nav is located in the sidebar in the Shopify admin and in the header in Shopify mobile.

Anchor to App nameApp name

The app name represents a way for merchants to identify your app across multiple touchpoints in the Shopify admin.

The app name can be shorter than the Shopify App Store listing, so that it fits into the app nav.

Info

To change your app name, in the Dev Dashboard navigate to Versions and click Create a version.

Anchor to Navigation iconNavigation icon

Submit a navigation icon that displays in the app nav. The navigation icon is gray when it's inactive and green when it's active.

To learn more about designing your navigation icon, refer to the visual design guidelines.

Info

To change your navigation icon, navigate to App setup > Embedded app in the Partner Dashboard.

Anchor to App headerApp header

The app header contains main structural pieces for your app. It's the header that merchants will interact with throughout the entire app experience.

Refer to the Polaris page web component documentation for more information.

The app header contains the following elements:

  1. App icon and name

    Identify your app across the Shopify admin.

  2. Page title

    Names the current page and describes its purpose.

  3. Actions

    Primary and secondary buttons for page-specific tasks.

  4. Overflow menu

    Holds support information, such as About this app and Support.

Anchor to Overflow menuOverflow menu

The overflow menu is reserved for additional support information about your app.

The overflow menu includes the following content:

  • About this app
  • Support

At this time, the overflow menu isn't customizable.

Info

On mobile, the option to pin the app is collapsed into the overflow menu.

Anchor to Page titlePage title

The page title should be short and describe the general purpose of the page.

Try to limit each page to a single purpose. Merchants prefer focusing their attention on specific tasks, and splitting their attention might damage the user experience.

Anchor to Primary and secondary actionsPrimary and secondary actions

The primary and secondary buttons in the Polaris page web component initiate a page-specific action.

Primary and secondary button labels should have the following attributes:

  • Clarity and predictability: Merchants should be able to anticipate what will happen when they click a page action.
  • Action-led: Button labels should always lead with a strong verb that encourages action. To provide enough context for merchants, use a \{verb\}+\{noun\} format.
Was this page helpful?