Skip to content

Commit 4103302

Browse files
committed
main - 204b289 fix(material/list): update documentation (#30883)
1 parent 7e0ccf5 commit 4103302

File tree

2 files changed

+34
-8
lines changed

2 files changed

+34
-8
lines changed

docs-content/overviews/material/list/list.md.html

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -255,6 +255,32 @@ <h4 id="navigation" class="docs-header-link">
255255
anchors, including buttons and checkboxes.</p>
256256
<p>Always provide an accessible label for the <code>&lt;mat-nav-list&gt;</code> element via <code>aria-label</code> or
257257
<code>aria-labelledby</code>.</p>
258+
<p>To provide the best screen reader experience for a list, wrap each anchor element with a <code>&lt;li&gt;</code> or <code>&lt;div role=&quot;listitem&quot;&gt;</code> element and wrap all of the anchor elements with a <code>&lt;ul&gt;</code> element or <code>&lt;div role=&quot;list&quot;&gt;</code> element.</p>
259+
<pre><code class="language-html"><span class="hljs-tag">&lt;<span class="hljs-name">mat-nav-list</span> <span class="hljs-attr">aria-label</span>=<span class="hljs-string">&quot;Select a folder&quot;</span>&gt;</span>
260+
<span class="hljs-tag">&lt;<span class="hljs-name">ul</span>&gt;</span>
261+
@for (link of list; track link) {
262+
<span class="hljs-tag">&lt;<span class="hljs-name">li</span>&gt;</span>
263+
<span class="hljs-tag">&lt;<span class="hljs-name">a</span> <span class="hljs-attr">mat-list-item</span> <span class="hljs-attr">href</span>=<span class="hljs-string">&quot;...&quot;</span> [<span class="hljs-attr">activated</span>]=<span class="hljs-string">&quot;link.isActive&quot;</span>&gt;</span>{{ link }}<span class="hljs-tag">&lt;/<span class="hljs-name">a</span>&gt;</span>
264+
<span class="hljs-tag">&lt;/<span class="hljs-name">li</span>&gt;</span>
265+
}
266+
<span class="hljs-tag">&lt;/<span class="hljs-name">ul</span>&gt;</span>
267+
<span class="hljs-tag">&lt;/<span class="hljs-name">mat-nav-list</span>&gt;</span>
268+
</code></pre>
269+
270+
<h4 id="action" class="docs-header-link">
271+
<span header-link="action"></span>
272+
Action
273+
</h4>
274+
<p>To provide the best screen reader experience for a list, wrap each button element with a <code>&lt;li&gt;</code> or <code>&lt;div role=&quot;listitem&quot;&gt;</code> element and add <code>role=&quot;list&quot;</code> to <code>&lt;mat-action-list&gt;</code>.</p>
275+
<pre><code class="language-html"><span class="hljs-tag">&lt;<span class="hljs-name">mat-action-list</span> <span class="hljs-attr">role</span>=<span class="hljs-string">&quot;list&quot;</span> <span class="hljs-attr">aria-label</span>=<span class="hljs-string">&quot;Post actions&quot;</span>&gt;</span>
276+
<span class="hljs-tag">&lt;<span class="hljs-name">li</span>&gt;</span>
277+
<span class="hljs-tag">&lt;<span class="hljs-name">button</span> <span class="hljs-attr">mat-list-item</span> (<span class="hljs-attr">click</span>)=<span class="hljs-string">&quot;save()&quot;</span>&gt;</span>Save<span class="hljs-tag">&lt;/<span class="hljs-name">button</span>&gt;</span>
278+
<span class="hljs-tag">&lt;/<span class="hljs-name">li</span>&gt;</span>
279+
<span class="hljs-tag">&lt;<span class="hljs-name">li</span>&gt;</span>
280+
<span class="hljs-tag">&lt;<span class="hljs-name">button</span> <span class="hljs-attr">mat-list-item</span> (<span class="hljs-attr">click</span>)=<span class="hljs-string">&quot;undo()&quot;</span>&gt;</span>Undo<span class="hljs-tag">&lt;/<span class="hljs-name">button</span>&gt;</span>
281+
<span class="hljs-tag">&lt;/<span class="hljs-name">li</span>&gt;</span>
282+
<span class="hljs-tag">&lt;/<span class="hljs-name">mat-action-list</span>&gt;</span>
283+
</code></pre>
258284

259285
<h4 id="selection" class="docs-header-link">
260286
<span header-link="selection"></span>

package.json

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@angular/components-examples",
3-
"version": "20.0.0-next.7+sha-a2ab84d",
3+
"version": "20.0.0-next.7+sha-204b289",
44
"description": "Angular Components Examples",
55
"private": true,
66
"repository": {
@@ -259,15 +259,15 @@
259259
},
260260
"homepage": "https://github.com/angular/components#readme",
261261
"peerDependencies": {
262-
"@angular/cdk": "20.0.0-next.7+sha-a2ab84d",
263-
"@angular/cdk-experimental": "20.0.0-next.7+sha-a2ab84d",
262+
"@angular/cdk": "20.0.0-next.7+sha-204b289",
263+
"@angular/cdk-experimental": "20.0.0-next.7+sha-204b289",
264264
"@angular/core": "^20.0.0-0 || ^20.1.0-0 || ^20.2.0-0 || ^20.3.0-0 || ^21.0.0-0",
265265
"@angular/common": "^20.0.0-0 || ^20.1.0-0 || ^20.2.0-0 || ^20.3.0-0 || ^21.0.0-0",
266-
"@angular/material": "20.0.0-next.7+sha-a2ab84d",
267-
"@angular/material-experimental": "20.0.0-next.7+sha-a2ab84d",
268-
"@angular/material-moment-adapter": "20.0.0-next.7+sha-a2ab84d",
269-
"@angular/material-luxon-adapter": "20.0.0-next.7+sha-a2ab84d",
270-
"@angular/material-date-fns-adapter": "20.0.0-next.7+sha-a2ab84d"
266+
"@angular/material": "20.0.0-next.7+sha-204b289",
267+
"@angular/material-experimental": "20.0.0-next.7+sha-204b289",
268+
"@angular/material-moment-adapter": "20.0.0-next.7+sha-204b289",
269+
"@angular/material-luxon-adapter": "20.0.0-next.7+sha-204b289",
270+
"@angular/material-date-fns-adapter": "20.0.0-next.7+sha-204b289"
271271
},
272272
"devDependencies": {
273273
"@angular/cdk": "workspace:*",

0 commit comments

Comments
 (0)