Skip to content

Commit 0bf91c5

Browse files
docs(progressbar,meter): pr fixes and edits
- removes some duplicative docs language for pgoress bar - adds correct punctuation to CHANGELOG - passes default value for customWidth in args for progress bar - uses passive voice in meter documentation - removes repetitive StaticWhiteDocs story in favor of previous StaticWhite story - removes Chromatic snapshot for WithoutLabel progress bar story
1 parent d2c950c commit 0bf91c5

File tree

3 files changed

+11
-25
lines changed

3 files changed

+11
-25
lines changed

components/progressbar/CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -294,7 +294,7 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline
294294

295295
### spectrum-Meter class
296296

297-
Meter now uses the class `spectrum-Meter` on the parent `div`
297+
Meter now uses the class `spectrum-Meter` on the parent `div`.
298298

299299
### 🔙 Reverts
300300

components/progressbar/stories/meter.stories.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ Sizing.parameters = {
7171
};
7272

7373
/**
74-
* Meter variants can be used to represent semantic values by switching variants as the value changes, from positive, to notice, and then to negative. This kind of variant switching should be handled appropriately within the context of your product so that you’re setting accurate expectations for your users about the semantic meaning.
74+
* Meter variants can be used to represent semantic values by switching variants as the value changes, from positive, to notice, and then to negative. This kind of variant switching should be handled appropriately within the context of your product so that accurate expectations are set for users about the semantic meaning.
7575
*
7676
* By default, the meter has a informative, blue fill to show the value. This can be used to represent a neutral or non-semantic value. The positive variant has a green fill, representing a positive semantic value. The notice variant has an orange fill, and can be used to warn users about a situation that may need to be addressed soon. The negative variant has a red fill, and can be used to warn users about a critical situation that needs their urgent attention.
7777
*/

components/progressbar/stories/progressbar.stories.js

Lines changed: 9 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,7 @@ export default {
8686
label: "Loading",
8787
labelPosition: "top",
8888
value: 0,
89+
customWidth: 192,
8990
isIndeterminate: false,
9091
showValueLabel: true,
9192
},
@@ -143,7 +144,7 @@ CustomWidth.parameters = {
143144
};
144145

145146
/**
146-
* The example below shows a progress bar without its label. Progress bars typically have a label, but in rare cases where context is sufficient and an accessibility expert has reviewed the design, the label could be undefined.
147+
* The example below shows a progress bar without its label.
147148
*/
148149
export const WithoutLabel = Template.bind({});
149150
WithoutLabel.storyName = "Without label";
@@ -158,7 +159,7 @@ WithoutLabel.parameters = {
158159
};
159160

160161
/**
161-
* The example below shows a progress bar without its value label. This value label works in conjunction with the label, and should not be displayed if the label itself is not displayed.
162+
* The example below shows a progress bar without its value label.
162163
*/
163164
export const WithoutValue = Template.bind({});
164165
WithoutValue.storyName = "Without value";
@@ -168,20 +169,18 @@ WithoutValue.args = {
168169
};
169170
WithoutValue.tags = ["!dev"];
170171
WithoutValue.parameters = {
171-
chromatic: {
172-
modes: disableDefaultModes
173-
},
172+
chromatic: { disableSnapshot: true },
174173
};
175174

176-
export const StaticWhiteDocs = Template.bind({});
177-
StaticWhiteDocs.storyName = "Static white";
178-
StaticWhiteDocs.args = {
175+
export const StaticWhite = ProgressBarGroup.bind({});
176+
StaticWhite.storyName = "Static white";
177+
StaticWhite.tags = ["!dev"];
178+
StaticWhite.args = {
179179
staticColor: "white",
180180
label: "Loading your fonts, images, and icons",
181181
value: 50,
182182
};
183-
StaticWhiteDocs.tags = ["!dev"];
184-
StaticWhiteDocs.parameters = {
183+
StaticWhite.parameters = {
185184
chromatic: {
186185
modes: disableDefaultModes
187186
},
@@ -197,16 +196,3 @@ WithForcedColors.parameters = {
197196
modes: disableDefaultModes
198197
},
199198
};
200-
201-
export const StaticWhite = ProgressBarGroup.bind({});
202-
StaticWhite.tags = ["!autodocs", "!dev"];
203-
StaticWhite.args = {
204-
staticColor: "white",
205-
label: "Loading your fonts, images, and icons",
206-
value: 50,
207-
};
208-
StaticWhite.parameters = {
209-
chromatic: {
210-
modes: disableDefaultModes
211-
},
212-
};

0 commit comments

Comments
 (0)