Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Spinner Component: Added design documentation and image #16760

Merged
merged 3 commits into from
Aug 1, 2019

Conversation

cburton4
Copy link
Contributor

Description

Added a description of the component, design documentation, and an image.

@davewhitley davewhitley added [Type] Developer Documentation Documentation for developers Needs Copy Review Needs review of user-facing copy (language, phrasing) Needs Design Feedback Needs general design feedback. labels Jul 25, 2019
@benhuberman
Copy link

A few suggestions on this one:

Before:

Spinners are used to notify users that their action is being processed.

After:

Spinners notify users that their action is being processed.

Before:

Notify users that their request has been received and the action will soon complete.

After:

Signal to users that the processing of their request is underway and will soon complete.

Before:

The spinner component should be avoided to load a page or data.

After:

Not appear when pages or data are loading.

Let me know if you have any concerns with these suggested edits -- I mostly wanted to avoid the passive voice as much as possible, and to make sure the second bullet point conforms to the "Should" construction that prepares it.

@cburton4
Copy link
Contributor Author

@benhuberman

No concerns, these tweaks look great. I have updated accordingly. Thanks for the review!

The spinner component should:

- Signal to users that the processing of their request is underway and will soon complete.
- Not appear when pages or data are loading.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you clarify this Not appear when pages or data are loading.? Isn't this the whole purpose of the spinner component (data being loaded)?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep this is a good question. The thinking here is that future forward it's ideal to have different kinds of feedback or progress indicators, each with their own purpose. Since the spinner is the only progress indicator we have I jumped the gun with this guidance.

Future component descriptions might look something like this:

Spinner: An action is being processed with an unspecified amount of wait time. They should be used when progress isn’t detectable, or if it’s not necessary to indicate how long an activity will take.

Progress bar: Used to indicate to users that a page is loading or an upload is processing. It shows how much of the task has been completed and how much is left.

In the meantime I can remove Not appear when pages or data are loading until we hopefully add a Progress bar component.

Removed guidelines, "Not appear when pages or data are loading."
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Needs Copy Review Needs review of user-facing copy (language, phrasing) Needs Design Feedback Needs general design feedback. [Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants