mirror of
https://github.com/angular/angular
synced 2026-05-24 09:28:37 +00:00
docs: update cross-repo adev docs
Updated Angular adev cross repo docs files.
This commit is contained in:
Angular Robot
Pawel Kozlowski
parent
25bf417d57
commit
4e1d1ec85c
9 changed files with 27 additions and 72 deletions
|
|
@ -1,4 +1,4 @@
|
|||
{
|
||||
"branchName": "refs/heads/main",
|
||||
"sha": "476f7b12a420eab0ce5d9c0844478019fa24d0e2"
|
||||
"sha": "752d7f84ef97407acdf0a850971dd889f84708fb"
|
||||
}
|
||||
|
|
@ -6,7 +6,6 @@
|
|||
"entries": [
|
||||
{
|
||||
"name": "AccordionPanel",
|
||||
"aliases": ["ngAccordionPanel"],
|
||||
"isAbstract": false,
|
||||
"entryType": "undecorated_class",
|
||||
"members": [
|
||||
|
|
@ -158,7 +157,6 @@
|
|||
},
|
||||
{
|
||||
"name": "AccordionTrigger",
|
||||
"aliases": ["ngAccordionTrigger"],
|
||||
"isAbstract": false,
|
||||
"entryType": "directive",
|
||||
"members": [
|
||||
|
|
@ -359,7 +357,6 @@
|
|||
},
|
||||
{
|
||||
"name": "AccordionGroup",
|
||||
"aliases": ["ngAccordionGroup"],
|
||||
"isAbstract": false,
|
||||
"entryType": "directive",
|
||||
"members": [
|
||||
|
|
@ -525,7 +522,6 @@
|
|||
},
|
||||
{
|
||||
"name": "AccordionContent",
|
||||
"aliases": ["ngAccordionContent"],
|
||||
"isAbstract": false,
|
||||
"entryType": "undecorated_class",
|
||||
"members": [],
|
||||
|
|
|
|||
|
|
@ -6,7 +6,6 @@
|
|||
"entries": [
|
||||
{
|
||||
"name": "Combobox",
|
||||
"aliases": ["ngCombobox"],
|
||||
"isAbstract": false,
|
||||
"entryType": "undecorated_class",
|
||||
"members": [
|
||||
|
|
@ -180,12 +179,8 @@
|
|||
"name": "V"
|
||||
}
|
||||
],
|
||||
"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\">",
|
||||
"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```",
|
||||
"jsdocTags": [
|
||||
{
|
||||
"name": "for",
|
||||
"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```"
|
||||
},
|
||||
{
|
||||
"name": "developerPreview",
|
||||
"comment": "21.0"
|
||||
|
|
@ -195,13 +190,12 @@
|
|||
"implements": [],
|
||||
"source": {
|
||||
"filePath": "src/aria/combobox/combobox.ts",
|
||||
"startLine": 64,
|
||||
"endLine": 170
|
||||
"startLine": 65,
|
||||
"endLine": 176
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "ComboboxInput",
|
||||
"aliases": ["ngComboboxInput"],
|
||||
"isAbstract": false,
|
||||
"entryType": "directive",
|
||||
"members": [
|
||||
|
|
@ -257,13 +251,12 @@
|
|||
],
|
||||
"source": {
|
||||
"filePath": "src/aria/combobox/combobox.ts",
|
||||
"startLine": 190,
|
||||
"endLine": 236
|
||||
"startLine": 196,
|
||||
"endLine": 242
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "ComboboxPopupContainer",
|
||||
"aliases": ["ngComboboxPopupContainer"],
|
||||
"isAbstract": false,
|
||||
"entryType": "undecorated_class",
|
||||
"members": [],
|
||||
|
|
@ -279,13 +272,12 @@
|
|||
"implements": [],
|
||||
"source": {
|
||||
"filePath": "src/aria/combobox/combobox.ts",
|
||||
"startLine": 268,
|
||||
"endLine": 273
|
||||
"startLine": 274,
|
||||
"endLine": 279
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "ComboboxPopup",
|
||||
"aliases": ["ngComboboxPopup"],
|
||||
"isAbstract": false,
|
||||
"entryType": "directive",
|
||||
"members": [
|
||||
|
|
@ -321,13 +313,12 @@
|
|||
],
|
||||
"source": {
|
||||
"filePath": "src/aria/combobox/combobox.ts",
|
||||
"startLine": 285,
|
||||
"endLine": 300
|
||||
"startLine": 291,
|
||||
"endLine": 306
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "ComboboxDialog",
|
||||
"aliases": ["ngComboboxDialog"],
|
||||
"isAbstract": false,
|
||||
"entryType": "directive",
|
||||
"members": [
|
||||
|
|
@ -402,8 +393,8 @@
|
|||
],
|
||||
"source": {
|
||||
"filePath": "src/aria/combobox/combobox.ts",
|
||||
"startLine": 317,
|
||||
"endLine": 367
|
||||
"startLine": 323,
|
||||
"endLine": 373
|
||||
}
|
||||
}
|
||||
],
|
||||
|
|
@ -432,6 +423,10 @@
|
|||
"ElementRef",
|
||||
"@angular/core"
|
||||
],
|
||||
[
|
||||
"forwardRef",
|
||||
"@angular/core"
|
||||
],
|
||||
[
|
||||
"inject",
|
||||
"@angular/core"
|
||||
|
|
|
|||
|
|
@ -6,7 +6,6 @@
|
|||
"entries": [
|
||||
{
|
||||
"name": "Grid",
|
||||
"aliases" : ["ngGrid"],
|
||||
"isAbstract": false,
|
||||
"entryType": "directive",
|
||||
"members": [
|
||||
|
|
@ -149,16 +148,8 @@
|
|||
}
|
||||
],
|
||||
"generics": [],
|
||||
"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\">",
|
||||
"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```",
|
||||
"jsdocTags": [
|
||||
{
|
||||
"name": "for",
|
||||
"comment": "(row of gridData; track row) {\n<tr ngGridRow>"
|
||||
},
|
||||
{
|
||||
"name": "for",
|
||||
"comment": "(cell of row; track cell) {\n <td ngGridCell [disabled]=\"cell.disabled\">\n {{cell.value}}\n </td>\n}\n</tr>\n}\n</table>\n```"
|
||||
},
|
||||
{
|
||||
"name": "developerPreview",
|
||||
"comment": "21.0"
|
||||
|
|
@ -179,7 +170,6 @@
|
|||
},
|
||||
{
|
||||
"name": "GridRow",
|
||||
"aliases" : ["ngGridRow"],
|
||||
"isAbstract": false,
|
||||
"entryType": "directive",
|
||||
"members": [
|
||||
|
|
@ -230,7 +220,6 @@
|
|||
},
|
||||
{
|
||||
"name": "GridCell",
|
||||
"aliases" : ["ngGridCell"],
|
||||
"isAbstract": false,
|
||||
"entryType": "directive",
|
||||
"members": [
|
||||
|
|
@ -446,7 +435,6 @@
|
|||
},
|
||||
{
|
||||
"name": "GridCellWidget",
|
||||
"aliases" : ["ngGridCellWidget"],
|
||||
"isAbstract": false,
|
||||
"entryType": "directive",
|
||||
"members": [
|
||||
|
|
|
|||
|
|
@ -6,7 +6,6 @@
|
|||
"entries": [
|
||||
{
|
||||
"name": "Listbox",
|
||||
"aliases" : ["ngListbox"],
|
||||
"isAbstract": false,
|
||||
"entryType": "undecorated_class",
|
||||
"members": [
|
||||
|
|
@ -218,12 +217,8 @@
|
|||
"name": "V"
|
||||
}
|
||||
],
|
||||
"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\">",
|
||||
"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```",
|
||||
"jsdocTags": [
|
||||
{
|
||||
"name": "for",
|
||||
"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```"
|
||||
},
|
||||
{
|
||||
"name": "developerPreview",
|
||||
"comment": "21.0"
|
||||
|
|
@ -233,13 +228,12 @@
|
|||
"implements": [],
|
||||
"source": {
|
||||
"filePath": "/src/aria/listbox/listbox.ts",
|
||||
"startLine": 47,
|
||||
"endLine": 209
|
||||
"startLine": 48,
|
||||
"endLine": 216
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "Option",
|
||||
"aliases" : ["ngOption"],
|
||||
"isAbstract": false,
|
||||
"entryType": "directive",
|
||||
"members": [
|
||||
|
|
@ -352,8 +346,8 @@
|
|||
],
|
||||
"source": {
|
||||
"filePath": "/src/aria/listbox/listbox.ts",
|
||||
"startLine": 226,
|
||||
"endLine": 283
|
||||
"startLine": 233,
|
||||
"endLine": 290
|
||||
}
|
||||
}
|
||||
],
|
||||
|
|
@ -382,6 +376,10 @@
|
|||
"ElementRef",
|
||||
"@angular/core"
|
||||
],
|
||||
[
|
||||
"forwardRef",
|
||||
"@angular/core"
|
||||
],
|
||||
[
|
||||
"inject",
|
||||
"@angular/core"
|
||||
|
|
|
|||
|
|
@ -6,7 +6,6 @@
|
|||
"entries": [
|
||||
{
|
||||
"name": "MenuTrigger",
|
||||
"aliases" : ["ngMenuTrigger"],
|
||||
"isAbstract": false,
|
||||
"entryType": "directive",
|
||||
"members": [
|
||||
|
|
@ -182,7 +181,6 @@
|
|||
},
|
||||
{
|
||||
"name": "Menu",
|
||||
"aliases" : ["ngMenu"],
|
||||
"isAbstract": false,
|
||||
"entryType": "undecorated_class",
|
||||
"members": [
|
||||
|
|
@ -350,7 +348,6 @@
|
|||
},
|
||||
{
|
||||
"name": "MenuBar",
|
||||
"aliases" : ["ngMenuBar"],
|
||||
"isAbstract": false,
|
||||
"entryType": "directive",
|
||||
"members": [
|
||||
|
|
@ -513,7 +510,6 @@
|
|||
},
|
||||
{
|
||||
"name": "MenuItem",
|
||||
"aliases" : ["ngMenuItem"],
|
||||
"isAbstract": false,
|
||||
"entryType": "directive",
|
||||
"members": [
|
||||
|
|
@ -728,7 +724,6 @@
|
|||
},
|
||||
{
|
||||
"name": "MenuContent",
|
||||
"aliases" : ["ngMenuContent"],
|
||||
"isAbstract": false,
|
||||
"entryType": "undecorated_class",
|
||||
"members": [],
|
||||
|
|
|
|||
|
|
@ -6,7 +6,6 @@
|
|||
"entries": [
|
||||
{
|
||||
"name": "Tabs",
|
||||
"aliases" : ["ngTabs"],
|
||||
"isAbstract": false,
|
||||
"entryType": "directive",
|
||||
"members": [
|
||||
|
|
@ -44,7 +43,6 @@
|
|||
},
|
||||
{
|
||||
"name": "TabList",
|
||||
"aliases" : ["ngTabList"],
|
||||
"isAbstract": false,
|
||||
"entryType": "directive",
|
||||
"members": [
|
||||
|
|
@ -303,7 +301,6 @@
|
|||
},
|
||||
{
|
||||
"name": "Tab",
|
||||
"aliases" : ["ngTab"],
|
||||
"isAbstract": false,
|
||||
"entryType": "directive",
|
||||
"members": [
|
||||
|
|
@ -503,7 +500,6 @@
|
|||
},
|
||||
{
|
||||
"name": "TabPanel",
|
||||
"aliases" : ["ngTabPanel"],
|
||||
"isAbstract": false,
|
||||
"entryType": "undecorated_class",
|
||||
"members": [
|
||||
|
|
@ -635,7 +631,6 @@
|
|||
},
|
||||
{
|
||||
"name": "TabContent",
|
||||
"aliases" : ["ngTabContent"],
|
||||
"isAbstract": false,
|
||||
"entryType": "undecorated_class",
|
||||
"members": [],
|
||||
|
|
|
|||
|
|
@ -6,7 +6,6 @@
|
|||
"entries": [
|
||||
{
|
||||
"name": "Toolbar",
|
||||
"aliases" : ["ngToolbar"],
|
||||
"isAbstract": false,
|
||||
"entryType": "directive",
|
||||
"members": [
|
||||
|
|
@ -124,7 +123,6 @@
|
|||
},
|
||||
{
|
||||
"name": "ToolbarWidget",
|
||||
"aliases" : ["ngToolbarWidget"],
|
||||
"isAbstract": false,
|
||||
"entryType": "directive",
|
||||
"members": [
|
||||
|
|
@ -304,7 +302,6 @@
|
|||
},
|
||||
{
|
||||
"name": "ToolbarWidgetGroup",
|
||||
"aliases" : ["ngToolbarWidgetGroup"],
|
||||
"isAbstract": false,
|
||||
"entryType": "directive",
|
||||
"members": [
|
||||
|
|
|
|||
|
|
@ -204,16 +204,8 @@
|
|||
"name": "V"
|
||||
}
|
||||
],
|
||||
"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\">",
|
||||
"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```",
|
||||
"jsdocTags": [
|
||||
{
|
||||
"name": "for",
|
||||
"comment": "(node of nodes; track node.name) {\n<li ngTreeItem [parent]=\"parent\" [value]=\"node.name\" [label]=\"node.name\">\n{{ node.name }}"
|
||||
},
|
||||
{
|
||||
"name": "if",
|
||||
"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```"
|
||||
},
|
||||
{
|
||||
"name": "developerPreview",
|
||||
"comment": "21.0"
|
||||
|
|
@ -229,7 +221,6 @@
|
|||
},
|
||||
{
|
||||
"name": "TreeItem",
|
||||
"aliases" : ["ngTreeItem"],
|
||||
"isAbstract": false,
|
||||
"entryType": "directive",
|
||||
"members": [
|
||||
|
|
|
|||
Loading…
Reference in a new issue