Skip to content

Commit 5179877

Browse files
authored
[polaris.shopify.com] Clean up example titles (#6678)
1 parent 82ca9b4 commit 5179877

File tree

246 files changed

+1814
-1764
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

246 files changed

+1814
-1764
lines changed

.changeset/warm-clouds-drive.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
'@shopify/polaris': patch
3+
'polaris.shopify.com': patch
4+
---
5+
6+
Migrate content to polaris.shopify.com, automate example titles

polaris-react/src/components/AccountConnection/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ Connect to app
9696

9797
## Examples
9898

99-
### Default account connection
99+
### Default
100100

101101
Use to let merchants connect or disconnect their store to their third-party accounts, like Facebook.
102102

polaris-react/src/components/ActionList/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ Each item in an action list should be scannable avoiding unnecessary words and a
8080

8181
## Examples
8282

83-
### Action list in a popover
83+
### In a popover
8484

8585
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.
8686

@@ -133,7 +133,7 @@ function ActionListInPopoverExample() {
133133
}
134134
```
135135

136-
### Action list with icons or image
136+
### With icons or image
137137

138138
Use when the items benefit from an associated action or image, such as a list of products.
139139

@@ -170,7 +170,7 @@ function ActionListWithMediaExample() {
170170
}
171171
```
172172

173-
### Action list with an icon and a suffix
173+
### With an icon and a suffix
174174

175175
Use when the items benefit from an associated action or image, such as a list of products.
176176

@@ -212,7 +212,7 @@ function ActionListWithSuffixExample() {
212212
}
213213
```
214214

215-
### Sectioned action list
215+
### With sections
216216

217217
Use when the items benefit from sections to help differentiate actions.
218218

@@ -261,7 +261,7 @@ function SectionedActionListExample() {
261261
}
262262
```
263263

264-
### Action list with destructive item
264+
### With destructive item
265265

266266
Use to visually indicate that an action list item is destructive.
267267

@@ -312,7 +312,7 @@ function ActionListWithDestructiveItemExample() {
312312
}
313313
```
314314

315-
### Action list with help text
315+
### With help text
316316

317317
Use help text when the normal Verb noun syntax for the actions does not provide sufficient context for the merchant.
318318

@@ -359,7 +359,7 @@ function ActionListWithHelpTextExample() {
359359
}
360360
```
361361

362-
### Action list with a prefix and a suffix
362+
### With a prefix and a suffix
363363

364364
Use help text when the normal Verb noun syntax for the actions does not provide sufficient context for the merchant.
365365

polaris-react/src/components/AppProvider/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -200,7 +200,7 @@ function AppProviderLinkExample() {
200200

201201
### With color scheme
202202

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.
204204

205205
```jsx
206206
function AppProviderThemeExample() {

polaris-react/src/components/Autocomplete/README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ The input field for autocomplete should follow the [content guidelines](https://
3434

3535
## Examples
3636

37-
### Basic autocomplete
37+
### Default
3838

3939
Use to help merchants complete text input quickly from a list of options.
4040

@@ -107,7 +107,7 @@ function AutocompleteExample() {
107107
}
108108
```
109109

110-
### Multiple tags autocomplete
110+
### With multiple tags
111111

112112
Use to help merchants select multiple options from a list curated by the text input.
113113

@@ -210,7 +210,7 @@ function MultiAutocompleteExample() {
210210
}
211211
```
212212

213-
### Multiple sections autocomplete
213+
### With multiple sections
214214

215215
Use to help merchants complete text input quickly from a multiple sections list of options.
216216

@@ -314,7 +314,7 @@ function AutocompleteExample() {
314314
}
315315
```
316316

317-
### Autocomplete with loading
317+
### With loading
318318

319319
Use to indicate loading state to merchants while option data is processing.
320320

@@ -395,7 +395,7 @@ function AutocompleteExample() {
395395
}
396396
```
397397

398-
### Autocomplete with lazy loading
398+
### With lazy loading
399399

400400
```jsx
401401
function AutoCompleteLazyLoadExample() {
@@ -524,7 +524,7 @@ function AutoCompleteLazyLoadExample() {
524524
}
525525
```
526526

527-
### Autocomplete with empty state
527+
### With empty state
528528

529529
Use to indicate there are no search results.
530530

@@ -615,7 +615,7 @@ function AutocompleteExample() {
615615
}
616616
```
617617

618-
### Autocomplete with action
618+
### With action
619619

620620
Use to help merchants complete an action quickly.
621621

@@ -708,7 +708,7 @@ function AutocompleteActionBeforeExample() {
708708
}
709709
```
710710

711-
### Autocomplete with wrapping action
711+
### With wrapping action
712712

713713
Use to help merchants complete an action quickly with wrapping lines of text.
714714

@@ -803,7 +803,7 @@ function AutocompleteActionBeforeExample() {
803803
}
804804
```
805805

806-
### Autocomplete with destructive action
806+
### With destructive action
807807

808808
Use to help merchants complete a destructive action quickly.
809809

polaris-react/src/components/Avatar/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,15 +50,15 @@ For avatars, we recommend using a format that describes what will show in the im
5050

5151
## Examples
5252

53-
### Default avatar
53+
### Default
5454

5555
Use to present an avatar for a merchant, customer, or business.
5656

5757
```jsx
5858
<Avatar customer name="Farrah" />
5959
```
6060

61-
### Extra small avatar
61+
### Extra small
6262

6363
Use to present an avatar in a condensed layout, such as a data table cell or an action list item.
6464

@@ -95,7 +95,7 @@ function ExtraSmallAvatarExample() {
9595
}
9696
```
9797

98-
### Square avatar
98+
### Square
9999

100100
Use a `square` shape when the avatar represents a non-person entity like an app, channel, or store.
101101

polaris-react/src/components/Badge/README.md

Lines changed: 13 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -73,67 +73,63 @@ Don’t use alternatives to existing badge options. Only create a new badge opti
7373

7474
## Examples
7575

76-
### Default badge
76+
### Default
7777

7878
Use to give a non-critical status update on a piece of information or action.
7979

8080
```jsx
8181
<Badge>Fulfilled</Badge>
8282
```
8383

84-
### Small badge
84+
### Small
8585

8686
Use in layouts with minimal space, like inside of an `IndexTable` cell.
8787

8888
```jsx
8989
<Badge size="small">Fulfilled</Badge>
9090
```
9191

92-
### Informational badge
92+
### Informational
9393

9494
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”.
9595

9696
```jsx
9797
<Badge status="info">Published</Badge>
9898
```
9999

100-
### Success badge
100+
### Success
101101

102102
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”.
103103

104104
```jsx
105105
<Badge status="success">Funds recovered</Badge>
106106
```
107107

108-
### Attention badge
108+
### Attention
109109

110110
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.
111111

112112
```jsx
113113
<Badge status="attention">Inactive</Badge>
114114
```
115115

116-
### Warning badge
116+
### Warning
117117

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.
121119

122120
```jsx
123121
<Badge status="warning">Expired</Badge>
124122
```
125123

126-
### Critical badge
127-
128-
Use for critical and irreversible issues that require merchants’ attention and potential action.
124+
### Critical
129125

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.
131127

132128
```jsx
133129
<Badge status="critical">Action required</Badge>
134130
```
135131

136-
### Incomplete badge
132+
### Incomplete
137133

138134
Use to indicate when a given task has not yet been completed. For example, when merchants haven’t fulfilled an order.
139135

@@ -143,7 +139,7 @@ Use to indicate when a given task has not yet been completed. For example, when
143139
</Badge>
144140
```
145141

146-
### Partially complete badge
142+
### Partially complete
147143

148144
Use to indicate when a given task has been partially completed. For example, when merchants have partially fulfilled an order.
149145

@@ -153,15 +149,15 @@ Use to indicate when a given task has been partially completed. For example, whe
153149
</Badge>
154150
```
155151

156-
### Complete badge
152+
### Complete
157153

158154
Use to indicate when a given task has been completed. For example, when merchants have fulfilled an order.
159155

160156
```jsx
161157
<Badge progress="complete">Fulfilled</Badge>
162158
```
163159

164-
### Badge with statusAndProgressLabelOverride
160+
### With statusAndProgressLabelOverride
165161

166162
Use when the status and progress accessibilityLabels are not appropriate to a given context.
167163

0 commit comments

Comments
 (0)