Skip to content
This repository was archived by the owner on Sep 20, 2024. It is now read-only.

Accessibility info added for Clink component #244

Merged
merged 4 commits into from
Jun 27, 2020

Conversation

saptaksengupta
Copy link
Contributor

@saptaksengupta saptaksengupta commented Jun 26, 2020

Accessibility.md file added for CLink Component

Description

Accessibility.md file added for CLink Component, based on aria document provided into [aria link docs] (https://www.w3.org/TR/wai-aria-practices-1.2/#link)

Motivation and Context

To provide a basic idea of accessibility features that are provided in CLink component.

How Has This Been Tested?

By Reviewing the Accessibility file in local branch

Screenshots (if appropriate):

image

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

Name added to contributors list
accessibility.md file added to brief the basic introductions on
accessibility of CLink component
@vercel
Copy link

vercel bot commented Jun 26, 2020

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

added quotes to render an '<a>' tag in WAI-ARIA compliance
Copy link
Collaborator

@codebender828 codebender828 left a comment

Choose a reason for hiding this comment

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

Nice work with this @saptaksengupta ! Thanks for taking on this task. I requested one change with regards to the context menu. Since it's optional, and not implemented on the CLink it's best to remove it so that users aren't confused.

Otherwise it looks good!

One thing to take note of in future is to test as you write the reports. I found lots of bugs while doing this and I was able to fix them in the process. I would go through each WAI-ARIA feature while testing it on the built component to make sure it's compliant. You may find a bug in this process. If you do, please feel free to open an issue for the discrepancy. If you think you can implement the fix as well you can go ahead and do it as well.

Otherwise, this is really great work! thank you!


### `CLink` Keyboard Interaction
- [x] **`Enter`**: Executes the link and moves focus to the link target.
- [x] **`Shift + F10 (Optional)`**: Opens a context menu for the link.
Copy link
Collaborator

@codebender828 codebender828 Jun 27, 2020

Choose a reason for hiding this comment

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

Since this is optional and not implemented on the CLink component I think we should remove it so readers aren't misled. 👍

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sure @codebender828. I will remove it.

Thanks a lot for you valuable feedback. i will take care all of this in future.

keyboard interaction removed as that was optional in nature.
Copy link
Collaborator

@codebender828 codebender828 left a comment

Choose a reason for hiding this comment

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

Thank you

@codebender828 codebender828 merged commit f06b2c5 into chakra-ui:master Jun 27, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants