docs: update Angular Aria apis (#64782)

Updated Angular Aria api files.

PR Close #64782
This commit is contained in:
Angular Robot
2025-10-30 17:50:28 +00:00
committed by Andrew Scott
parent 56f26f1ada
commit 29d6ebafe5
8 changed files with 50 additions and 422 deletions
+2 -2
View File
@@ -1,4 +1,4 @@
{
"branchName": "refs/heads/main",
"sha": "c0d537196a6b7b3395f86122a4e998b0e4e73290"
}
"sha": "ba8a952371e721141d4a2f9f0ca5529b4dff8817"
}
+4 -4
View File
@@ -159,15 +159,15 @@
"outputAlias": "valueChange"
},
{
"name": "skipDisabled",
"name": "softDisabled",
"type": "any",
"memberType": "property",
"memberTags": [
"input"
],
"description": "Whether disabled items should be skipped during keyboard navigation.",
"description": "Whether to allow disabled items to receive focus.",
"jsdocTags": [],
"inputAlias": "skipDisabled",
"inputAlias": "softDisabled",
"isRequiredInput": false
},
{
@@ -358,7 +358,7 @@
"@angular/aria/accordion"
],
[
"AccordionGroup.skipDisabled",
"AccordionGroup.softDisabled",
"@angular/aria/accordion"
],
[
+30 -12
View File
@@ -9,6 +9,16 @@
"isAbstract": false,
"entryType": "directive",
"members": [
{
"name": "textDirection",
"type": "any",
"memberType": "property",
"memberTags": [
"readonly"
],
"description": "Text direction.",
"jsdocTags": []
},
{
"name": "element",
"type": "any",
@@ -46,16 +56,16 @@
"isRequiredInput": false
},
{
"name": "skipDisabled",
"name": "softDisabled",
"type": "any",
"memberType": "property",
"memberTags": [
"readonly",
"input"
],
"description": "Whether to skip disabled items during navigation.",
"description": "Whether to allow disabled items to receive focus.",
"jsdocTags": [],
"inputAlias": "skipDisabled",
"inputAlias": "softDisabled",
"isRequiredInput": false
},
{
@@ -110,8 +120,8 @@
],
"source": {
"filePath": "src/aria/grid/grid.ts",
"startLine": 26,
"endLine": 106
"startLine": 27,
"endLine": 110
}
},
{
@@ -178,8 +188,8 @@
],
"source": {
"filePath": "src/aria/grid/grid.ts",
"startLine": 109,
"endLine": 149
"startLine": 113,
"endLine": 153
}
},
{
@@ -316,8 +326,8 @@
],
"source": {
"filePath": "src/aria/grid/grid.ts",
"startLine": 152,
"endLine": 224
"startLine": 156,
"endLine": 228
}
},
{
@@ -396,8 +406,8 @@
],
"source": {
"filePath": "src/aria/grid/grid.ts",
"startLine": 227,
"endLine": 259
"startLine": 231,
"endLine": 263
}
}
],
@@ -450,6 +460,10 @@
"Signal",
"@angular/core"
],
[
"Directionality",
"@angular/cdk/bidi"
],
[
"Grid",
"@angular/aria/grid"
@@ -470,6 +484,10 @@
"Grid",
"@angular/aria/grid"
],
[
"Grid.textDirection",
"@angular/aria/grid"
],
[
"Grid.element",
"@angular/aria/grid"
@@ -483,7 +501,7 @@
"@angular/aria/grid"
],
[
"Grid.skipDisabled",
"Grid.softDisabled",
"@angular/aria/grid"
],
[
+3 -3
View File
@@ -64,11 +64,11 @@
"jsdocTags": []
},
{
"name": "skipDisabled",
"name": "softDisabled",
"type": "any",
"memberType": "property",
"memberTags": [],
"description": "Whether disabled items in the list should be skipped when navigating.",
"description": "Whether to allow disabled items in the list to receive focus.",
"jsdocTags": []
},
{
@@ -436,7 +436,7 @@
"@angular/aria/listbox"
],
[
"Listbox.skipDisabled",
"Listbox.softDisabled",
"@angular/aria/listbox"
],
[
-389
View File
@@ -1,389 +0,0 @@
{
"repo": "angular/components",
"moduleLabel": "@angular/aria/radio-group",
"moduleName": "@angular/aria/radio-group",
"normalizedModuleName": "angular_aria_radio-group",
"entries": [
{
"name": "RadioGroup",
"isAbstract": false,
"entryType": "undecorated_class",
"members": [
{
"name": "textDirection",
"type": "any",
"memberType": "property",
"memberTags": [
"protected"
],
"description": "A signal wrapper for directionality.",
"jsdocTags": []
},
{
"name": "items",
"type": "any",
"memberType": "property",
"memberTags": [
"protected"
],
"description": "The RadioButton UIPatterns of the child RadioButtons.",
"jsdocTags": []
},
{
"name": "orientation",
"type": "any",
"memberType": "property",
"memberTags": [
"readonly"
],
"description": "Whether the radio group is vertically or horizontally oriented.",
"jsdocTags": []
},
{
"name": "skipDisabled",
"type": "any",
"memberType": "property",
"memberTags": [
"readonly"
],
"description": "Whether disabled items in the group should be skipped when navigating.",
"jsdocTags": []
},
{
"name": "focusMode",
"type": "any",
"memberType": "property",
"memberTags": [
"readonly"
],
"description": "The focus strategy used by the radio group.",
"jsdocTags": []
},
{
"name": "disabled",
"type": "any",
"memberType": "property",
"memberTags": [
"readonly"
],
"description": "Whether the radio group is disabled.",
"jsdocTags": []
},
{
"name": "readonly",
"type": "any",
"memberType": "property",
"memberTags": [
"readonly"
],
"description": "Whether the radio group is readonly.",
"jsdocTags": []
},
{
"name": "value",
"type": "any",
"memberType": "property",
"memberTags": [
"readonly"
],
"description": "The value of the currently selected radio button.",
"jsdocTags": []
},
{
"name": "onFocus",
"signatures": [
{
"name": "onFocus",
"entryType": "function",
"description": "",
"generics": [],
"isNewType": false,
"jsdocTags": [],
"params": [],
"rawComment": "",
"returnType": "void"
}
],
"implementation": {
"params": [],
"isNewType": false,
"returnType": "void",
"generics": [],
"name": "onFocus",
"description": "",
"entryType": "function",
"jsdocTags": [],
"rawComment": ""
},
"entryType": "function",
"description": "",
"jsdocTags": [],
"rawComment": "",
"memberType": "method",
"memberTags": []
}
],
"generics": [
{
"name": "V"
}
],
"description": "A radio button group container.\n\nRadio groups are used to group multiple radio buttons or radio group labels so they function as\na single form control. The RadioGroup is meant to be used in conjunction with RadioButton\nas follows:\n\n```html\n<div ngRadioGroup>\n <div ngRadioButton value=\"1\">Option 1</div>\n <div ngRadioButton value=\"2\">Option 2</div>\n <div ngRadioButton value=\"3\">Option 3</div>\n</div>\n```",
"jsdocTags": [],
"rawComment": "/**\n * A radio button group container.\n *\n * Radio groups are used to group multiple radio buttons or radio group labels so they function as\n * a single form control. The RadioGroup is meant to be used in conjunction with RadioButton\n * as follows:\n *\n * ```html\n * <div ngRadioGroup>\n * <div ngRadioButton value=\"1\">Option 1</div>\n * <div ngRadioButton value=\"2\">Option 2</div>\n * <div ngRadioButton value=\"3\">Option 3</div>\n * </div>\n * ```\n */",
"implements": [],
"source": {
"filePath": "/src/aria/radio-group/radio-group.ts",
"startLine": 84,
"endLine": 200
}
},
{
"name": "RadioButton",
"isAbstract": false,
"entryType": "directive",
"members": [
{
"name": "id",
"type": "any",
"memberType": "property",
"memberTags": [
"readonly"
],
"description": "A unique identifier for the radio button.",
"jsdocTags": []
},
{
"name": "value",
"type": "any",
"memberType": "property",
"memberTags": [
"readonly",
"input"
],
"description": "The value associated with the radio button.",
"jsdocTags": [],
"inputAlias": "value",
"isRequiredInput": true
},
{
"name": "group",
"type": "any",
"memberType": "property",
"memberTags": [
"readonly"
],
"description": "The parent RadioGroup UIPattern.",
"jsdocTags": []
},
{
"name": "element",
"type": "any",
"memberType": "property",
"memberTags": [],
"description": "A reference to the radio button element to be focused on navigation.",
"jsdocTags": []
},
{
"name": "disabled",
"type": "any",
"memberType": "property",
"memberTags": [
"input"
],
"description": "Whether the radio button is disabled.",
"jsdocTags": [],
"inputAlias": "disabled",
"isRequiredInput": false
},
{
"name": "selected",
"type": "any",
"memberType": "property",
"memberTags": [
"readonly"
],
"description": "Whether the radio button is selected.",
"jsdocTags": []
}
],
"generics": [
{
"name": "V"
}
],
"description": "A selectable radio button in a RadioGroup.",
"jsdocTags": [],
"rawComment": "/** A selectable radio button in a RadioGroup. */",
"implements": [],
"isStandalone": true,
"selector": "[ngRadioButton]",
"exportAs": [
"ngRadioButton"
],
"source": {
"filePath": "/src/aria/radio-group/radio-group.ts",
"startLine": 203,
"endLine": 252
}
}
],
"symbols": [
[
"afterRenderEffect",
"@angular/core"
],
[
"booleanAttribute",
"@angular/core"
],
[
"computed",
"@angular/core"
],
[
"contentChildren",
"@angular/core"
],
[
"Directive",
"@angular/core"
],
[
"ElementRef",
"@angular/core"
],
[
"inject",
"@angular/core"
],
[
"input",
"@angular/core"
],
[
"linkedSignal",
"@angular/core"
],
[
"model",
"@angular/core"
],
[
"signal",
"@angular/core"
],
[
"WritableSignal",
"@angular/core"
],
[
"RadioButtonPattern",
"@angular/aria/private"
],
[
"RadioGroupInputs",
"@angular/aria/private"
],
[
"RadioGroupPattern",
"@angular/aria/private"
],
[
"ToolbarRadioGroupInputs",
"@angular/aria/private"
],
[
"ToolbarRadioGroupPattern",
"@angular/aria/private"
],
[
"Directionality",
"@angular/cdk/bidi"
],
[
"_IdGenerator",
"@angular/cdk/a11y"
],
[
"ToolbarWidgetGroup",
"@angular/aria/toolbar"
],
[
"RadioGroup",
"@angular/aria/radio-group"
],
[
"RadioButton",
"@angular/aria/radio-group"
],
[
"RadioGroup",
"@angular/aria/radio-group"
],
[
"RadioGroup.textDirection",
"@angular/aria/radio-group"
],
[
"RadioGroup.items",
"@angular/aria/radio-group"
],
[
"RadioGroup.orientation",
"@angular/aria/radio-group"
],
[
"RadioGroup.skipDisabled",
"@angular/aria/radio-group"
],
[
"RadioGroup.focusMode",
"@angular/aria/radio-group"
],
[
"RadioGroup.disabled",
"@angular/aria/radio-group"
],
[
"RadioGroup.readonly",
"@angular/aria/radio-group"
],
[
"RadioGroup.value",
"@angular/aria/radio-group"
],
[
"RadioGroup.onFocus",
"@angular/aria/radio-group"
],
[
"RadioButton",
"@angular/aria/radio-group"
],
[
"RadioButton.id",
"@angular/aria/radio-group"
],
[
"RadioButton.value",
"@angular/aria/radio-group"
],
[
"RadioButton.group",
"@angular/aria/radio-group"
],
[
"RadioButton.element",
"@angular/aria/radio-group"
],
[
"RadioButton.disabled",
"@angular/aria/radio-group"
],
[
"RadioButton.selected",
"@angular/aria/radio-group"
]
]
}
+4 -4
View File
@@ -192,16 +192,16 @@
"isRequiredInput": false
},
{
"name": "skipDisabled",
"name": "softDisabled",
"type": "any",
"memberType": "property",
"memberTags": [
"readonly",
"input"
],
"description": "Whether disabled items in the list should be skipped when navigating.",
"description": "Whether to allow disabled items to receive focus.",
"jsdocTags": [],
"inputAlias": "skipDisabled",
"inputAlias": "softDisabled",
"isRequiredInput": false
},
{
@@ -888,7 +888,7 @@
"@angular/aria/tabs"
],
[
"TabList.skipDisabled",
"TabList.softDisabled",
"@angular/aria/tabs"
],
[
+4 -5
View File
@@ -43,16 +43,15 @@
"isRequiredInput": false
},
{
"name": "skipDisabled",
"name": "softDisabled",
"type": "any",
"memberType": "property",
"memberTags": [
"readonly",
"input"
],
"description": "Whether disabled items in the group should be skipped when navigating.",
"description": "Whether to allow disabled items to receive focus.",
"jsdocTags": [],
"inputAlias": "skipDisabled",
"inputAlias": "softDisabled",
"isRequiredInput": false
},
{
@@ -626,7 +625,7 @@
"@angular/aria/toolbar"
],
[
"Toolbar.skipDisabled",
"Toolbar.softDisabled",
"@angular/aria/toolbar"
],
[
+3 -3
View File
@@ -80,13 +80,13 @@
"jsdocTags": []
},
{
"name": "skipDisabled",
"name": "softDisabled",
"type": "any",
"memberType": "property",
"memberTags": [
"readonly"
],
"description": "Whether to skip disabled items during navigation.",
"description": "Whether to allow disabled items to receive focus.",
"jsdocTags": []
},
{
@@ -948,7 +948,7 @@
"@angular/aria/tree"
],
[
"Tree.skipDisabled",
"Tree.softDisabled",
"@angular/aria/tree"
],
[