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

Alert dialog guidelines #295

Open
josepmartins opened this issue Sep 15, 2022 · 2 comments
Open

Alert dialog guidelines #295

josepmartins opened this issue Sep 15, 2022 · 2 comments

Comments

@josepmartins
Copy link
Contributor

Problem

Now that we have the wonderful Dialog documentation out, we might want to expand the documentation around dialog when used for alerts, warnings, or destructive purposes.

As @edokoa pointed out here, this sort of dialog doesn't follow a clear set of patterns, therefore we end up with different variations often used for similar use cases.

Figma file screenshot from @dylanatsmith to showcase different unpublish GitHub page dialog actions

Proposal

Add a new Dialog usage section (similar to the Button usage), or a subsection inside the Messaging guidelines. This documentation could cover:

  • Alert/flash banner usage (including best practices of danger and warning variants, positioning, tone and voice, etc)
  • Heading content, so we don't vary from "Are you sure...?" to "Doing this..."
  • Guidelines to display output or consequences on important actions (where and how to them, tone and voice, etc)
  • Consistency around buttons (when to require or not a confirmation input, using danger or secondary buttons, etc)

Slack thread reference (internal)

Figma file screenshot from @edokoa gathering all the different dialogs in GitHub

@arisacoba
Copy link
Member

👋 Hello. Has there been any planning that tackles this soon?

@josepmartins
Copy link
Contributor Author

josepmartins commented Nov 9, 2022

👋 @howdyray is collecting a list of repeatable patterns to provide guidance and documentation, and we included these guidelines too: https://docs.google.com/document/d/1jOoZzHO2MoMncjCdwM24ZUi1Dlm30FifXohFd9pN0CQ/edit#

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants