angular / angular/components

docs(cdk): provide guidance for a11y

Open
#13,758 0 comments 0 reactions 0 assignees View on GitHub
Accessibility area: material.angular.io docs P3
Dominant language
TypeScript
Stars
25k
Forks
6.8k
Avg merge
1d 8h
Merged PRs (30d)
91

Description

#### Bug, feature request, or proposal:
Proposal

#### What is the expected behavior?
We should provide a11y guidance for CDK components as well as the Material components.

#### What is the current behavior?
All of the current Material components have an a11y section in their docs except for the CDK components like Table, Tree, Stepper, Drag-Drop, and Virtual Scroll (Scrolling).

#### What are the steps to reproduce?
https://material.angular.io/cdk/drag-drop/overview

#### What is the use-case or motivation for changing an existing behavior?
We want UI library authors to publish accessible components when building with the CDK.

#### Which versions of Angular, Material, OS, TypeScript, browsers are affected?
Angular 7
Angular Material 7.0.1
TypeScript 3.1.x
All browsers

#### Is there anything else we should know?
The current drag-drop schematic does not generate an accessible experience.

@crisbeto indicated that [this article](https://medium.com/salesforce-ux/4-major-patterns-for-accessible-drag-and-drop-1d43f64ebf09) may include some helpful guidance for drag and drop a11y.

Contributor guide

Open the contributing guide

Research direction

Review the CDK documentation pages for Table, Tree, Stepper, Drag-Drop, and Virtual Scroll, comparing them with the existing accessibility sections for Material components. Read the linked drag-and-drop accessibility article and inspect the current drag-drop schematic; done means the affected CDK guidance and the stated schematic accessibility gap have been addressed.

Written by the indexing model from the issue text.

Assessment

Tech stack
angular, typescript
Domain
accessibility, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.