-
Notifications
You must be signed in to change notification settings - Fork 443
/
Copy pathindex.html
515 lines (419 loc) · 20.1 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
<!DOCTYPE html>
<html class="no-js" lang="en" dir="ltr" prefix="og: http://ogp.me/ns#">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, viewport-fit=cover">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<script>
document.documentElement.className = document.documentElement.className.replace('no-js', 'has-js');
function downloadJSAtOnload() {
var element = document.createElement("script");
element.src = "/WAI/assets/scripts/main.js?1725379015012883017";
document.body.appendChild(element);
}
window.addEventListener("load", downloadJSAtOnload, false);
</script>
<link rel="stylesheet" href="/WAI/assets/css/style.css?1725379015012883017">
<title> ARIA Authoring Practices Guide | APG | WAI | W3C</title><!-- Begin Jekyll SEO tag v2.8.0 -->
<meta name="generator" content="Jekyll v4.3.3" />
<meta property="og:title" content="ARIA Authoring Practices Guide" />
<meta name="author" content="W3C Web Accessibility Initiative (WAI)" />
<meta property="og:locale" content="en" />
<meta name="description" content="Accessibility resources free online from the international standards organization: W3C Web Accessibility Initiative (WAI)." />
<meta property="og:description" content="Accessibility resources free online from the international standards organization: W3C Web Accessibility Initiative (WAI)." />
<link rel="canonical" href="https://www.w3.org/WAI/ARIA/apg/" />
<meta property="og:url" content="https://www.w3.org/WAI/ARIA/apg/" />
<meta property="og:site_name" content="Web Accessibility Initiative (WAI)" />
<meta property="og:type" content="website" />
<meta name="twitter:card" content="summary_large_image" />
<meta property="twitter:title" content="ARIA Authoring Practices Guide" />
<meta name="twitter:site" content="@w3c_wai" />
<meta name="twitter:creator" content="@W3C Web Accessibility Initiative (WAI)" />
<script type="application/ld+json">
{"@context":"https://schema.org","@type":"WebPage","author":{"@type":"Person","name":"W3C Web Accessibility Initiative (WAI)"},"description":"Accessibility resources free online from the international standards organization: W3C Web Accessibility Initiative (WAI).","headline":"ARIA Authoring Practices Guide","url":"https://www.w3.org/WAI/ARIA/apg/"}</script>
<!-- End Jekyll SEO tag -->
<meta name="twitter:image" property="og:image" content="https://www.w3.org/WAI/assets/images/social-sharing-default.jpg">
<link rel="alternate" type="application/rss+xml" href="/WAI/feed.xml">
</head>
<body id="top" class="page-aria-authoring-practices-guide ">
<a href="#main" class="button button--skip-link">Skip to content</a>
<div class="minimal-header-container default-grid">
<header class="minimal-header" id="site-header">
<div class="minimal-header-container">
<div class="minimal-header-name">
<a href="/WAI/ARIA/apg/">
ARIA Authoring Practices Guide (APG)
</a>
</div>
<p class="minimal-header-subtitle">
How to build accessibility semantics into web patterns and widgets
</p>
</div>
<div class="minimal-header-logo">
<a href="/WAI/">
<img alt="W3C" src="/WAI/assets/images/w3c2.svg" width="92" height="44"/>
<img alt="Web Accessibility Initiative" src="/WAI/assets/images/wai.svg"/>
</a>
</div>
</header>
</div>
<div class="default-grid nav-container">
<div class="nav" >
<nav class="nav" aria-label="APG">
<ul>
<li class="nav__item"><a href="/WAI/ARIA/apg/" class="active" aria-current="page">APG Home</a></li>
<li class="nav__item"><a href="/WAI/ARIA/apg/patterns/">Patterns</a></li>
<li class="nav__item"><a href="/WAI/ARIA/apg/practices/">Practices</a></li>
<li class="nav__item"><a href="/WAI/ARIA/apg/example-index/">Index</a></li>
<li class="nav__item"><a href="/WAI/ARIA/apg/about/">About</a></li>
<li class="nav__item"><a href="https://www.w3.org/WAI/standards-guidelines/wcag/docs/">
All WCAG 2 Guidance
<svg focusable="false" aria-hidden="true" class="icon-different-view "><use xlink:href="/WAI/assets/images/icons.svg#icon-different-view"></use></svg>
</a></li>
</ul>
</nav>
</div>
</div>
<div class="default-grid with-gap leftcol">
<style>
.nav {
background: none;
}
.nav-related-info { /* blue bar with the "About:" links */
background: #005a9c;
color: #fff;
}
.nav-related-info a {
color: #fff !important;
}
.nav-page-specific { /* light blue bar with page/section specific navigation/pager */
margin-bottom: 1.25em;
}
.nav a:link, .nav a:visited {
color: #036;
color: var(--w3c-blue);
}
.nav a:hover, .nav a:active {
color: var(--dk-blue);
}
.nav-hack.sidebar a:hover,
.nav-hack.sidebar a:active
{
color: var(--dk-blue);
text-decoration: underline;
}
.standalone-resource-about, .standalone-resource-pager {
margin: 0;
}
nav.standalone-resource-about {
padding: .5em 0 1.5em 0;
font-style: italic;
}
.nav .standalone-resource-pager ul {
align-items: center;
}
.nav .standalone-resource-pager a,
.nav .standalone-resource-pager span {
margin-left: 0;
margin-right: 1.5em;
padding: .5em;
}
.pager-icon {
vertical-align: middle;
padding: 0 0 0.15em 0;
margin: 0 -0.4em;
width: 1.65em;
height: 2em;
fill: var(--dk-blue)
}
.category-icon {
vertical-align: middle;
padding: 0 0.25em 0.25em 0.25em;
width: 2em;
height: 2em;
}
.zstandalone-resource-pager {
padding: .7em 0;
}
.standalone-resource-pager zul {
display: block;
}
.standalone-resource-pager zul li {
display: inline;
}
.nav-hack {
font-size: .85rem;
/*justify-self: end;*/
align-self: start;
}
.nav-hack ul {
list-style: none;
border-bottom: 1px solid #BCBCBC;
padding-left: 0
}
.nav-hack li:not(:first-child){
padding-top: 0.4em;
line-height: 1.2;
border-top: 1px solid #BCBCBC;
}
.nav-hack li a {
text-decoration: none;
}
.nav-hack h3 {
margin: 0;
font-size: 1rem;
}
.nav-hack p {
margin: 0;
}
h2#sidebar-header {
font-size: .95rem;
}
/* skip link */
.button--skip-link {
background-color: var(--gold) !important;
border-color: var(--gold) !important;
outline-color: currentColor !important;
color: var(--off-black) !important;
font-weight: 600;
font-size: larger;
margin: 0 auto;
position: absolute;
z-index: 20;
left: 0;
right: 0;
top: 0.5em;
width: 10em;
opacity: 1;
transition: transform 0.1875s ease-out, opacity 0.1875s ease-out;
}
.button--skip-link:not(:focus):not(:hover) {
transform: translateY(-4em);
opacity: 0;
}
.standalone-resource-navrule {
border:none;
border-top: 1px solid grey
}
.standalone-resource-about ul,
.standalone-resource-pager ul {
list-style: none;
}
.standalone-resource-about a,
.standalone-resource-pager a,
.standalone-resource-about span,
.standalone-resource-pager span
{
margin-left:.8em;
margin-right:.8em;
}
.minimal-header-name a {
text-decoration: none;
}
.minimal-header-name a:hover,
.minimal-header-name a:focus {
text-decoration: underline;
}
</style>
<main id="main" lang="en" class="standalone-resource__main">
<header>
<h1>
<span class="standalone-resource__type-of-guidance">
</span>
ARIA Authoring Practices Guide
</h1>
</header>
<meta charset="UTF-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>ARIA Authoring Practices Guide</title>
<link rel="stylesheet" href="/WAI/content-assets/wai-aria-practices/styles.css" />
<!-- Code highlighting styles -->
<link rel="stylesheet" href="/WAI/content-assets/wai-aria-practices/shared/css/github.css" />
<script>
const parentPage = window.location.pathname.match(
/\/(patterns|practices|about)\//
)?.[1];
if (parentPage) {
const parentHref = 'a[href*="' + parentPage + '"]';
document.querySelector(parentHref).classList.add('active');
}
</script>
<div>
<link rel="stylesheet" href="/WAI/content-assets/wai-aria-practices/homepage.css" />
<div class="off-white-section">
<div class="contained top-contained margin-fix">
<div class="top-section">
<div class="top-box">
<div class="top-detail-1 detail-1"></div>
<div class="detail-2"></div>
<h1>ARIA Authoring Practices Guide (APG) Home</h1>
<p>
Learn to use the accessibility semantics defined by the Accessible Rich Internet Application (ARIA) specification to create accessible web experiences.
This guide describes how to apply accessibility semantics to common design patterns and widgets.
It provides design patterns and functional examples complemented by in-depth guidance for fundamental practices.
</p>
<a href="patterns/" class="button-link button-link-white">View Patterns</a>
</div>
<img alt="A laptop screen fills with an accessibility icon and emits a checkmark." src="../../content-images/wai-aria-practices/images/index-1.svg" />
</div>
</div>
<div class="detail-3"></div>
<div class="top-grid-pattern grid-pattern"></div>
</div>
<div class="white-section">
<div class="centered">
<div class="resource-detail-4 detail-4"></div>
<h2>APG Resources</h2>
<p>Building blocks that help you make the web accessible</p>
</div>
<div class="contained margin-fix">
<div class="resource-item">
<div class="resource-item-content">
<h3>Design Patterns and Examples</h3>
<p>
Learn how to make accessible web components and widgets with ARIA roles, states and properties and by implementing keyboard support.
One or more ways of implementing each pattern is demonstrated with a functional example.
</p>
<a href="patterns/" aria-label="Learn more about APG patterns and examples" class="button-link">Learn More</a>
</div>
<div class="resource-item-img">
<img alt="A menagerie of widgets." src="../../content-images/wai-aria-practices/images/index-2.svg" />
</div>
</div><div class="resource-item">
<div class="resource-item-content">
<h3>Use ARIA Landmarks</h3>
<p>
Learn how to use HTML sectioning elements and ARIA landmark roles to make it easy for assistive technology users to understand the meaning of the layout of a page.
</p>
<a href="practices/landmark-regions/" aria-label="Learn more about ARIA landmarks" class="button-link">Learn More</a>
</div>
<div class="resource-item-img">
<img alt="A document flies apart into chunks." src="../../content-images/wai-aria-practices/images/index-3.svg" />
</div>
</div><div class="resource-item">
<div class="resource-item-content">
<h3>Providing Accessible Names and Descriptions</h3>
<p>
Providing elements with accessible names and, where appropriate, accessible descriptions is one of the most important responsibilities authors have when developing accessible web experiences.
</p>
<a href="practices/names-and-descriptions/" aria-label="Learn more about accessible names and descriptions" class="button-link">Learn More</a>
</div>
<div class="resource-item-img">
<img alt="Indicators delve inside a document." src="../../content-images/wai-aria-practices/images/index-4.svg" />
</div>
</div><div class="resource-item">
<div class="resource-item-content">
<h3>And So Much More...</h3>
<p>
Learn about other fundamental practices related to correctly using accessibility semantics, developing keyboard interfaces, and more.
</p>
<a class="button-link" href="practices/" aria-label="Learn more about APG practices">Learn More</a>
</div>
<div class="resource-item-img">
<img alt="A box with an accessibility label is chock full of widgets and document bits." src="../../content-images/wai-aria-practices/images/index-5.svg" />
</div>
</div>
</div>
<div class="collaboration-grid-pattern grid-pattern"></div>
</div>
<div class="white-section">
<div class="centered margin-fix">
<h2 class="collaboration-h2">
Get Involved
</h2>
<p class="collaboration-p">
The APG Task Force relies on broad community representation and participation to continuously improve the usefulness and quality of the APG.
There are a variety of ways you can get involved and help promote development of accessible experiences.
</p>
</div>
<div class="collaboration-items">
<div class="collaboration-item">
<img alt="An icon showing three nodes connecting." src="../../content-images/wai-aria-practices/images/index-6.svg" />
<h3>Join the Task Force</h3>
<p>
To join the APG Task Force, individuals need to first join the W3C ARIA Working Group.
Participants are expected to actively contribute to the work of the task force.
</p>
<a rel="noopener noreferrer" target="_blank" href="https://www.w3.org/WAI/ARIA/task-forces/practices/">Learn more about the work of the task force and how to join</a>
</div>
<div class="collaboration-item">
<img alt="An icon showing two human shapes carrying a burden." src="../../content-images/wai-aria-practices/images/index-7.svg" />
<h3>Contribute via GitHub</h3>
<p>
Many valuable contributions are made by people who find or raise issues of interest in our GitHub repository and then submit proposed changes via a GitHub pull request.
If you choose this path, please start by studying our guidelines for contributing to the repository and maintaining code quality.
</p>
<a rel="noopener noreferrer" target="_blank" href="https://github.com/w3c/aria-practices">View ReadMe in the GitHub repository</a>
</div>
<div class="collaboration-item mailing-list-item">
<div class="collaboration-detail-4 detail-4"></div>
<img alt="A notification bell icon appears over an email icon." src="../../content-images/wai-aria-practices/images/index-8.svg" />
<div>
<h3>Mailing Lists</h3>
<p>
The APG Task Force uses the public aria-practices mailing list for email discussion.
Meeting announcements, agendas, and links to minutes are sent to the mailing list.
While GitHub issues are the preferred place to discuss APG content, the mailing list is available to anyone who would prefer to communicate with the APG Task Force via email.
</p><p><a rel="noopener noreferrer" target="_blank" href="https://lists.w3.org/Archives/Public/public-aria-practices/">View the aria-practices mailing list archive</a></p>
</div>
</div>
</div>
<div class="bottom-grid-pattern grid-pattern"></div>
</div>
<div class="bottom-off-white-section off-white-section"></div>
</div>
<script src="/WAI/content-assets/wai-aria-practices/shared/js/skipto.js" data-skipto="colorTheme:aria; displayOption:popup; containerElement:div"></script>
</main>
</div>
<div class="default-grid with-gap leftcol">
<div class="standalone-resource__prevnext"><aside class="box box-icon box-space-above" id="helpimprove" aria-label="feedback"><header class="box-h box-h-icon box-h-space-above box-h-icon"> <svg focusable="false" aria-hidden="true" class="icon-comments "><use xlink:href="/WAI/assets/images/icons.svg#icon-comments"></use></svg> <h2> Help improve this page </h2></header><div class="box-i"><p>Please share your ideas, suggestions, or comments via e-mail to the publicly-archived list <a href="mailto:[email protected]?subject=%5Ben%5D%20ARIA%20Authoring%20Practices%20Guide&body=%5Bput%20comment%20here...%5D%0A%0A">[email protected]</a> or via GitHub.</p>
<div class="button-group">
<a href="mailto:[email protected]?subject=%5Ben%5D%20ARIA%20Authoring%20Practices%20Guide&body=%5Bput%20comment%20here...%5D%0A%0A" class="button"><span>E-mail</span></a><a href="
https://github.com/w3c/aria-practices/edit/main/content/apg-home.html
" class="button"><span>Fork & Edit on GitHub</span></a><a href="https://github.com/w3c/aria-practices/issues/new?template=content-issue.yml&wai-url=https://www.w3.org/WAI/ARIA/apg/" class="button"><span>New GitHub Issue</span></a></div></div></aside>
</div>
</div>
<a class="button button-backtotop" href="#top"><span><svg focusable="false" aria-hidden="true" class="icon-arrow-up "><use xlink:href="/WAI/assets/images/icons.svg#icon-arrow-up"></use></svg> Back to Top</span></a>
</div>
<footer class="site-footer grid-4q" aria-label="Site">
<div class="q1-start q3-end about">
<div>
<p><a class="largelink" href="https://www.w3.org/WAI/" lang="en" dir="auto" translate="no">W3C Web Accessibility Initiative (WAI)</a></p>
<p>Strategies, standards, and supporting resources to make the Web accessible to people with disabilities.</p>
</div>
<div class="social" lang="en" dir="auto" translate="no">
<ul>
<li><a href="https://w3c.social/@wai"><svg focusable="false" aria-hidden="true" class="icon-mastodon "><use xlink:href="/WAI/assets/images/icons.svg#icon-mastodon"></use></svg> Mastodon</a></li>
<li><a href="https://www.linkedin.com/company/w3c-wai/"><svg focusable="false" aria-hidden="true" class="icon-linkedin "><use xlink:href="/WAI/assets/images/icons.svg#icon-linkedin"></use></svg> LinkedIn</a></li>
<li><a href="https://www.w3.org/WAI/feed.xml"><svg focusable="false" aria-hidden="true" class="icon-rss "><use xlink:href="/WAI/assets/images/icons.svg#icon-rss"></use></svg> Feed</a></li>
<li><a href="https://www.youtube.com/channel/UCU6ljj3m1fglIPjSjs2DpRA/playlistsv"><svg focusable="false" aria-hidden="true" class="icon-youtube "><use xlink:href="/WAI/assets/images/icons.svg#icon-youtube"></use></svg> YouTube</a></li>
<li><a href="https://www.w3.org/WAI/news/subscribe/" class="button">Get News in Email</a></li>
</ul>
</div>
<div lang="en" dir="auto" translate="no">
<p>Copyright © 2024 World Wide Web Consortium (<a href="https://www.w3.org/">W3C</a><sup>®</sup>). See <a href="/WAI/about/using-wai-material/">Permission to Use WAI Material</a>.</p>
</div>
</div>
<div lang="en" dir="auto" translate="no" class="q4-start q4-end">
<ul style="margin-bottom:0">
<li><a href="/WAI/about/contacting/">Contact WAI</a></li>
<li><a href="/WAI/sitemap/">Site Map</a></li>
<li><a href="/WAI/news/">News</a></li>
<li><a href="/WAI/sitemap/#archive">Archive</a></li>
<li><a href="/WAI/about/accessibility-statement/">Accessibility Statement</a></li>
<li><a href="/WAI/translations/"> Translations</a></li>
<li><a href="/WAI/roles/">Resources for Roles</a></li>
</ul>
</div>
</footer><!-- Details4Everybody -->
<script src="/WAI/assets/scripts/details4everybody.js?1725379015012883017"></script>
<!-- SVG4Everybody -->
<script src="/WAI/assets/scripts/svg4everybody.js?1725379015012883017"></script>
<script>
svg4everybody();
</script><script>
var translationStrings = {};
</script>
</body>
</html>