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

Commit 2085d64

Browse files
committed
docs(a11y): add a list of supported screen readers
- add screen reader field to issue template - update browser support table - update README.md - require AngularJS 1.7.2+ - remove out of date http://browserl.ist link and image since their site is down - link to screen reader support section on docs site - update docs site screenshot - add missing step to install Gulp v3 globally - update versions in examples to use 1.2.0 Fixes #11449
1 parent 0d431e0 commit 2085d64

File tree

3 files changed

+99
-31
lines changed

3 files changed

+99
-31
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Please submit Angular Material and CDK questions
1414
[here](https://groups.google.com/forum/#!forum/angular-material2)
1515
and issues [here](https://github.com/angular/components/issues).
1616
-->
17-
## Bug, enhancement request, or proposal
17+
## Bug, Enhancement Request, or Proposal
1818

1919
<!-- Please note that we are not accepting major feature requests, i.e. requests for new components, at this time. -->
2020

@@ -45,6 +45,7 @@ and issues [here](https://github.com/angular/components/issues).
4545
- AngularJS Material: 1.
4646
- OS:
4747
- Browsers:
48+
- Screen Readers:
4849

4950
### Add anything else we should know
5051

README.md

Lines changed: 27 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -28,20 +28,20 @@ Quick Links:
2828
* [Installing](#installing)
2929

3030

31-
Please note that using AngularJS Material requires the use of **[AngularJS](https://angularjs.org/)
32-
1.4.x** or higher.
31+
Please note that using the latest version of AngularJS Material requires the use of
32+
**[AngularJS](https://angularjs.org/) 1.7.2** or higher.
3333

34-
AngularJS Material is targeted for the browser versions defined in the `browserslist` field
35-
of our [package.json](package.json). Below is a screenshot from
36-
[browserl.ist](http://browserl.ist/?q=%3E+0.5%25%2C+last+2+versions%2C+Firefox+ESR%2C+not+ie+%3C%3D+10%2C+not+ie_mob+%3C%3D+10%2C+not+bb+%3C%3D+10%2C+not+op_mob+%3C%3D+12.1)
37-
that provides a visual representation of this configuration:
34+
AngularJS Material supports the browser versions defined in the `browserslist` field
35+
of our [package.json](package.json). Find out more on our
36+
[docs site](https://material.angularjs.org/latest/#browser-support).
3837

39-
![AngularJS Material Browser Support](https://user-images.githubusercontent.com/3506071/50240047-c7e00780-0391-11e9-9241-6674a412ce94.png)
38+
AngularJS Material supports the screen reader versions listed
39+
[here](https://material.angularjs.org/latest/#screen-reader-support).
4040

4141
## <a name="demos"></a> Online Documentation and Demos
4242

4343
<div style="border: 1px solid #ccc">
44-
<img src="https://user-images.githubusercontent.com/3506071/39335179-ef92562e-497f-11e8-9f27-e23dc3a868f9.png" alt="AngularJS Material docs website" style="display:block;">
44+
<img src="https://user-images.githubusercontent.com/3506071/93010488-11578980-f55b-11ea-9ea3-c4a7bffd20b9.png" style="display:block;">
4545
</div><br>
4646

4747
- Visit [material.angularjs.org](https://material.angularjs.org/) online to review the API, see the
@@ -73,8 +73,8 @@ The minor builds (1.1.0, 1.2.0, 1.3.0) can contain breaking changes to CSS, APIs
7373
Our formal release of `minor` builds is much less frequent. The release process for `minor` builds is currently
7474
being re-evaluated.
7575

76-
> For the purposes of AngularJS Material, you *could* think of the patch releases as being *minor* changes
77-
and the 'minor' releases as being *major* changes according to semver.
76+
> For the purposes of AngularJS Material, you *could* think of the patch releases as being *minor* changes,
77+
and the 'minor' releases as being *major* changes according to semver.
7878

7979
## <a name="contributing"></a> Contributing
8080

@@ -95,7 +95,7 @@ It is important to note that for each release, the [ChangeLog](CHANGELOG.md) is
9595
itemize all:
9696

9797
- Bug Fixes
98-
- New Features
98+
- New Enhancements
9999
- Breaking Changes
100100

101101
## <a name="building"></a> Building
@@ -108,6 +108,12 @@ First install or update your local project's **npm** dependencies:
108108
npm install
109109
```
110110

111+
Install Gulp v3 globally:
112+
113+
```bash
114+
npm install -g gulp@3
115+
```
116+
111117
Then run the **gulp** tasks:
112118

113119
```bash
@@ -148,23 +154,22 @@ npm install http://github.com/angular/bower-material#master --save
148154
#### Other Dependency Managers
149155

150156
Visit our [distribution repository](https://github.com/angular/bower-material/blob/master/README.md)
151-
for more details on how to install and use the AngularJS Material distribution
152-
files within your local project.
157+
for more details on how to install and use the AngularJS Material distribution files within your local
158+
project.
153159

154160
#### CDN
155161

156162
CDN versions of AngularJS Material are available.
157163

158-
With the Google CDN, you will not need to download local copies of the distribution files. Instead
164+
With the Google CDN, you will not need to download local copies of the distribution files. Instead,
159165
simply reference the CDN urls to easily use those remote library files. This is especially useful
160-
when using online tools such as [CodePen](http://codepen.io/), [Plunker](http://plnkr.co/), or
161-
[JSFiddle](http://jsfiddle.net/).
166+
when using online tools such as [CodePen](http://codepen.io/) or [Plunker](http://plnkr.co/).
162167

163168
```html
164169
<head>
165170

166-
<!-- AngularJS Material CSS now available via Google CDN; version 1.1.21 used here -->
167-
<link rel="stylesheet" href="https://ajax.googleapis.com/ajax/libs/angular_material/1.1.21/angular-material.min.css">
171+
<!-- AngularJS Material CSS now available via Google CDN; version 1.2.0 used here -->
172+
<link rel="stylesheet" href="https://ajax.googleapis.com/ajax/libs/angular_material/1.2.0/angular-material.min.css">
168173

169174
</head>
170175
<body>
@@ -175,8 +180,8 @@ when using online tools such as [CodePen](http://codepen.io/), [Plunker](http://
175180
<script src="https://ajax.googleapis.com/ajax/libs/angularjs/1.8.0/angular-aria.min.js"></script>
176181
<script src="https://ajax.googleapis.com/ajax/libs/angularjs/1.8.0/angular-messages.min.js"></script>
177182

178-
<!-- AngularJS Material Javascript now available via Google CDN; version 1.1.21 used here -->
179-
<script src="https://ajax.googleapis.com/ajax/libs/angular_material/1.1.22/angular-material.min.js"></script>
183+
<!-- AngularJS Material Javascript now available via Google CDN; version 1.2.0 used here -->
184+
<script src="https://ajax.googleapis.com/ajax/libs/angular_material/1.2.0/angular-material.min.js"></script>
180185
</body>
181186
```
182187

@@ -204,7 +209,8 @@ pull directly from our [distribution repository](https://github.com/angular/bowe
204209
</body>
205210
```
206211

207-
Once you have all the necessary assets installed, add `ngMaterial` and `ngMessages` as dependencies for your app:
212+
Once you have all the necessary assets installed, add `ngMaterial` and `ngMessages` as dependencies for your
213+
app:
208214

209215
```javascript
210216
angular.module('myApp', ['ngMaterial', 'ngMessages']);

docs/app/partials/home.tmpl.html

Lines changed: 70 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -130,42 +130,103 @@ <h3>The following table provides a more detailed view:</h3>
130130
</tr>
131131
<tr>
132132
<td>
133-
Safari
133+
Safari macOS & iOS
134134
</td>
135135
<td>
136136
12.x<br>13.x
137137
</td>
138138
</tr>
139139
<tr>
140140
<td>
141-
iOS
141+
Firefox for Android<br/>UC
142142
</td>
143143
<td>
144-
12.x<br>13.x
144+
latest version
145145
</td>
146146
</tr>
147147
<tr>
148148
<td>
149-
Firefox for Android<br/>UC
149+
Samsung Internet
150150
</td>
151151
<td>
152-
latest version
152+
12.x
153153
</td>
154154
</tr>
155155
<tr>
156156
<td>
157-
Samsung Internet
157+
Opera for Android
158158
</td>
159159
<td>
160-
10.x
160+
Mini all
161161
</td>
162162
</tr>
163+
</tbody>
164+
</table>
165+
166+
<h2 class="md-headline">Screen Reader Support</h2>
167+
<p>
168+
AngularJS Material is built based on the
169+
<a href="https://www.w3.org/TR/wai-aria-1.0/" target="_blank" rel="noopener"> WAI-ARIA 1.0 W3C Recommendation</a>.
170+
</p>
171+
<h3>
172+
AngularJS Material supports the following screen readers:
173+
</h3>
174+
<table class="custom-table">
175+
<tbody>
176+
<tr>
177+
<th>
178+
Screen Reader
179+
</th>
180+
<th>
181+
Supported Versions
182+
</th>
183+
</tr>
163184
<tr>
164185
<td>
165-
Opera for Android
186+
NVDA
166187
</td>
167188
<td>
168-
Mini all
189+
2019.x<br>2020.x
190+
</td>
191+
</tr>
192+
<tr>
193+
<td>
194+
JAWS
195+
</td>
196+
<td>
197+
2019.x<br>2020.x
198+
</td>
199+
</tr>
200+
<tr>
201+
<td>
202+
Android Accessibility Suite
203+
</td>
204+
<td>
205+
8.1.x<br>8.2.x
206+
</td>
207+
</tr>
208+
<tr>
209+
<td>
210+
VoiceOver macOS
211+
</td>
212+
<td>
213+
Mojave<br>Catalina
214+
</td>
215+
</tr>
216+
<tr>
217+
<td>
218+
VoiceOver iOS
219+
</td>
220+
<td>
221+
12.x<br>13.x
222+
</td>
223+
</tr>
224+
<tr>
225+
<td>
226+
ChromeVox on Chrome OS
227+
</td>
228+
<td>
229+
last 2 versions
169230
</td>
170231
</tr>
171232
</tbody>

0 commit comments

Comments
 (0)