Skip to content

Commit 4e1d1ec

Browse files
angular-robotpkozlowski-opensource
angular-robot
authored and
pkozlowski-opensource
committed
docs: update cross-repo adev docs
Updated Angular adev cross repo docs files.
1 parent 25bf417 commit 4e1d1ec

9 files changed

Lines changed: 27 additions & 72 deletions

File tree

‎adev/src/content/aria/_build-info.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
{
22
"branchName": "refs/heads/main",
3-
"sha": "476f7b12a420eab0ce5d9c0844478019fa24d0e2"
3+
"sha": "752d7f84ef97407acdf0a850971dd889f84708fb"
44
}

‎adev/src/content/aria/aria-accordion.json‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@
66
"entries": [
77
{
88
"name": "AccordionPanel",
9-
"aliases": ["ngAccordionPanel"],
109
"isAbstract": false,
1110
"entryType": "undecorated_class",
1211
"members": [
@@ -158,7 +157,6 @@
158157
},
159158
{
160159
"name": "AccordionTrigger",
161-
"aliases": ["ngAccordionTrigger"],
162160
"isAbstract": false,
163161
"entryType": "directive",
164162
"members": [
@@ -359,7 +357,6 @@
359357
},
360358
{
361359
"name": "AccordionGroup",
362-
"aliases": ["ngAccordionGroup"],
363360
"isAbstract": false,
364361
"entryType": "directive",
365362
"members": [
@@ -525,7 +522,6 @@
525522
},
526523
{
527524
"name": "AccordionContent",
528-
"aliases": ["ngAccordionContent"],
529525
"isAbstract": false,
530526
"entryType": "undecorated_class",
531527
"members": [],

‎adev/src/content/aria/aria-combobox.json‎

Lines changed: 15 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@
66
"entries": [
77
{
88
"name": "Combobox",
9-
"aliases": ["ngCombobox"],
109
"isAbstract": false,
1110
"entryType": "undecorated_class",
1211
"members": [
@@ -180,12 +179,8 @@
180179
"name": "V"
181180
}
182181
],
183-
"description": "The container element that wraps a combobox input and popup, and orchestrates its behavior.\n\nThe `ngCombobox` directive is the main entry point for creating a combobox and customizing its\nbehavior. It coordinates the interactions between the `ngComboboxInput` and the popup, which\nis defined by a `ng-template` with the `ngComboboxPopupContainer` directive. If using the\n`CdkOverlay`, the `cdkConnectedOverlay` directive takes the place of `ngComboboxPopupContainer`.\n\n```html\n<div ngCombobox filterMode=\"highlight\">\n <input\n ngComboboxInput\n placeholder=\"Search for a state...\"\n [(value)]=\"searchString\"\n />\n\n <ng-template ngComboboxPopupContainer>\n <div ngListbox [(value)]=\"selectedValue\">",
182+
"description": "The container element that wraps a combobox input and popup, and orchestrates its behavior.\n\nThe `ngCombobox` directive is the main entry point for creating a combobox and customizing its\nbehavior. It coordinates the interactions between the `ngComboboxInput` and the popup, which\nis defined by a `ng-template` with the `ngComboboxPopupContainer` directive. If using the\n`CdkOverlay`, the `cdkConnectedOverlay` directive takes the place of `ngComboboxPopupContainer`.\n\n```html\n<div ngCombobox filterMode=\"highlight\">\n <input\n ngComboboxInput\n placeholder=\"Search for a state...\"\n [(value)]=\"searchString\"\n />\n\n <ng-template ngComboboxPopupContainer>\n <div ngListbox [(value)]=\"selectedValue\">\n @for (option of filteredOptions(); track option) {\n <div ngOption [value]=\"option\" [label]=\"option\">\n <span>{{option}}</span>\n </div>\n }\n </div>\n </ng-template>\n</div>\n```",
184183
"jsdocTags": [
185-
{
186-
"name": "for",
187-
"comment": "(option of filteredOptions(); track option) {\n<div ngOption [value]=\"option\" [label]=\"option\">\n<span>{{option}}</span>\n</div>\n}\n</div>\n</ng-template>\n</div>\n```"
188-
},
189184
{
190185
"name": "developerPreview",
191186
"comment": "21.0"
@@ -195,13 +190,12 @@
195190
"implements": [],
196191
"source": {
197192
"filePath": "src/aria/combobox/combobox.ts",
198-
"startLine": 64,
199-
"endLine": 170
193+
"startLine": 65,
194+
"endLine": 176
200195
}
201196
},
202197
{
203198
"name": "ComboboxInput",
204-
"aliases": ["ngComboboxInput"],
205199
"isAbstract": false,
206200
"entryType": "directive",
207201
"members": [
@@ -257,13 +251,12 @@
257251
],
258252
"source": {
259253
"filePath": "src/aria/combobox/combobox.ts",
260-
"startLine": 190,
261-
"endLine": 236
254+
"startLine": 196,
255+
"endLine": 242
262256
}
263257
},
264258
{
265259
"name": "ComboboxPopupContainer",
266-
"aliases": ["ngComboboxPopupContainer"],
267260
"isAbstract": false,
268261
"entryType": "undecorated_class",
269262
"members": [],
@@ -279,13 +272,12 @@
279272
"implements": [],
280273
"source": {
281274
"filePath": "src/aria/combobox/combobox.ts",
282-
"startLine": 268,
283-
"endLine": 273
275+
"startLine": 274,
276+
"endLine": 279
284277
}
285278
},
286279
{
287280
"name": "ComboboxPopup",
288-
"aliases": ["ngComboboxPopup"],
289281
"isAbstract": false,
290282
"entryType": "directive",
291283
"members": [
@@ -321,13 +313,12 @@
321313
],
322314
"source": {
323315
"filePath": "src/aria/combobox/combobox.ts",
324-
"startLine": 285,
325-
"endLine": 300
316+
"startLine": 291,
317+
"endLine": 306
326318
}
327319
},
328320
{
329321
"name": "ComboboxDialog",
330-
"aliases": ["ngComboboxDialog"],
331322
"isAbstract": false,
332323
"entryType": "directive",
333324
"members": [
@@ -402,8 +393,8 @@
402393
],
403394
"source": {
404395
"filePath": "src/aria/combobox/combobox.ts",
405-
"startLine": 317,
406-
"endLine": 367
396+
"startLine": 323,
397+
"endLine": 373
407398
}
408399
}
409400
],
@@ -432,6 +423,10 @@
432423
"ElementRef",
433424
"@angular/core"
434425
],
426+
[
427+
"forwardRef",
428+
"@angular/core"
429+
],
435430
[
436431
"inject",
437432
"@angular/core"

‎adev/src/content/aria/aria-grid.json‎

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@
66
"entries": [
77
{
88
"name": "Grid",
9-
"aliases" : ["ngGrid"],
109
"isAbstract": false,
1110
"entryType": "directive",
1211
"members": [
@@ -149,16 +148,8 @@
149148
}
150149
],
151150
"generics": [],
152-
"description": "The container for a grid. It provides keyboard navigation and focus management for the grid's\nrows and cells. It manages the overall behavior of the grid, including focus\nwrapping, selection, and disabled states.\n\n```html\n<table ngGrid [multi]=\"true\" [enableSelection]=\"true\">",
151+
"description": "The container for a grid. It provides keyboard navigation and focus management for the grid's\nrows and cells. It manages the overall behavior of the grid, including focus\nwrapping, selection, and disabled states.\n\n```html\n<table ngGrid [multi]=\"true\" [enableSelection]=\"true\">\n @for (row of gridData; track row) {\n <tr ngGridRow>\n @for (cell of row; track cell) {\n <td ngGridCell [disabled]=\"cell.disabled\">\n {{cell.value}}\n </td>\n }\n </tr>\n }\n</table>\n```",
153152
"jsdocTags": [
154-
{
155-
"name": "for",
156-
"comment": "(row of gridData; track row) {\n<tr ngGridRow>"
157-
},
158-
{
159-
"name": "for",
160-
"comment": "(cell of row; track cell) {\n <td ngGridCell [disabled]=\"cell.disabled\">\n {{cell.value}}\n </td>\n}\n</tr>\n}\n</table>\n```"
161-
},
162153
{
163154
"name": "developerPreview",
164155
"comment": "21.0"
@@ -179,7 +170,6 @@
179170
},
180171
{
181172
"name": "GridRow",
182-
"aliases" : ["ngGridRow"],
183173
"isAbstract": false,
184174
"entryType": "directive",
185175
"members": [
@@ -230,7 +220,6 @@
230220
},
231221
{
232222
"name": "GridCell",
233-
"aliases" : ["ngGridCell"],
234223
"isAbstract": false,
235224
"entryType": "directive",
236225
"members": [
@@ -446,7 +435,6 @@
446435
},
447436
{
448437
"name": "GridCellWidget",
449-
"aliases" : ["ngGridCellWidget"],
450438
"isAbstract": false,
451439
"entryType": "directive",
452440
"members": [

‎adev/src/content/aria/aria-listbox.json‎

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@
66
"entries": [
77
{
88
"name": "Listbox",
9-
"aliases" : ["ngListbox"],
109
"isAbstract": false,
1110
"entryType": "undecorated_class",
1211
"members": [
@@ -218,12 +217,8 @@
218217
"name": "V"
219218
}
220219
],
221-
"description": "Represents a container used to display a list of items for a user to select from.\n\nThe `ngListbox` is meant to be used in conjunction with `ngOption` directives to create a\nselectable list. It supports single and multiple selection modes, as well as various focus and\norientation strategies.\n\n```html\n<ul ngListbox [(value)]=\"selectedItems\" [multi]=\"true\" orientation=\"vertical\">",
220+
"description": "Represents a container used to display a list of items for a user to select from.\n\nThe `ngListbox` is meant to be used in conjunction with `ngOption` directives to create a\nselectable list. It supports single and multiple selection modes, as well as various focus and\norientation strategies.\n\n```html\n<ul ngListbox [(value)]=\"selectedItems\" [multi]=\"true\" orientation=\"vertical\">\n @for (item of items; track item.id) {\n <li ngOption [value]=\"item.id\" [label]=\"item.name\" [disabled]=\"item.disabled\">\n {{item.name}}\n </li>\n }\n</ul>\n```",
222221
"jsdocTags": [
223-
{
224-
"name": "for",
225-
"comment": "(item of items; track item.id) {\n<li ngOption [value]=\"item.id\" [label]=\"item.name\" [disabled]=\"item.disabled\">\n{{item.name}}\n</li>\n}\n</ul>\n```"
226-
},
227222
{
228223
"name": "developerPreview",
229224
"comment": "21.0"
@@ -233,13 +228,12 @@
233228
"implements": [],
234229
"source": {
235230
"filePath": "/src/aria/listbox/listbox.ts",
236-
"startLine": 47,
237-
"endLine": 209
231+
"startLine": 48,
232+
"endLine": 216
238233
}
239234
},
240235
{
241236
"name": "Option",
242-
"aliases" : ["ngOption"],
243237
"isAbstract": false,
244238
"entryType": "directive",
245239
"members": [
@@ -352,8 +346,8 @@
352346
],
353347
"source": {
354348
"filePath": "/src/aria/listbox/listbox.ts",
355-
"startLine": 226,
356-
"endLine": 283
349+
"startLine": 233,
350+
"endLine": 290
357351
}
358352
}
359353
],
@@ -382,6 +376,10 @@
382376
"ElementRef",
383377
"@angular/core"
384378
],
379+
[
380+
"forwardRef",
381+
"@angular/core"
382+
],
385383
[
386384
"inject",
387385
"@angular/core"

‎adev/src/content/aria/aria-menu.json‎

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@
66
"entries": [
77
{
88
"name": "MenuTrigger",
9-
"aliases" : ["ngMenuTrigger"],
109
"isAbstract": false,
1110
"entryType": "directive",
1211
"members": [
@@ -182,7 +181,6 @@
182181
},
183182
{
184183
"name": "Menu",
185-
"aliases" : ["ngMenu"],
186184
"isAbstract": false,
187185
"entryType": "undecorated_class",
188186
"members": [
@@ -350,7 +348,6 @@
350348
},
351349
{
352350
"name": "MenuBar",
353-
"aliases" : ["ngMenuBar"],
354351
"isAbstract": false,
355352
"entryType": "directive",
356353
"members": [
@@ -513,7 +510,6 @@
513510
},
514511
{
515512
"name": "MenuItem",
516-
"aliases" : ["ngMenuItem"],
517513
"isAbstract": false,
518514
"entryType": "directive",
519515
"members": [
@@ -728,7 +724,6 @@
728724
},
729725
{
730726
"name": "MenuContent",
731-
"aliases" : ["ngMenuContent"],
732727
"isAbstract": false,
733728
"entryType": "undecorated_class",
734729
"members": [],

‎adev/src/content/aria/aria-tabs.json‎

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@
66
"entries": [
77
{
88
"name": "Tabs",
9-
"aliases" : ["ngTabs"],
109
"isAbstract": false,
1110
"entryType": "directive",
1211
"members": [
@@ -44,7 +43,6 @@
4443
},
4544
{
4645
"name": "TabList",
47-
"aliases" : ["ngTabList"],
4846
"isAbstract": false,
4947
"entryType": "directive",
5048
"members": [
@@ -303,7 +301,6 @@
303301
},
304302
{
305303
"name": "Tab",
306-
"aliases" : ["ngTab"],
307304
"isAbstract": false,
308305
"entryType": "directive",
309306
"members": [
@@ -503,7 +500,6 @@
503500
},
504501
{
505502
"name": "TabPanel",
506-
"aliases" : ["ngTabPanel"],
507503
"isAbstract": false,
508504
"entryType": "undecorated_class",
509505
"members": [
@@ -635,7 +631,6 @@
635631
},
636632
{
637633
"name": "TabContent",
638-
"aliases" : ["ngTabContent"],
639634
"isAbstract": false,
640635
"entryType": "undecorated_class",
641636
"members": [],

‎adev/src/content/aria/aria-toolbar.json‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@
66
"entries": [
77
{
88
"name": "Toolbar",
9-
"aliases" : ["ngToolbar"],
109
"isAbstract": false,
1110
"entryType": "directive",
1211
"members": [
@@ -124,7 +123,6 @@
124123
},
125124
{
126125
"name": "ToolbarWidget",
127-
"aliases" : ["ngToolbarWidget"],
128126
"isAbstract": false,
129127
"entryType": "directive",
130128
"members": [
@@ -304,7 +302,6 @@
304302
},
305303
{
306304
"name": "ToolbarWidgetGroup",
307-
"aliases" : ["ngToolbarWidgetGroup"],
308305
"isAbstract": false,
309306
"entryType": "directive",
310307
"members": [

‎adev/src/content/aria/aria-tree.json‎

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -204,16 +204,8 @@
204204
"name": "V"
205205
}
206206
],
207-
"description": "A container that transforms nested lists into an accessible, ARIA-compliant tree structure.\nIt manages the overall state of the tree, including selection, expansion, and keyboard\nnavigation.\n\n```html\n<ul ngTree [(value)]=\"selectedItems\" [multi]=\"true\">\n <ng-template\n [ngTemplateOutlet]=\"treeNodes\"\n [ngTemplateOutletContext]=\"{nodes: treeData, parent: tree}\"\n />\n</ul>\n\n<ng-template #treeNodes let-nodes=\"nodes\" let-parent=\"parent\">",
207+
"description": "A container that transforms nested lists into an accessible, ARIA-compliant tree structure.\nIt manages the overall state of the tree, including selection, expansion, and keyboard\nnavigation.\n\n```html\n<ul ngTree [(value)]=\"selectedItems\" [multi]=\"true\">\n <ng-template\n [ngTemplateOutlet]=\"treeNodes\"\n [ngTemplateOutletContext]=\"{nodes: treeData, parent: tree}\"\n />\n</ul>\n\n<ng-template #treeNodes let-nodes=\"nodes\" let-parent=\"parent\">\n @for (node of nodes; track node.name) {\n <li ngTreeItem [parent]=\"parent\" [value]=\"node.name\" [label]=\"node.name\">\n {{ node.name }}\n @if (node.children) {\n <ul role=\"group\">\n <ng-template ngTreeItemGroup [ownedBy]=\"treeItem\" #group=\"ngTreeItemGroup\">\n <ng-template\n [ngTemplateOutlet]=\"treeNodes\"\n [ngTemplateOutletContext]=\"{nodes: node.children, parent: group}\"\n />\n </ng-template>\n </ul>\n }\n </li>\n }\n</ng-template>\n```",
208208
"jsdocTags": [
209-
{
210-
"name": "for",
211-
"comment": "(node of nodes; track node.name) {\n<li ngTreeItem [parent]=\"parent\" [value]=\"node.name\" [label]=\"node.name\">\n{{ node.name }}"
212-
},
213-
{
214-
"name": "if",
215-
"comment": "(node.children) {\n <ul role=\"group\">\n <ng-template ngTreeItemGroup [ownedBy]=\"treeItem\" #group=\"ngTreeItemGroup\">\n <ng-template\n [ngTemplateOutlet]=\"treeNodes\"\n [ngTemplateOutletContext]=\"{nodes: node.children, parent: group}\"\n />\n </ng-template>\n </ul>\n}\n</li>\n}\n</ng-template>\n```"
216-
},
217209
{
218210
"name": "developerPreview",
219211
"comment": "21.0"
@@ -229,7 +221,6 @@
229221
},
230222
{
231223
"name": "TreeItem",
232-
"aliases" : ["ngTreeItem"],
233224
"isAbstract": false,
234225
"entryType": "directive",
235226
"members": [

0 commit comments

Comments
 (0)