Page

Passing an API key to the app provider component causes the page component to delegate to the Shopify App Bridge instead of rendering as it would in a stand-alone application.

Note in the props table that a number of properties are only available in stand-alone applications, and won’t work in an embedded context. Configure your application’s icon and navigation in the Shopify Partner Dashboard app setup section. To help visualize the page component in an embedded application, we’ve provided the following screenshot.

ReactDOM.render(
  <AppProvider apiKey="YOUR_API_KEY" i18n={{}}>
    <Page
      breadcrumbs={[{content: 'Products'}]}
      title="Product reviews"
      primaryAction={{
        content: 'Save',
        disabled: true,
      }}
      secondaryActions={[{content: 'Duplicate'}, {content: 'Upgrade'}]}
      actionGroups={[
        {
          title: 'Promote',
          actions: [
            {
              content: 'Share on Facebook',
              onAction: this.performFacebookShare,
            },
            {
              content: 'Share on Pinterest',
              onAction: this.performPinterestShare,
            },
          ],
        },
      ]}
    >
      <p>Page content</p>
    </Page>
  </AppProvider>,
);

Deprecation rationale

As of v3.17.0, using Page to render an embedded app title bar is deprecated. Support for this will be removed in v5.0 as the underlying Shopify App Bridge library will be removed from Polaris React. Learn more about the deprecation rationale. Use TitleBar from @shopify/app-bridge-react combined with Page instead.

The page component should:

• Always provide a title for the page header.
• Always provide breadcrumbs when a page has a parent page.
• Be organized around a primary activity. If that primary activity is a single action, provide it as a primary button in the page header.
• Provide other page-level actions as secondary actions in the page header.
• When the page represents an object of a certain type, provide pagination links to the previous and next object of the same type.

Title

Titles should:

• Describe the page in as few words as possible.
• Be the name of the object type (pluralized) when the page is a list of objects. For a list of orders, the page title should be “Orders”.
• Not be truncated.

App icon

App icons should:

• Provide their app icon
• Only be provided for pages that are part of a Shopify app

Breadcrumbs

The content of each breadcrumb link should be the title of the page to which it links.

Page header actions

Page header action labels should be:

• Clear and predictable: merchants should be able to anticipate what will happen when they click a page action. Never deceive merchants by mislabeling an action.

• Action-led: they should always lead with a strong verb that encourages action. To provide enough context to merchants, use the {verb}+{noun} format.

• Short: for secondary actions, when the noun represents the same object as the page itself, a verb alone may be used. If there is ambiguity (such as with the verb “Cancel”), always use the {verb}+{noun} format.

  In the context of the orders list page:

• Scannable: avoid unnecessary words and articles such as the, an, or a.

• To lay out the content within a page, use the layout component
• To add pagination within the context of a list or other page content, use the pagination component
• To add primary and secondary calls to action at the bottom of a page, see the page actions component
• When you use the page component within an embedded app, the app provider component delegates rendering to the Shopify App Bridge