Skip to content

Commit 284ddf5

Browse files
committed
chore(aria): add required 'value' to ngMenuItem jsdocs
The `value` is a required input. Without it, `menu.ts` will say "Required input 'value' from directive MenuItem must be specified.
1 parent 2c0ba8d commit 284ddf5

1 file changed

Lines changed: 15 additions & 15 deletions

File tree

src/aria/menu/menu.ts

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,8 @@ import {Directionality} from '@angular/cdk/bidi';
4545
* <button ngMenuTrigger [menu]="myMenu">Open Menu</button>
4646
*
4747
* <div ngMenu #myMenu="ngMenu">
48-
* <div ngMenuItem>Item 1</div>
49-
* <div ngMenuItem>Item 2</div>
48+
* <div ngMenuItem value="Item 1">Item 1</div>
49+
* <div ngMenuItem value="Item 2">Item 2</div>
5050
* </div>
5151
* ```
5252
*
@@ -127,14 +127,14 @@ export class MenuTrigger<V> {
127127
* <button ngMenuTrigger [menu]="myMenu">Options</button>
128128
*
129129
* <div ngMenu #myMenu="ngMenu">
130-
* <div ngMenuItem>Star</div>
131-
* <div ngMenuItem>Edit</div>
132-
* <div ngMenuItem [submenu]="subMenu">More</div>
130+
* <div ngMenuItem value="Star">Star</div>
131+
* <div ngMenuItem value="Edit">Edit</div>
132+
* <div ngMenuItem value="More" [submenu]="subMenu">More</div>
133133
* </div>
134134
*
135135
* <div ngMenu #subMenu="ngMenu">
136-
* <div ngMenuItem>Sub Item 1</div>
137-
* <div ngMenuItem>Sub Item 2</div>
136+
* <div ngMenuItem value="Sub Item 1">Sub Item 1</div>
137+
* <div ngMenuItem value="Sub Item 2">Sub Item 2</div>
138138
* </div>
139139
* ```
140140
*
@@ -287,13 +287,13 @@ export class Menu<V> {
287287
* </div>
288288
*
289289
* <div ngMenu #fileMenu="ngMenu">
290-
* <div ngMenuItem>New</div>
291-
* <div ngMenuItem>Open</div>
290+
* <div ngMenuItem value="New">New</div>
291+
* <div ngMenuItem value="Open">Open</div>
292292
* </div>
293293
*
294294
* <div ngMenu #editMenu="ngMenu">
295-
* <div ngMenuItem>Cut</div>
296-
* <div ngMenuItem>Copy</div>
295+
* <div ngMenuItem value="Cut">Cut</div>
296+
* <div ngMenuItem value="Copy">Copy</div>
297297
* </div>
298298
* ```
299299
*
@@ -392,9 +392,9 @@ export class MenuBar<V> {
392392
* or action a user can take. They can also act as triggers for sub-menus.
393393
*
394394
* ```html
395-
* <div ngMenuItem (onSelect)="doAction()">Action Item</div>
395+
* <div ngMenuItem value="Action Item" (onSelect)="doAction()">Action Item</div>
396396
*
397-
* <div ngMenuItem [submenu]="anotherMenu">Submenu Trigger</div>
397+
* <div ngMenuItem value="Submenu Trigger" [submenu]="anotherMenu">Submenu Trigger</div>
398398
* ```
399399
*
400400
* @developerPreview 21.0
@@ -490,8 +490,8 @@ export class MenuItem<V> {
490490
* ```html
491491
* <div ngMenu #myMenu="ngMenu">
492492
* <ng-template ngMenuContent>
493-
* <div ngMenuItem>Lazy Item 1</div>
494-
* <div ngMenuItem>Lazy Item 2</div>
493+
* <div ngMenuItem value="Lazy Item 1">Lazy Item 1</div>
494+
* <div ngMenuItem value="Lazy Item 2">Lazy Item 2</div>
495495
* </ng-template>
496496
* </div>
497497
* ```

0 commit comments

Comments
 (0)