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

Caption a11y docs #928

Merged
merged 4 commits into from
Jan 25, 2019
Merged

Caption a11y docs #928

merged 4 commits into from
Jan 25, 2019

Conversation

dpersing
Copy link
Contributor

@dpersing dpersing commented Jan 23, 2019 •
edited
Loading

Short and sweet update for the caption component. Ideally should be published along with https://github.com/Shopify/polaris-styleguide/pull/2521 since that PR adds accessibility guidance for the data viz section.

WHY are these changes introduced?

Adds accessibility guidance for web, iOS, and Android for captions. Changes appear at the bottom of the gray examples/props section.

WHAT is this pull request doing?

  • Adds an accessibility section to the README.md
  • Adds an entry to UNRELEASED.md

How to 🎩

  1. Check out https://github.com/Shopify/polaris-styleguide/pull/2493 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: https://polaris.myshopify.io/components/titles-and-text/caption

Screenshots

Web:

Caption example for web

Android:

Caption example for Android

iOS:

Caption example for iOS

@BPScott BPScott temporarily deployed to polaris-react-pr-928 January 23, 2019 20:26 Inactive
dpersing
dpersing commented Jan 23, 2019
View reviewed changes
@BPScott BPScott temporarily deployed to polaris-react-pr-928 January 23, 2019 20:26 Inactive
dpersing
dpersing commented Jan 24, 2019
View reviewed changes
@dpersing dpersing merged commit f9cc78f into master Jan 25, 2019
@dpersing dpersing mentioned this pull request Feb 15, 2019
Closed
@kaelig kaelig deleted the caption-a11y-docs branch February 21, 2019 00:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kaelig kaelig kaelig approved these changes

@danrosenthal danrosenthal Awaiting requested review from danrosenthal

@sadiesaurus sadiesaurus Awaiting requested review from sadiesaurus

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 @kaelig @BPScott