You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: polaris-react/src/components/ActionList/README.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -80,7 +80,7 @@ Each item in an action list should be scannable avoiding unnecessary words and a
80
80
81
81
## Examples
82
82
83
-
### Action list in a popover
83
+
### In a popover
84
84
85
85
Use for the least important actions so merchants aren’t distracted by secondary tasks. Can also be used for a set of actions that won’t fit in the available screen space.
86
86
@@ -133,7 +133,7 @@ function ActionListInPopoverExample() {
133
133
}
134
134
```
135
135
136
-
### Action list with icons or image
136
+
### With icons or image
137
137
138
138
Use when the items benefit from an associated action or image, such as a list of products.
139
139
@@ -170,7 +170,7 @@ function ActionListWithMediaExample() {
170
170
}
171
171
```
172
172
173
-
### Action list with an icon and a suffix
173
+
### With an icon and a suffix
174
174
175
175
Use when the items benefit from an associated action or image, such as a list of products.
176
176
@@ -212,7 +212,7 @@ function ActionListWithSuffixExample() {
212
212
}
213
213
```
214
214
215
-
### Sectioned action list
215
+
### With sections
216
216
217
217
Use when the items benefit from sections to help differentiate actions.
218
218
@@ -261,7 +261,7 @@ function SectionedActionListExample() {
261
261
}
262
262
```
263
263
264
-
### Action list with destructive item
264
+
### With destructive item
265
265
266
266
Use to visually indicate that an action list item is destructive.
267
267
@@ -312,7 +312,7 @@ function ActionListWithDestructiveItemExample() {
312
312
}
313
313
```
314
314
315
-
### Action list with help text
315
+
### With help text
316
316
317
317
Use help text when the normal Verb noun syntax for the actions does not provide sufficient context for the merchant.
318
318
@@ -359,7 +359,7 @@ function ActionListWithHelpTextExample() {
359
359
}
360
360
```
361
361
362
-
### Action list with a prefix and a suffix
362
+
### With a prefix and a suffix
363
363
364
364
Use help text when the normal Verb noun syntax for the actions does not provide sufficient context for the merchant.
Copy file name to clipboardExpand all lines: polaris-react/src/components/AppProvider/README.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -200,7 +200,7 @@ function AppProviderLinkExample() {
200
200
201
201
### With color scheme
202
202
203
-
With a `colorScheme`, the app provider component will set the root color scheme for the App (such as: light or dark).For `colorScheme` configuration, see the [CustomProperties](https://polaris.shopify.com/components/custom-properties) component documentation.
203
+
With a `colorScheme`, the app provider component will set the root color scheme for the App (such as light or dark).For `colorScheme` configuration, see the [CustomProperties](https://polaris.shopify.com/components/custom-properties) component documentation.
Copy file name to clipboardExpand all lines: polaris-react/src/components/Badge/README.md
+13-17Lines changed: 13 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -73,67 +73,63 @@ Don’t use alternatives to existing badge options. Only create a new badge opti
73
73
74
74
## Examples
75
75
76
-
### Default badge
76
+
### Default
77
77
78
78
Use to give a non-critical status update on a piece of information or action.
79
79
80
80
```jsx
81
81
<Badge>Fulfilled</Badge>
82
82
```
83
83
84
-
### Small badge
84
+
### Small
85
85
86
86
Use in layouts with minimal space, like inside of an `IndexTable` cell.
87
87
88
88
```jsx
89
89
<Badge size="small">Fulfilled</Badge>
90
90
```
91
91
92
-
### Informational badge
92
+
### Informational
93
93
94
94
Use to call out an object or action as having an important attribute. For example, marking an option as “Recommended” or marking a theme as “Published”.
95
95
96
96
```jsx
97
97
<Badge status="info">Published</Badge>
98
98
```
99
99
100
-
### Success badge
100
+
### Success
101
101
102
102
Use to indicate a successful, completed, or desirable state when it’s important to provide positive reinforcement to merchants. For example, when merchants successfully dispute a chargeback, a success badge shows that says “Funds recovered”.
103
103
104
104
```jsx
105
105
<Badge status="success">Funds recovered</Badge>
106
106
```
107
107
108
-
### Attention badge
108
+
### Attention
109
109
110
110
Use when something requires merchants’ attention but the issue isn’t critical. For example, this badge would show next to an order that needs to be reviewed by merchants.
111
111
112
112
```jsx
113
113
<Badge status="attention">Inactive</Badge>
114
114
```
115
115
116
-
### Warning badge
116
+
### Warning
117
117
118
-
Use for critical and time-sensitive issues that require merchants’ attention and potential action. Warning events are often reversible.
119
-
120
-
Keep in mind that seeing this badge can feel stressful for merchants so it should only be used when absolutely necessary.
118
+
Use for warnings and time-sensitive issues that require merchants’ attention and potential action. Warning events are often reversible. Keep in mind that seeing this badge can feel stressful for merchants so it should only be used when absolutely necessary.
121
119
122
120
```jsx
123
121
<Badge status="warning">Expired</Badge>
124
122
```
125
123
126
-
### Critical badge
127
-
128
-
Use for critical and irreversible issues that require merchants’ attention and potential action.
124
+
### Critical
129
125
130
-
Keep in mind that seeing this badge can feel stressful for merchants so it should only be used when absolutely necessary.
126
+
Use for critical and irreversible issues that require merchants’ attention and potential action. Keep in mind that seeing this badge can feel stressful for merchants so it should only be used when absolutely necessary.
131
127
132
128
```jsx
133
129
<Badge status="critical">Action required</Badge>
134
130
```
135
131
136
-
### Incomplete badge
132
+
### Incomplete
137
133
138
134
Use to indicate when a given task has not yet been completed. For example, when merchants haven’t fulfilled an order.
139
135
@@ -143,7 +139,7 @@ Use to indicate when a given task has not yet been completed. For example, when
143
139
</Badge>
144
140
```
145
141
146
-
### Partially complete badge
142
+
### Partially complete
147
143
148
144
Use to indicate when a given task has been partially completed. For example, when merchants have partially fulfilled an order.
149
145
@@ -153,15 +149,15 @@ Use to indicate when a given task has been partially completed. For example, whe
153
149
</Badge>
154
150
```
155
151
156
-
### Complete badge
152
+
### Complete
157
153
158
154
Use to indicate when a given task has been completed. For example, when merchants have fulfilled an order.
159
155
160
156
```jsx
161
157
<Badge progress="complete">Fulfilled</Badge>
162
158
```
163
159
164
-
### Badge with statusAndProgressLabelOverride
160
+
### With statusAndProgressLabelOverride
165
161
166
162
Use when the status and progress accessibilityLabels are not appropriate to a given context.
0 commit comments