Media card

Media cards provide a consistent layout to present visual information to merchants. Visual media is used to provide additional context to the written information it's paired with.

Examples

Use to surface educational information about a feature or opportunity.

Drag to resize example

Props

childrenRequired
React.ReactNode
The visual media to display in the card
descriptionRequired
string
Body content
popoverActions
ActionListItemDescriptor[]
Action list items to render in ellipsis popover
portrait
boolean
Whether or not card content should be laid out vertically
primaryAction
ComplexAction
Main call to action, rendered as a basic button
secondaryAction
ComplexAction
Secondary call to action, rendered as a plain button
size
"small" | "medium"
Size of the visual media in the card
titleRequired
React.ReactNode
Heading content

Accessibility

The required title prop gives the media card a level 2 heading (<h2>). This helps with readability and provides structure to screen reader users. It can also accept a ReactNode.

Use actionable language to ensure that the purpose of the media card is clear to all merchants, including those with issues related to reading and language.

Best practices

Media cards should:

  • Provide merchants with a clear call to action.
  • Always pair text with a visual component, for example, body text paired with an image, video, etc.
  • Use media to enhance the written content. The written content should be able to stand alone without an explanation from the paired media.
  • Show targeted content toward specific audiences to maximize relevance.
  • Be dismissable.

Content guidelines

  • Don’t use media cards as advertisements for your feature. Instead they should educate the merchant about how to accomplish tasks related to the section they’re in.

Title

Media card titles should follow the content guidelines for headings and subheadings.

Body content

Body content should be:

  • Actionable: start sentences with imperative verbs when telling merchants what actions are available to them, especially something new. Don’t use permissive language like “you can”.
  • Get performance data for all of your sales channels.

  • Now you can get performance data for all of your sales channels.

  • Structured for merchant success: always put the most critical information first
  • Clear: use the verb “need” to help merchants understand when they’re required to do something
  • To buy a shipping label, you need to enter the total weight of your shipment, including packaging.

  • To buy a shipping label, you must enter the total weight of your shipment, including packaging.

Call to action

Buttons should be:

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

  • Buy shipping label

  • Buy

  • Action-led: buttons should always lead with a strong verb that encourages action. To provide enough context to merchants use the {verb}+{noun} format on buttons except in the case of common actions like Save, Close, Cancel, or OK.
  • View shipping settings

  • View your settings

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

  • Add a menu item