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

Disclosure pattern docs update πŸ–οΈ #3428

Open
4 tasks
laurenmrice opened this issue Mar 10, 2023 · 2 comments
Open
4 tasks

Disclosure pattern docs update πŸ–οΈ #3428

laurenmrice opened this issue Mar 10, 2023 · 2 comments

Comments

@laurenmrice
Copy link
Member

laurenmrice commented Mar 10, 2023

Update disclosure pattern docs

With the new addition of Menu and Menu buttons documentation on the website, parts of the Disclosure pattern documentation are now outdated and need to be updated with new information to be more accurate.

What is a disclosure pattern, and what isn't?
Let's be more clear with our guidelines around what is considered to be a disclosure pattern.

  • For example: A disclosure pattern is something that is always disclosed by the user.
  • For example: A disclosure can consist of a trigger + popover OR a trigger + menu. These are considered to be disclosures.
  • This pattern should help guide user's to decide which type of disclosure to use for their usecases in product.

We need to determine if this pattern is still needed or if it makes sense to continue to iterate on it.


Define rules

Define rules around which components in our system are considered disclosure type patterns and which ones are not.

ARE disclosures: Menus, Dropdowns, Tooltips, and Toggletips

ARE NOT disclosures: Modals, Tearsheets, Megamenus, Accordions, Multi-line Code Snippet, Expandable Tiles, and Notifications.

  • We need to explain why these are not considered to be disclosures in our docs. Many reasons for this have to do with displacement and persistence.

Create guidelines

Label treatment

  • What is the label treatment of the trigger? Sometimes, the label needs to be explicit above the component that triggers it (like a dropdown), or it could be in a tooltip on hover if it is an icon button. Cover the most common situations for this.

Focus treatment and behavior

  • Where does Focus typically go in disclosures, whether on the trigger or within the area that is disclosed to the user?
  • Think about if the focus behavior automatically moves into the disclosed area (like menus) or if it needs to manually be moved by the user with a keyboard (like toggletips).

Persistence

  • Once information is disclosed, the information persists until the user dismisses it by either clicking on the page or on the trigger again.

Displacement

  • Things considered not to be disclosures are usually full-page takeovers like modals or tearsheets, which obscures the disclosure trigger which needs to still be available to dismiss it.
  • Things considered not to be disclosures typically push down content when disclosed on the same level of the page instead of overlaying content on a separate layer.

Proximity

  • Show the different ways of how the disclosed information, in a popover or menu container, for example, is closely related to the trigger. Sometimes, this could be a no tip, caret tip, or tab tip situation. Explain when to use one over the other.

Tasks

Preview Give feedback
  1. component: combo-button role: design ✏️ type: docs πŸ“–
@laurenmrice laurenmrice moved this to ⏱ Backlog in Design System Mar 10, 2023
@laurenmrice laurenmrice changed the title docs: update disclosure pattern with combo button edits docs: update disclosure pattern docs Oct 2, 2023
@laurenmrice
Copy link
Member Author

Related #3739

@laurenmrice
Copy link
Member Author

laurenmrice commented Oct 16, 2023

To unblock this issue:

  • Merge Menu docs
  • Have an a11y discussion

@sstrubberg sstrubberg added this to the 2024 Q1 milestone Nov 8, 2023
@sstrubberg sstrubberg moved this from ⏱ Backlog to πŸͺ† Needs Refined in Design System Nov 8, 2023
@sstrubberg sstrubberg removed this from the 2024 Q1 milestone Nov 28, 2023
@sstrubberg sstrubberg added this to the 2024 Q2 milestone Mar 19, 2024
@sstrubberg sstrubberg changed the title docs: update disclosure pattern docs Disclosure pattern docs update πŸ–οΈ Jun 25, 2024
@sstrubberg sstrubberg modified the milestones: 2024 Q2, 2023 Q4, 2024 Q4 Jun 25, 2024
@github-project-automation github-project-automation bot moved this to Triage in Roadmap Sep 17, 2024
@sstrubberg sstrubberg moved this from Triage to Next ➑ in Roadmap Sep 17, 2024
@sstrubberg sstrubberg removed this from the 2024 Q4 milestone Sep 17, 2024
@sstrubberg sstrubberg moved this from Next ➑ to Later 🧊 in Roadmap Oct 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: πŸͺ† Needs Refined
Status: Later 🧊
Development

No branches or pull requests

2 participants