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

Data table and resource list a11y docs #927

Merged
merged 23 commits into from
Jan 25, 2019

Conversation

dpersing
Copy link
Contributor

@dpersing dpersing commented Jan 23, 2019

This PR adds component-level accessibility documentation to the data table and resource list components (which link to each other), to display in the polaris-react repo and on the style guide. Changes should appear at the bottom of the gray Examples and Props section.

WHY are these changes introduced?

Adds documentation on accessibility features built into the components.

WHAT is this pull request doing?

  • Edits the README.md files for the data table and resource list components to add a new section.
  • 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:

Screenshot example

Data table accessibility content

@dpersing dpersing requested a review from danrosenthal January 23, 2019 19:54
@BPScott BPScott temporarily deployed to polaris-react-pr-927 January 23, 2019 19:54 Inactive
@BPScott BPScott temporarily deployed to polaris-react-pr-927 January 23, 2019 19:55 Inactive
@BPScott BPScott temporarily deployed to polaris-react-pr-927 January 23, 2019 20:11 Inactive
Copy link
Member

@chloerice chloerice left a comment

Choose a reason for hiding this comment

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

These are both great!! Just a couple typos and suggestions 😊

Co-Authored-By: dpersing <devon.persing@shopify.com>
@BPScott BPScott temporarily deployed to polaris-react-pr-927 January 23, 2019 23:38 Inactive
Co-Authored-By: dpersing <devon.persing@shopify.com>
@BPScott BPScott temporarily deployed to polaris-react-pr-927 January 23, 2019 23:38 Inactive
Co-Authored-By: dpersing <devon.persing@shopify.com>
@BPScott BPScott temporarily deployed to polaris-react-pr-927 January 23, 2019 23:39 Inactive
@dpersing
Copy link
Contributor Author

Thank you for your notes, @chloerice ! I've added your changes. 😃

Copy link
Contributor

@kaelig kaelig left a comment

Choose a reason for hiding this comment

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

Just a few fixes - content looks really great!

Co-Authored-By: dpersing <devon.persing@shopify.com>
@BPScott BPScott temporarily deployed to polaris-react-pr-927 January 24, 2019 17:27 Inactive
Co-Authored-By: dpersing <devon.persing@shopify.com>
@BPScott BPScott temporarily deployed to polaris-react-pr-927 January 24, 2019 17:28 Inactive
Co-Authored-By: dpersing <devon.persing@shopify.com>
@BPScott BPScott temporarily deployed to polaris-react-pr-927 January 24, 2019 23:36 Inactive
Co-Authored-By: dpersing <devon.persing@shopify.com>
kaelig and others added 5 commits January 24, 2019 15:41
Co-Authored-By: dpersing <devon.persing@shopify.com>
Co-Authored-By: dpersing <devon.persing@shopify.com>
Co-Authored-By: dpersing <devon.persing@shopify.com>
Co-Authored-By: dpersing <devon.persing@shopify.com>
Co-Authored-By: dpersing <devon.persing@shopify.com>
@BPScott BPScott temporarily deployed to polaris-react-pr-927 January 24, 2019 23:42 Inactive
@dpersing
Copy link
Contributor Author

Updated with <kbd> tags in light of https://github.com/Shopify/polaris-styleguide/pull/2527. Thanks, @kaelig!

### Keyboard support

Sorting controls for the data table component are implemented with native HTML buttons.

Copy link
Contributor

Choose a reason for hiding this comment

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

Note on the list below: it describes behaviors that should come for free when using native HTML buttons (as recommended above). Wondering if this is still worth mentioning?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'd like to include this because folks don't always know what keyboard inputs are native.

Co-Authored-By: dpersing <devon.persing@shopify.com>
@BPScott BPScott temporarily deployed to polaris-react-pr-927 January 25, 2019 16:24 Inactive
Co-Authored-By: dpersing <devon.persing@shopify.com>
@BPScott BPScott temporarily deployed to polaris-react-pr-927 January 25, 2019 16:24 Inactive
@BPScott BPScott temporarily deployed to polaris-react-pr-927 January 25, 2019 16:40 Inactive
Copy link
Contributor

@kaelig kaelig left a comment

Choose a reason for hiding this comment

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

:shipit:

@dpersing dpersing merged commit 969144c into master Jan 25, 2019
@kaelig kaelig deleted the data-table-resource-list-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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants