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

Add Dialog pattern #26

Open
ellm opened this issue Mar 28, 2024 · 0 comments
Open

Add Dialog pattern #26

ellm opened this issue Mar 28, 2024 · 0 comments
Assignees
Labels
accessibility Improving the accessibility of an interface enhancement New feature or request ux Designing and implementing user experience improvements

Comments

@ellm
Copy link
Member

ellm commented Mar 28, 2024

Description

Description

A dialog component should be added to the Accessibility Patterns Library and documented.

Acceptance Criteria

See Contributing Guidelines

  • A dialog component has been added to the pattern library.
  • The component passes all WCAG AA specifications (see Testing).
  • The component pattern(s) are thoroughly documented, including but not limited to the following sections:
    • Title: Pattern title, along with other names that may be used.
    • Summary: An overview of what the pattern is and how it is commonly used.
    • Best Practices: Some DOs and DON'Ts when implementing this pattern.
    • Accessibility Considerations: Any specific accessibility considerations or edge cases to account for.
    • Examples: Examples of markup used to build the pattern.

Testing

Each pattern added to the library should be tested thoroughly to ensure it meets WCAG AA standards.

  • Automated Testing: Use Google Lighthouse and the SiteImprove Accessibility Checker Chrome extension (or another tool of your choice) to ensure the component passes all criteria.
  • Manual Testing: Conduct manual testing via keyboard and screen reader (desktop and mobile) to ensure the component is accessible and user-friendly.

Testing Tips

The pattern library includes the a11y addon that adds an "Accessibility" tab to each component's canvas and performs automated accessibility testing. Use this to ensure there are no violations.

When running Storybook locally, you can view your component in a standalone window by clicking the "Open canvas in a new tab" icon button in the top right. You can use this window to test your component in isolation.

Use Case

Dialogs are commonly used in our clients' websites as a method to notify the user to an take action. A dialog can appear as part of the page document content model. Or appear as a modal overlay where the page document content becomes inert.

This pattern should be added to the library and documented so that everyone at Alley can reference the pattern and create accessible tab components within their projects.

@ellm ellm added enhancement New feature or request accessibility Improving the accessibility of an interface ux Designing and implementing user experience improvements labels Mar 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
accessibility Improving the accessibility of an interface enhancement New feature or request ux Designing and implementing user experience improvements
Projects
None yet
Development

No branches or pull requests

2 participants