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
Matthew Beck (Berry)
parent
dc174d1053
commit
5e21431ba3
2 changed files with 88 additions and 49 deletions
|
|
@ -1,4 +1,4 @@
|
|||
{
|
||||
"branchName": "refs/heads/main",
|
||||
"sha": "9037a914fc2284dd93b04568b317181d1241b427"
|
||||
"sha": "fe72dc150919b428d632da82807e0e412306bbc6"
|
||||
}
|
||||
|
|
@ -44,16 +44,6 @@
|
|||
"description": "A global unique identifier for the panel.",
|
||||
"jsdocTags": []
|
||||
},
|
||||
{
|
||||
"name": "panelId",
|
||||
"type": "InputSignal<string>",
|
||||
"memberType": "property",
|
||||
"memberTags": [
|
||||
"readonly"
|
||||
],
|
||||
"description": "A local unique identifier for the panel, used to match with its trigger's `panelId`.",
|
||||
"jsdocTags": []
|
||||
},
|
||||
{
|
||||
"name": "visible",
|
||||
"type": "Signal<boolean>",
|
||||
|
|
@ -165,7 +155,7 @@
|
|||
}
|
||||
],
|
||||
"generics": [],
|
||||
"description": "The content panel of an accordion item that is conditionally visible.\n\nThis directive is a container for the content that is shown or hidden. It requires\na `panelId` that must match the `panelId` of its corresponding `ngAccordionTrigger`.\nThe content within the panel should be provided using an `ng-template` with the\n`ngAccordionContent` directive so that the content is not rendered on the page until the trigger\nis expanded. It applies `role=\"region\"` for accessibility and uses the `inert` attribute to hide\nits content from assistive technologies when not visible.\n\n```html\n<div ngAccordionPanel panelId=\"unique-id-1\">\n <ng-template ngAccordionContent>\n <p>This content is lazily rendered and will be shown when the panel is expanded.</p>\n </ng-template>\n</div>\n```",
|
||||
"description": "The content panel of an accordion item that is conditionally visible.\n\nThis directive is a container for the content that is shown or hidden. It should\nexpose a template reference that will be used by the corresponding `ngAccordionTrigger`.\nThe content within the panel should be provided using an `ng-template` with the\n`ngAccordionContent` directive so that the content is not rendered on the page until the trigger\nis expanded. It applies `role=\"region\"` for accessibility and uses the `inert` attribute to hide\nits content from assistive technologies when not visible.\n\n```html\n<div ngAccordionPanel #panel=\"ngAccordionPanel\">\n <ng-template ngAccordionContent>\n <p>This content is lazily rendered and will be shown when the panel is expanded.</p>\n </ng-template>\n</div>\n```",
|
||||
"jsdocTags": [
|
||||
{
|
||||
"name": "developerPreview",
|
||||
|
|
@ -176,12 +166,12 @@
|
|||
"comment": "[Accordion](guide/aria/accordion)"
|
||||
}
|
||||
],
|
||||
"rawComment": "/**\n * The content panel of an accordion item that is conditionally visible.\n *\n * This directive is a container for the content that is shown or hidden. It requires\n * a `panelId` that must match the `panelId` of its corresponding `ngAccordionTrigger`.\n * The content within the panel should be provided using an `ng-template` with the\n * `ngAccordionContent` directive so that the content is not rendered on the page until the trigger\n * is expanded. It applies `role=\"region\"` for accessibility and uses the `inert` attribute to hide\n * its content from assistive technologies when not visible.\n *\n * ```html\n * <div ngAccordionPanel panelId=\"unique-id-1\">\n * <ng-template ngAccordionContent>\n * <p>This content is lazily rendered and will be shown when the panel is expanded.</p>\n * </ng-template>\n * </div>\n * ```\n *\n * @developerPreview 21.0\n * @see [Accordion](guide/aria/accordion)\n */",
|
||||
"rawComment": "/**\n * The content panel of an accordion item that is conditionally visible.\n *\n * This directive is a container for the content that is shown or hidden. It should\n * expose a template reference that will be used by the corresponding `ngAccordionTrigger`.\n * The content within the panel should be provided using an `ng-template` with the\n * `ngAccordionContent` directive so that the content is not rendered on the page until the trigger\n * is expanded. It applies `role=\"region\"` for accessibility and uses the `inert` attribute to hide\n * its content from assistive technologies when not visible.\n *\n * ```html\n * <div ngAccordionPanel #panel=\"ngAccordionPanel\">\n * <ng-template ngAccordionContent>\n * <p>This content is lazily rendered and will be shown when the panel is expanded.</p>\n * </ng-template>\n * </div>\n * ```\n *\n * @developerPreview 21.0\n * @see [Accordion](guide/aria/accordion)\n */",
|
||||
"implements": [],
|
||||
"source": {
|
||||
"filePath": "/src/aria/accordion/accordion-panel.ts",
|
||||
"startLine": 42,
|
||||
"endLine": 103
|
||||
"startLine": 34,
|
||||
"endLine": 88
|
||||
}
|
||||
},
|
||||
{
|
||||
|
|
@ -199,6 +189,19 @@
|
|||
"description": "A reference to the trigger element.",
|
||||
"jsdocTags": []
|
||||
},
|
||||
{
|
||||
"name": "panel",
|
||||
"type": "InputSignal<AccordionPanel>",
|
||||
"memberType": "property",
|
||||
"memberTags": [
|
||||
"readonly",
|
||||
"input"
|
||||
],
|
||||
"description": "The associated AccordionPanel.",
|
||||
"jsdocTags": [],
|
||||
"inputAlias": "panel",
|
||||
"isRequiredInput": true
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "InputSignal<any>",
|
||||
|
|
@ -207,23 +210,20 @@
|
|||
"readonly",
|
||||
"input"
|
||||
],
|
||||
"description": "A unique identifier for the widget.",
|
||||
"description": "The unique identifier for the trigger.",
|
||||
"jsdocTags": [],
|
||||
"inputAlias": "id",
|
||||
"isRequiredInput": false
|
||||
},
|
||||
{
|
||||
"name": "panelId",
|
||||
"type": "InputSignal<string>",
|
||||
"type": "Signal<any>",
|
||||
"memberType": "property",
|
||||
"memberTags": [
|
||||
"readonly",
|
||||
"input"
|
||||
"readonly"
|
||||
],
|
||||
"description": "A local unique identifier for the trigger, used to match with its panel's `panelId`.",
|
||||
"jsdocTags": [],
|
||||
"inputAlias": "panelId",
|
||||
"isRequiredInput": true
|
||||
"description": "The unique identifier for the correspondingtrigger panel.",
|
||||
"jsdocTags": []
|
||||
},
|
||||
{
|
||||
"name": "disabled",
|
||||
|
|
@ -263,6 +263,39 @@
|
|||
"description": "Whether the trigger is active.",
|
||||
"jsdocTags": []
|
||||
},
|
||||
{
|
||||
"name": "ngOnInit",
|
||||
"signatures": [
|
||||
{
|
||||
"name": "ngOnInit",
|
||||
"entryType": "function",
|
||||
"description": "",
|
||||
"generics": [],
|
||||
"isNewType": false,
|
||||
"jsdocTags": [],
|
||||
"params": [],
|
||||
"rawComment": "",
|
||||
"returnType": "void"
|
||||
}
|
||||
],
|
||||
"implementation": {
|
||||
"params": [],
|
||||
"isNewType": false,
|
||||
"returnType": "void",
|
||||
"generics": [],
|
||||
"name": "ngOnInit",
|
||||
"description": "",
|
||||
"entryType": "function",
|
||||
"jsdocTags": [],
|
||||
"rawComment": ""
|
||||
},
|
||||
"entryType": "function",
|
||||
"description": "",
|
||||
"jsdocTags": [],
|
||||
"rawComment": "",
|
||||
"memberType": "method",
|
||||
"memberTags": []
|
||||
},
|
||||
{
|
||||
"name": "expand",
|
||||
"signatures": [
|
||||
|
|
@ -364,7 +397,7 @@
|
|||
}
|
||||
],
|
||||
"generics": [],
|
||||
"description": "The trigger that toggles the visibility of its associated `ngAccordionPanel`.\n\nThis directive requires a `panelId` that must match the `panelId` of the `ngAccordionPanel` it\ncontrols. When clicked, it will expand or collapse the panel. It also handles keyboard\ninteractions for navigation within the `ngAccordionGroup`. It applies `role=\"button\"` and manages\n`aria-expanded`, `aria-controls`, and `aria-disabled` attributes for accessibility.\nThe `disabled` input can be used to disable the trigger.\n\n```html\n<button ngAccordionTrigger panelId=\"unique-id-1\">\n Accordion Trigger Text\n</button>\n```",
|
||||
"description": "The trigger that toggles the visibility of its associated `ngAccordionPanel`.\n\nThis directive requires the `panel` input be set to the template reference of the `ngAccordionPanel`\nit controls. When clicked, it will expand or collapse the panel. It also handles keyboard\ninteractions for navigation within the `ngAccordionGroup`. It applies `role=\"button\"` and manages\n`aria-expanded`, `aria-controls`, and `aria-disabled` attributes for accessibility.\nThe `disabled` input can be used to disable the trigger.\n\n```html\n<button ngAccordionTrigger [panel]=\"panel\">\n Accordion Trigger Text\n</button>\n```",
|
||||
"jsdocTags": [
|
||||
{
|
||||
"name": "developerPreview",
|
||||
|
|
@ -375,8 +408,10 @@
|
|||
"comment": "[Accordion](guide/aria/accordion)"
|
||||
}
|
||||
],
|
||||
"rawComment": "/**\n * The trigger that toggles the visibility of its associated `ngAccordionPanel`.\n *\n * This directive requires a `panelId` that must match the `panelId` of the `ngAccordionPanel` it\n * controls. When clicked, it will expand or collapse the panel. It also handles keyboard\n * interactions for navigation within the `ngAccordionGroup`. It applies `role=\"button\"` and manages\n * `aria-expanded`, `aria-controls`, and `aria-disabled` attributes for accessibility.\n * The `disabled` input can be used to disable the trigger.\n *\n * ```html\n * <button ngAccordionTrigger panelId=\"unique-id-1\">\n * Accordion Trigger Text\n * </button>\n * ```\n *\n * @developerPreview 21.0\n * @see [Accordion](guide/aria/accordion)\n */",
|
||||
"implements": [],
|
||||
"rawComment": "/**\n * The trigger that toggles the visibility of its associated `ngAccordionPanel`.\n *\n * This directive requires the `panel` input be set to the template reference of the `ngAccordionPanel`\n * it controls. When clicked, it will expand or collapse the panel. It also handles keyboard\n * interactions for navigation within the `ngAccordionGroup`. It applies `role=\"button\"` and manages\n * `aria-expanded`, `aria-controls`, and `aria-disabled` attributes for accessibility.\n * The `disabled` input can be used to disable the trigger.\n *\n * ```html\n * <button ngAccordionTrigger [panel]=\"panel\">\n * Accordion Trigger Text\n * </button>\n * ```\n *\n * @developerPreview 21.0\n * @see [Accordion](guide/aria/accordion)\n */",
|
||||
"implements": [
|
||||
"OnInit"
|
||||
],
|
||||
"isStandalone": true,
|
||||
"selector": "[ngAccordionTrigger]",
|
||||
"exportAs": [
|
||||
|
|
@ -388,7 +423,7 @@
|
|||
"source": {
|
||||
"filePath": "/src/aria/accordion/accordion-trigger.ts",
|
||||
"startLine": 42,
|
||||
"endLine": 107
|
||||
"endLine": 112
|
||||
}
|
||||
},
|
||||
{
|
||||
|
|
@ -536,7 +571,7 @@
|
|||
}
|
||||
],
|
||||
"generics": [],
|
||||
"description": "A container for a group of accordion items. It manages the overall state and\ninteractions of the accordion, such as keyboard navigation and expansion mode.\n\nThe `ngAccordionGroup` serves as the root of a group of accordion triggers and panels,\ncoordinating the behavior of the `ngAccordionTrigger` and `ngAccordionPanel` elements within it.\nIt supports both single and multiple expansion modes.\n\n```html\n<div ngAccordionGroup [multiExpandable]=\"true\" [(expandedPanels)]=\"expandedItems\">\n <div class=\"accordion-item\">\n <h3>\n <button ngAccordionTrigger panelId=\"item-1\">Item 1</button>\n </h3>\n <div ngAccordionPanel panelId=\"item-1\">\n <ng-template ngAccordionContent>\n <p>Content for Item 1.</p>\n </ng-template>\n </div>\n </div>\n <div class=\"accordion-item\">\n <h3>\n <button ngAccordionTrigger panelId=\"item-2\">Item 2</button>\n </h3>\n <div ngAccordionPanel panelId=\"item-2\">\n <ng-template ngAccordionContent>\n <p>Content for Item 2.</p>\n </ng-template>\n </div>\n </div>\n</div>\n```",
|
||||
"description": "A container for a group of accordion items. It manages the overall state and\ninteractions of the accordion, such as keyboard navigation and expansion mode.\n\nThe `ngAccordionGroup` serves as the root of a group of accordion triggers and panels,\ncoordinating the behavior of the `ngAccordionTrigger` and `ngAccordionPanel` elements within it.\nIt supports both single and multiple expansion modes.\n\n```html\n<div ngAccordionGroup [multiExpandable]=\"true\">\n <div class=\"accordion-item\">\n <h3>\n <button ngAccordionTrigger [panel]=\"panel1\">Item 1</button>\n </h3>\n <div ngAccordionPanel #panel1=\"ngAccordionPanel\">\n <ng-template ngAccordionContent>\n <p>Content for Item 1.</p>\n </ng-template>\n </div>\n </div>\n <div class=\"accordion-item\">\n <h3>\n <button ngAccordionTrigger [panel]=\"panel2\">Item 2</button>\n </h3>\n <div ngAccordionPanel #panel2=\"ngAccordionPanel\">\n <ng-template ngAccordionContent>\n <p>Content for Item 2.</p>\n </ng-template>\n </div>\n </div>\n</div>\n```",
|
||||
"jsdocTags": [
|
||||
{
|
||||
"name": "developerPreview",
|
||||
|
|
@ -547,7 +582,7 @@
|
|||
"comment": "[Accordion](guide/aria/accordion)"
|
||||
}
|
||||
],
|
||||
"rawComment": "/**\n * A container for a group of accordion items. It manages the overall state and\n * interactions of the accordion, such as keyboard navigation and expansion mode.\n *\n * The `ngAccordionGroup` serves as the root of a group of accordion triggers and panels,\n * coordinating the behavior of the `ngAccordionTrigger` and `ngAccordionPanel` elements within it.\n * It supports both single and multiple expansion modes.\n *\n * ```html\n * <div ngAccordionGroup [multiExpandable]=\"true\" [(expandedPanels)]=\"expandedItems\">\n * <div class=\"accordion-item\">\n * <h3>\n * <button ngAccordionTrigger panelId=\"item-1\">Item 1</button>\n * </h3>\n * <div ngAccordionPanel panelId=\"item-1\">\n * <ng-template ngAccordionContent>\n * <p>Content for Item 1.</p>\n * </ng-template>\n * </div>\n * </div>\n * <div class=\"accordion-item\">\n * <h3>\n * <button ngAccordionTrigger panelId=\"item-2\">Item 2</button>\n * </h3>\n * <div ngAccordionPanel panelId=\"item-2\">\n * <ng-template ngAccordionContent>\n * <p>Content for Item 2.</p>\n * </ng-template>\n * </div>\n * </div>\n * </div>\n * ```\n *\n * @developerPreview 21.0\n * @see [Accordion](guide/aria/accordion)\n */",
|
||||
"rawComment": "/**\n * A container for a group of accordion items. It manages the overall state and\n * interactions of the accordion, such as keyboard navigation and expansion mode.\n *\n * The `ngAccordionGroup` serves as the root of a group of accordion triggers and panels,\n * coordinating the behavior of the `ngAccordionTrigger` and `ngAccordionPanel` elements within it.\n * It supports both single and multiple expansion modes.\n *\n * ```html\n * <div ngAccordionGroup [multiExpandable]=\"true\">\n * <div class=\"accordion-item\">\n * <h3>\n * <button ngAccordionTrigger [panel]=\"panel1\">Item 1</button>\n * </h3>\n * <div ngAccordionPanel #panel1=\"ngAccordionPanel\">\n * <ng-template ngAccordionContent>\n * <p>Content for Item 1.</p>\n * </ng-template>\n * </div>\n * </div>\n * <div class=\"accordion-item\">\n * <h3>\n * <button ngAccordionTrigger [panel]=\"panel2\">Item 2</button>\n * </h3>\n * <div ngAccordionPanel #panel2=\"ngAccordionPanel\">\n * <ng-template ngAccordionContent>\n * <p>Content for Item 2.</p>\n * </ng-template>\n * </div>\n * </div>\n * </div>\n * ```\n *\n * @developerPreview 21.0\n * @see [Accordion](guide/aria/accordion)\n */",
|
||||
"implements": [],
|
||||
"isStandalone": true,
|
||||
"selector": "[ngAccordionGroup]",
|
||||
|
|
@ -559,8 +594,8 @@
|
|||
],
|
||||
"source": {
|
||||
"filePath": "src/aria/accordion/accordion-group.ts",
|
||||
"startLine": 62,
|
||||
"endLine": 158
|
||||
"startLine": 60,
|
||||
"endLine": 120
|
||||
}
|
||||
}
|
||||
],
|
||||
|
|
@ -569,28 +604,20 @@
|
|||
"Directive",
|
||||
"@angular/core"
|
||||
],
|
||||
[
|
||||
"input",
|
||||
"@angular/core"
|
||||
],
|
||||
[
|
||||
"inject",
|
||||
"@angular/core"
|
||||
],
|
||||
[
|
||||
"afterRenderEffect",
|
||||
"@angular/core"
|
||||
],
|
||||
[
|
||||
"signal",
|
||||
"@angular/core"
|
||||
],
|
||||
[
|
||||
"computed",
|
||||
"@angular/core"
|
||||
],
|
||||
[
|
||||
"WritableSignal",
|
||||
"inject",
|
||||
"@angular/core"
|
||||
],
|
||||
[
|
||||
"input",
|
||||
"@angular/core"
|
||||
],
|
||||
[
|
||||
|
|
@ -602,17 +629,25 @@
|
|||
"@angular/core"
|
||||
],
|
||||
[
|
||||
"model",
|
||||
"OnInit",
|
||||
"@angular/core"
|
||||
],
|
||||
[
|
||||
"booleanAttribute",
|
||||
"@angular/core"
|
||||
],
|
||||
[
|
||||
"model",
|
||||
"@angular/core"
|
||||
],
|
||||
[
|
||||
"contentChildren",
|
||||
"@angular/core"
|
||||
],
|
||||
[
|
||||
"signal",
|
||||
"@angular/core"
|
||||
],
|
||||
[
|
||||
"Directionality",
|
||||
"@angular/cdk/bidi"
|
||||
|
|
@ -645,10 +680,6 @@
|
|||
"AccordionPanel.id",
|
||||
"@angular/aria/accordion"
|
||||
],
|
||||
[
|
||||
"AccordionPanel.panelId",
|
||||
"@angular/aria/accordion"
|
||||
],
|
||||
[
|
||||
"AccordionPanel.visible",
|
||||
"@angular/aria/accordion"
|
||||
|
|
@ -673,6 +704,10 @@
|
|||
"AccordionTrigger.element",
|
||||
"@angular/aria/accordion"
|
||||
],
|
||||
[
|
||||
"AccordionTrigger.panel",
|
||||
"@angular/aria/accordion"
|
||||
],
|
||||
[
|
||||
"AccordionTrigger.id",
|
||||
"@angular/aria/accordion"
|
||||
|
|
@ -693,6 +728,10 @@
|
|||
"AccordionTrigger.active",
|
||||
"@angular/aria/accordion"
|
||||
],
|
||||
[
|
||||
"AccordionTrigger.ngOnInit",
|
||||
"@angular/aria/accordion"
|
||||
],
|
||||
[
|
||||
"AccordionTrigger.expand",
|
||||
"@angular/aria/accordion"
|
||||
|
|
|
|||
Loading…
Reference in a new issue