UNPKG

@hackplan/polaris

Version:

Shopify’s product component library

github.com/Shopify/polaris-react

Shopify/polaris-react

64 lines (42 loc) • 1.57 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
--- name: Keyboard key category: Images and icons keywords: - KeyboardKey - shortcuts - hotkey - hot key - keyboard shortcuts - keyboard letter - hotkey combinations --- # Keyboard key Keyboard key is used to educate merchants about keyboard shortcuts. --- ## Best practices The keyboard key component should: - Include a heading to introduce and explain the shortcuts being described when more than one shortcut is listed - Include an action label to describe what will happen if merchants use the key combination --- ## Content guidelines ### Heading Headings above the keyboard key should be: - Informative and descriptive - They should label the type of keyboard shortcuts being presented - 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) to keep content short and actionable - Be written in sentence case (first word capitalized, the rest is lowercase) ### Shortcut description The shortcut description should describe what action will be taken if merchants tap certain keys. When a hotkey combination takes merchants to a location in the interface, the format should be: --- ## Examples ### List of keyboard shortcuts Use to list a related set of keyboard shortcuts. ```jsx <KeyboardKey>Ctrl</KeyboardKey> ``` --- ## Related components - To add a tooltip for a button with an associated keyboard shortcut, [use the tooltip component](/components/tooltip)