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

[DO NOT MERGE]: accessibility docs #4754

Closed
wants to merge 254 commits into from
Closed

Conversation

nikkimk
Copy link
Contributor

@nikkimk nikkimk commented Sep 16, 2024

Description

Improving the accessibility documentation of components.

Related issue(s)

Motivation and context

Documentation should provide more information and examples that demonstrate how to use the components accessibly.

How has this been tested?

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)
  • Chore (minor updates related to the tooling or maintenance of the repository, does not impact compiled assets)

Checklist

  • I have signed the Adobe Open Source CLA.
  • My code follows the code style of this project.
  • If my change required a change to the documentation, I have updated the documentation in this pull request.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes. N/A
  • All new and existing tests passed.
  • I have reviewed at the Accessibility Practices for this feature, see: Aria Practices

Best practices

This repository uses conventional commit syntax for each commit message; note that the GitHub UI does not use this by default so be cautious when accepting suggested changes. Avoid the "Update branch" button on the pull request and opt instead for rebasing your branch against main.

nikkimk and others added 30 commits August 6, 2024 16:12
* chore: updated changelog manually to remove duplicates

* chore: added changelog entries for bug fixes from interaction controller

* chore: updated changelog items for action menu and picker

* chore: updated changelog for picker

---------

Co-authored-by: Rajdeep Chandra <[email protected]>
Co-authored-by: Rajdeep Chandra <[email protected]>
Co-authored-by: Rajdeep Chandra <[email protected]>
nikkimk and others added 28 commits September 13, 2024 17:21
* fix(toast): added ability to wrap toast content with long words

* ci: updated golden image cache

---------

Co-authored-by: Rajdeep Chandra <[email protected]>
* feat(breadcrumbs): breadcrumbs component

* chore: remove duplicated CSS, some optional dependencies and add aria-label

* chore: accessibility

* chore: stories

* chore(breadcrumbs): wip breadcrumbs

* chore: prototype minimal viable product

* chore: more cleanup

* chore: unit tests

* chore: update stories

* chore: update stories and docs

* chore: unit tests & golden image cache

* chore: process spectrum-css for sp-breadcrumb-item

* chore: golden image cache

* chore: added compact and disabled state

* chore: added breadcrumbs documentation

* chore: added disabled property

* chore: process spectrum-css for compact

* chore: golden image cache

* chore: partially addressing code review

* chore: address remaining code review comments

* chore: golden image cache

* chore: enabled tab index for last item

* chore: updated breadcrumbs css version to 9.1.3

* chore: golden image cache

* chore: adds docs section for Breadcrumb item & hide internal properties

* chore: fix typo

---------

Co-authored-by: abaicu <[email protected]>
Co-authored-by: rmanole <[email protected]>
Co-authored-by: Rajdeep Chandra <[email protected]>
Co-authored-by: Rajdeep Chandra <[email protected]>
Co-authored-by: Rajdeep Chandra <[email protected]>
Co-authored-by: Rajdeep Chandra <[email protected]>
Co-authored-by: TaraT <[email protected]>
* chore(progress-bar): upgrade progress-bar and meter css

---------

Co-authored-by: TarunAdobe <[email protected]>
Co-authored-by: Rajdeep Chandra <[email protected]>
* fix(toast): added ability to wrap toast content with long words

* ci: updated golden image cache

---------

Co-authored-by: Rajdeep Chandra <[email protected]>
@nikkimk nikkimk closed this Sep 16, 2024
@nikkimk nikkimk deleted the nikkimk/accessibility-docs branch September 16, 2024 19:07
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.

10 participants