Skip to content

Commit

Permalink
chore: pr feedback
Browse files Browse the repository at this point in the history
  • Loading branch information
nkrantz committed Oct 19, 2023
1 parent a0be8cd commit fa53842
Show file tree
Hide file tree
Showing 7 changed files with 24 additions and 26 deletions.
5 changes: 0 additions & 5 deletions .changeset/olive-forks-hang.md

This file was deleted.

3 changes: 3 additions & 0 deletions cypress/integration/sitemap-vrt/constants.ts
Original file line number Diff line number Diff line change
Expand Up @@ -153,6 +153,9 @@ export const SITEMAP = [
"/components/product-switcher/",
"/components/product-switcher/api",
"/components/product-switcher/changelog",
"/components/progress-bar/",
"/components/progress-bar/api",
"/components/progress-bar/changelog",
"/components/progress-steps/",
"/components/progress-steps/api",
"/components/progress-steps/changelog",
Expand Down
2 changes: 1 addition & 1 deletion packages/paste-core/components/progress-bar/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"version": "1.0.0",
"category": "feedback",
"status": "alpha",
"description": "A Progress Bar visually displays the progression/duration of a system operation such as downloading, uploading, or processing information.",
"description": "A Progress Bar communicates the completion status of a process or task.",
"author": "Twilio Inc.",
"license": "MIT",
"main:dev": "src/index.tsx",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ export const Default = (): React.ReactNode => {
<Box maxWidth="400px">
{value >= 100 ? (
<Box marginBottom="space90" display="flex" alignItems="center" columnGap="space30">
<AcceptIcon decorative size="sizeIcon70" color="colorTextSuccess" />
<AcceptIcon decorative size="sizeIcon30" color="colorTextSuccess" />
Your submission has been approved!
</Box>
) : (
Expand Down Expand Up @@ -88,10 +88,10 @@ export const Indeterminate = (): React.ReactNode => {

return (
<Box maxWidth="400px">
<ProgressBarLabel htmlFor={progressBarIdA}>Uploading sunrise_video.mov</ProgressBarLabel>
<ProgressBarLabel htmlFor={progressBarIdA}>Uploading sunrise_video.mov...</ProgressBarLabel>
<ProgressBar id={progressBarIdA} aria-describedby={helpTextId} isIndeterminate />
<Separator orientation="horizontal" verticalSpacing="space60" />
<ProgressBarLabel htmlFor={progressBarIdB}>Converting files</ProgressBarLabel>
<ProgressBarLabel htmlFor={progressBarIdB}>Converting files...</ProgressBarLabel>
<ProgressBar id={progressBarIdB} aria-describedby={helpTextId} isIndeterminate />
<HelpText id={helpTextId}>
Connection lost. Check your connection and refresh the page to get up-to-date information.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
export const meta = {
title: 'Progress Bar - API',
package: '@twilio-paste/progress-bar',
description: 'Progress Bar communicates the completion status of a process or task.',
description: 'A Progress Bar communicates the completion status of a process or task.',
slug: '/components/progress-bar/api',
};

Expand Down Expand Up @@ -57,9 +57,9 @@ const AlertDialogExample = () => {

return (
<Box>
<ProgressBarLabel htmlFor={progressBarId}>Downloading more ram</ProgressBarLabel>
<ProgressBarLabel htmlFor={progressBarId}>Downloading more RAM</ProgressBarLabel>
<ProgressBar id={progressBarId} aria-describedby={helpTextId} isIndeterminate />
<HelpText id={helpTextId}>Increasing your ram helps your computer run faster.</HelpText>
<HelpText id={helpTextId}>Increasing your RAM helps your computer run faster.</HelpText>
</Box>
);
};
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
export const meta = {
title: 'Progress Bar - Changelog',
package: '@twilio-paste/progress-bar',
description: 'Progress Bar communicates the completion status of a process or task.',
description: 'A Progress Bar communicates the completion status of a process or task.',
slug: '/components/progress-bar/changelog',
};

Expand Down
26 changes: 13 additions & 13 deletions packages/paste-website/src/pages/components/progress-bar/index.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
export const meta = {
title: 'Progress Bar',
package: '@twilio-paste/progress-bar',
description: 'Progress Bar communicates the completion status of a process or task.',
description: 'A Progress Bar communicates the completion status of a process or task.',
slug: '/components/progress-bar/',
};

Expand Down Expand Up @@ -45,7 +45,7 @@ export const getStaticProps = async () => {
<Box maxWidth="400px">
{value >= 100 ? (
<Box marginBottom="space90" display="flex" alignItems="center" columnGap="space30">
<AcceptIcon decorative size="sizeIcon70" color="colorTextSuccess" />
<AcceptIcon decorative size="sizeIcon30" color="colorTextSuccess" />
Your submission has been approved!
</Box>
) : (
Expand Down Expand Up @@ -87,10 +87,10 @@ or where the system is in a process.
### Progress Bar vs. Meter

A Progress Bar represents only completion progress, like a file upload
or filling out a form. If you're not displaying progress, use a Meter.
or filling out a form. If you're not displaying progress, use a [Meter](/components/meter).

One way to check if you need a Progress Bar or a Meter is to ask
yourself: _Could you substitute your UI element for Progress Steps?
yourself: _Could you substitute your UI element for [Progress Steps](/components/progress-steps)?
Would it communicate roughly the same intent?_ If yes, then Progress
Bar is probably the right element to use.

Expand All @@ -102,7 +102,7 @@ that don't need the extra layer of information that Progress Steps
provides. Example: A sign-up flow that a customer can reasonably
complete without leaving the flow.

In contrast, Progress Steps are a visual representation of a complex
In contrast, [Progress Steps](/components/progress-steps) are a visual representation of a complex
task broken up into multiple steps. They indicate what has and what
needs to be done to fully complete the task. Use Progress Steps when
the task is nonlinear or can't be completed in one sitting. Example:
Expand All @@ -128,11 +128,11 @@ the full task.
Use a Progress Bar to communicate the completion status of a process or task.
Use the `valueLabel` prop to show a visible value.

If you don't show a visible value through `valueLabel`, communicate what
kind of process is happening through `ProgressBarLabel`. If the label
starts with a verb, use an ellipsis at the end of the label. For example,
the Progress Bar Label should say “Uploading filename.png…” not just
“filename.png”.
If you don't show a visible value, communicate what kind of process is
happening through `ProgressBarLabel`. For example, the Progress Bar Label should say
“Uploading filename.png…” not just “filename.png” if you don't show the completion percentage.
If the label starts with a verb and the Progress Bar is not disabled, use an ellipsis at the
end of the label.


<StoryPreview
Expand All @@ -143,7 +143,7 @@ the Progress Bar Label should say “Uploading filename.png…” not just
<Box maxWidth="400px">
{value >= 100 ? (
<Box marginBottom="space90" display="flex" alignItems="center" columnGap="space30">
<AcceptIcon decorative size="sizeIcon70" color="colorTextSuccess" />
<AcceptIcon decorative size="sizeIcon30" color="colorTextSuccess" />
Your submission has been approved!
</Box>
) : (
Expand Down Expand Up @@ -220,12 +220,12 @@ Progress Bar Label should say “Uploading filename.png…” not just
height="260px"
title="Indeterminate progress state"
storyID="components-progressbar--indeterminate"
code={`<ProgressBarLabel htmlFor={progressBarIdA}>Uploading sunrise_video.mov</ProgressBarLabel>
code={`<ProgressBarLabel htmlFor={progressBarIdA}>Uploading sunrise_video.mov...</ProgressBarLabel>
<ProgressBar id={progressBarIdA} aria-describedby={helpTextId} isIndeterminate />
<Separator orientation="horizontal" verticalSpacing="space60" />
<ProgressBarLabel htmlFor={progressBarIdB}>Converting files</ProgressBarLabel>
<ProgressBarLabel htmlFor={progressBarIdB}>Converting files...</ProgressBarLabel>
<ProgressBar id={progressBarIdB} aria-describedby={helpTextId} isIndeterminate />
<HelpText id={helpTextId}>
Connection lost. Check your connection and refresh the page to get up-to-date information.
Expand Down

0 comments on commit fa53842

Please sign in to comment.