@hackplan/polaris
Version:
Shopify’s product component library
74 lines (46 loc) • 2.53 kB
Markdown
name: Skeleton body text
category: Feedback indicators
releasedIn: 1.7.0
keywords:
- SkeletonBodyText
- skeleton
- loading
- page
# Skeleton body text
Skeleton body 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.
## Best practices
Skeleton body text component should:
- Be used with [Skeleton page](/components/feedback-indicators/skeleton-page) when page content loads all at once. Together, these components give merchants an indication of what the page layout will be once loaded.
- Be used on its own, inside any content container component (like a [card](/components/structure/card)), and when content loads after the main page load.
- Try to match the number of lines to the content being loaded so it gives an accurate representation.
## Content guidelines
### Skeleton body text
Show static content that never changes on a page and use skeleton loading for dynamic content. Skeleton body text can sometimes be used to represent non-typographic content such as forms. Don’t use placeholder content that will change when the page fully loads.
<!-- usageblock -->
#### Do
Use skeleton body text for dynamic content.

#### Don’t
Use skeleton body text for static content or use placeholder content for dynamic content.

<!-- end -->
## Examples
### Default paragraph
Use this component to represent a block of content being loaded. For example, you could use it to represent an entire product description card on the product page.
```jsx
<SkeletonBodyText />
```
### Single line content
Use this component to represent a short, single line of text, like a timestamp.
```jsx
<SkeletonBodyText lines={1} />
```
## Related components
- Use this component with [Skeleton page](/components/feedback-indicators/skeleton-page) and [Skeleton display text](/components/feedback-indicators/skeleton-display-text) to represent the content of a page while it’s loading.
- When giving feedback for in-context operations, use [Progress bar](/components/feedback-indicators/progress-bar) or [Spinner](/components/feedback-indicators/spinner) component.