UNPKG

@shopify/polaris

Version:

Shopify’s product component library

79 lines (55 loc) 1.91 kB
--- name: Caption category: Titles and text keywords: - labels - text - microcopy - typographic - graph - timestamp - smaller text - smallest text - smaller than reading size text - time text - compact text - small text --- # Caption Caption text size is smaller than the recommended size for general reading. It should be used only in a graph or as a timestamp in a list. --- ## Purpose Put the merchant first by identifying the problem they face and the component that helps them solve it. ### Problem Merchants need to understand a complex graphic or arrangement of content in a small area. ### Solution Use smaller text for short labels on graphs or lists where space is limited. --- ## Best practices - Use for secondary labels in graphs and charts - May be used for timestamps in lists of content - Don’t use this component for other cases - Don’t use this component for text longer than a few words - Don’t use this component for aesthetic effect or to break from the standard text size --- ## Content guidelines ### Captions Captions are primarily used in [data visualizations](/visuals/data-visualizations). Stick to a few words and don’t use this component for complete sentences or longer content. <!-- usagelist --> #### Do * Use caption for labelling data visualizations ![Diagram of using captions to label graphs and other data content](typography/display-styles/do-use-caption-for-labeling-data-visualizations.png) * Received April 21, 2017 #### Don’t * Order #1001 was received on April 21, 2017 * This is your recent activity <!-- end --> ## Examples ### Default caption Use to provide details in situations where content is compact and space is tight. ```jsx <List> <List.Item>Order #1001 <Caption>Received April 21, 2017</Caption></List.Item> <List.Item>Order #1002 <Caption>Received April 22, 2017</Caption></List.Item> </List> ```