Skeleton page

Skeleton page is used with other skeleton loading components to provide a low fidelity representation of the user interface (UI) before content appears on the page. It improves load times perceived by merchants.

Examples

Use this component to compose a loading version of a page where the page title and header content are dynamic, meaning, the content changes.

Drag to resize example

Props

breadcrumbs
boolean
Shows a skeleton over the breadcrumb
children
React.ReactNode
The child elements to render in the skeleton page.
fullWidth
boolean
Remove the normal max-width on the page
narrowWidth
boolean
Decreases the maximum layout width. Intended for single-column layouts
primaryAction
boolean
Shows a skeleton over the primary action
secondaryActions
number
Number of secondary page-level actions to display
title
string
Page title, in large type

Best practices

Skeleton page component should:

  • Be used for pages where all content loads at the same time.
  • Give merchants an indication of what the page layout will be once loaded. Do this by mimicking its layout similarly to the state that will be loaded.

Content guidelines

Show page titles that never change for a page. For example, keep the title “Products” on the product list page, but use skeleton loading for titles that change on the product details page. Don’t use placeholder content for titles that will change when the page fully loads.

Secondary actions are always represented with skeleton content. You can change the number of skeleton actions that best represent the number of actions once loaded.

Do

Use skeleton loading for dynamic content, and use actual content for content that doesn’t change.

Image showing skeleton loading for changing content

Don’t

Use placeholder content that will change when the page fully loads. This will confuse merchants and create a jumpy loading experience.

Image showing placeholder content that will change

Edit source on GitHub