UNPKG

@shopify/polaris

Version:

Shopify’s product component library

github.com/Shopify/polaris

Shopify/polaris

96 lines (65 loc) • 2.35 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
--- name: Heading category: Titles and text keywords: - titles - text - microcopy - conversational - typographic - card headings - card titles - section titles - section headings - heading text - heading font --- # Heading Headings are used as the titles of each major section of a page in the interface. For example, [card components](/components/card) generally use headings as their title. --- ## Purpose Put the merchant first by identifying the problem they face and the component that helps them solve it. ### Problem There are lots of different sections in the Shopify product and sometimes it can be hard for merchants to orient themselves. ### Solution Headings clearly remind merchants where they are in the product and help frame the interface. --- ## Best practices Headings should: - Clearly describe the section of interface they refer to - Highlight the most important concept or piece of information a merchant needs to know - Sit at the top of the section of interface they’re referring to --- ## Content guidelines ### Heading Headings should be: - Informative and descriptive: - They should label the type of content grouped in the interface below - Concise and scannable: - Use simple, clear language that can be read at a glance - Keep headings to single sentence and avoid using punctuation such as periods, commas, or semicolons - Avoid articles (the, a, an) in [microcopy headings](/content/grammar-and-mechanics#headings-and-subheadings) to keep content short and actionable - Write in sentence case (first word capitalized, the rest is lowercase) Microcopy headings should be easy for merchants to scan and understand instantly. <!-- usagelist --> #### Do - Custom reports #### Don’t - These are your custom reports <!-- end --> Conversational headings for areas like empty states and home cards are the only cases where you should use articles. <!-- usagelist --> #### Do - Secure your account with two-step authentication #### Don’t - Two-step authentication <!-- end --> ## Examples ### Typographic heading Use for the title of each top-level page section. ```jsx <Heading>Online store dashboard</Heading> ``` --- ## Related components * To break up a section with a heading into sub-sections, [use the subheading component](/components/subheading)