Skeleton display text

Skeleton display text is used to provide a low fidelity representation of content before it appears on the page, and improves load times perceived by merchants. Can be used for content in or outside of a card.

Use this component to represent medium and large display text such as large metrics on the reports list page, or for page titles.

import {SkeletonDisplayText} from '@shopify/polaris';
import React from 'react';

function SkeletonExample() {
  return <SkeletonDisplayText size="medium" />;
}

Use this component to represent extra large display text.

import {SkeletonDisplayText} from '@shopify/polaris';
import React from 'react';

function SkeletonExample() {
  return <SkeletonDisplayText size="extraLarge" />;
}

Use this component to represent small display text such as content headings.

import {SkeletonDisplayText} from '@shopify/polaris';
import React from 'react';

function SkeletonExample() {
  return <SkeletonDisplayText size="small" />;
}

Props

Want to help make this feature better? Please share your feedback.

interface SkeletonDisplayTextProps
size?'small' | 'medium' | 'large' | 'extraLarge'

Size of the text.

Defaults to 'medium'.

Best practices

Skeleton display text component should:

  • Give merchants an indication of what the page content will be once loaded
  • Use real content for display text that never changes

Content guidelines

Skeleton display text

Show static display text that that never changes on a page. For example, keep page titles, such as Products on the product list page, but use skeleton loading for page titles that change on the product details page.

Do

Show actual display text for static content and use skeleton display text for dynamic content. Image showing skeleton display text for dynamic content

Don’t

Use skeleton display text for static content or placeholder content for dynamic content. Image showing skeleton display text for static content and placeholder text for dynamic content

Do

Show skeleton display text for dynamic page titles.

Image showing skeleton display text for dynamic page title