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.

Sign up for GitHub

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

Jump to bottom

[a11y] Add documentation for the badge component #1364

Merged
merged 2 commits into from
Apr 26, 2019
Merged

[a11y] Add documentation for the badge component #1364

merged 2 commits into from
Apr 26, 2019

Conversation

dpersing
Copy link
Contributor

@dpersing dpersing commented Apr 25, 2019 •
edited
Loading

WHY are these changes introduced?

Adds accessibility guidance for the badge component, to appear in polaris-react docs and in the style guide.

See the draft Google doc for editing history for these changes and updates for other components and pages.

WHAT is this pull request doing?

  • Adds accessibility documentation for the badge component (web, iOS, and Android)
  • Adds an entry to UNRELEASED.md

How to 🎩

  1. Check out master from polaris-styleguide to get the changes that support the accessibility section.
  2. In another Terminal tab or window, check out this branch from polaris-react and run the instructions for testing in a consuming project.
  3. In the polaris-styleguide tab, run dev up && dev start.
  4. View changes after examples and props: /components/images-and-icons/badge (web, iOS, and Android)

Screenshots

Web

Screenshot of the web view for the component docs

Android

Screenshot of the Android view for the component docs

iOS

Screenshot of the iOS view for the component docs

@BPScott BPScott temporarily deployed to polaris-react-pr-1364 April 25, 2019 21:10 Inactive
@dpersing dpersing mentioned this pull request Apr 25, 2019
Closed
@dpersing dpersing requested a review from sadiesaurus April 25, 2019 22:26
sadiesaurus
sadiesaurus approved these changes Apr 26, 2019
View reviewed changes
Copy link
Contributor

@sadiesaurus sadiesaurus left a comment

Choose a reason for hiding this comment

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

LGTM!

@dpersing dpersing merged commit 47debe4 into master Apr 26, 2019
@dpersing dpersing deleted the badge-a11y-docs branch April 26, 2019 16:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sadiesaurus sadiesaurus sadiesaurus approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@dpersing @sadiesaurus @BPScott