Skip to content

docs: add reference links to ARIA #32498

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
SkyZeroZx wants to merge 1 commit into
base: main
Choose a base branch
from
+220 −0
Open

docs: add reference links to ARIA #32498

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions src/aria/accordion/accordion.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,12 @@ import {
* ```
*
* @developerPreview 21.0
* @see [Accordion](guide/aria/accordion)
* @see [Single expansion mode](guide/aria/accordion#single-expansion-mode)
* @see [Multiple expansion mode](guide/aria/accordion#multiple-expansion-mode)
* @see [Disabled accordion items](guide/aria/accordion#disabled-accordion-items)
* @see [Lazy content rendering](guide/aria/accordion#lazy-content-rendering)
Comment on lines +52 to +55
Copy link
Member

@JeanMeche JeanMeche Dec 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure we need to go into that much details, 1 link per page should be enough

*
*/
@Directive({
selector: '[ngAccordionPanel]',
Expand Down Expand Up @@ -128,6 +134,11 @@ export class AccordionPanel {
* ```
*
* @developerPreview 21.0
* @see [Accordion](guide/aria/accordion)
* @see [Single expansion mode](guide/aria/accordion#single-expansion-mode)
* @see [Multiple expansion mode](guide/aria/accordion#multiple-expansion-mode)
* @see [Disabled accordion items](guide/aria/accordion#disabled-accordion-items)
* @see [Lazy content rendering](guide/aria/accordion#lazy-content-rendering)
*/
@Directive({
selector: '[ngAccordionTrigger]',
Expand Down Expand Up @@ -230,6 +241,11 @@ export class AccordionTrigger {
* ```
*
* @developerPreview 21.0
* @see [Accordion](guide/aria/accordion)
* @see [Single expansion mode](guide/aria/accordion#single-expansion-mode)
* @see [Multiple expansion mode](guide/aria/accordion#multiple-expansion-mode)
* @see [Disabled accordion items](guide/aria/accordion#disabled-accordion-items)
* @see [Lazy content rendering](guide/aria/accordion#lazy-content-rendering)
*/
@Directive({
selector: '[ngAccordionGroup]',
Expand Down Expand Up @@ -345,6 +361,11 @@ export class AccordionGroup {
* ```
*
* @developerPreview 21.0
* @see [Accordion](guide/aria/accordion)
* @see [Single expansion mode](guide/aria/accordion#single-expansion-mode)
* @see [Multiple expansion mode](guide/aria/accordion#multiple-expansion-mode)
* @see [Disabled accordion items](guide/aria/accordion#disabled-accordion-items)
* @see [Lazy content rendering](guide/aria/accordion#lazy-content-rendering)
*/
@Directive({
selector: 'ng-template[ngAccordionContent]',
Expand Down
44 changes: 44 additions & 0 deletions src/aria/combobox/combobox.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,15 @@ import {toSignal} from '@angular/core/rxjs-interop';
* ```
*
* @developerPreview 21.0
*
* @see [Combobox](guide/aria/combobox)
* @see [Select](guide/aria/select)
* @see [Multiselect](guide/aria/multiselect)
* @see [Autocomplete](guide/aria/autocomplete)
* @see [Dialog popup](guide/aria/combobox#dialog-popup)
* @see [Readonly mode](guide/aria/combobox#readonly-mode)
* @see [Autocomplete](guide/aria/combobox#autocomplete)
*
*/
@Directive({
selector: '[ngCombobox]',
Expand Down Expand Up @@ -192,6 +201,15 @@ export class Combobox<V> {
* ```
*
* @developerPreview 21.0
*
* @see [Combobox](guide/aria/combobox)
* @see [Select](guide/aria/select)
* @see [Multiselect](guide/aria/multiselect)
* @see [Autocomplete](guide/aria/autocomplete)
* @see [Dialog popup](guide/aria/combobox#dialog-popup)
* @see [Readonly mode](guide/aria/combobox#readonly-mode)
* @see [Autocomplete](guide/aria/combobox#autocomplete)
*
*/
@Directive({
selector: 'input[ngComboboxInput]',
Expand Down Expand Up @@ -270,6 +288,15 @@ export class ComboboxInput {
* ```
*
* @developerPreview 21.0
*
* @see [Combobox](guide/aria/combobox)
* @see [Select](guide/aria/select)
* @see [Multiselect](guide/aria/multiselect)
* @see [Autocomplete](guide/aria/autocomplete)
* @see [Dialog popup](guide/aria/combobox#dialog-popup)
* @see [Readonly mode](guide/aria/combobox#readonly-mode)
* @see [Autocomplete](guide/aria/combobox#autocomplete)
*
*/
@Directive({
selector: 'ng-template[ngComboboxPopupContainer]',
Expand All @@ -287,6 +314,14 @@ export class ComboboxPopupContainer {}
* exposing the popup's control pattern to the parent combobox.
*
* @developerPreview 21.0
*
* @see [Combobox](guide/aria/combobox)
* @see [Select](guide/aria/select)
* @see [Multiselect](guide/aria/multiselect)
* @see [Autocomplete](guide/aria/autocomplete)
* @see [Dialog popup](guide/aria/combobox#dialog-popup)
* @see [Readonly mode](guide/aria/combobox#readonly-mode)
* @see [Autocomplete](guide/aria/combobox#autocomplete)
*/
@Directive({
selector: '[ngComboboxPopup]',
Expand Down Expand Up @@ -319,6 +354,15 @@ export class ComboboxPopup<V> {
* ```
*
* @developerPreview 21.0
*
* @see [Combobox](guide/aria/combobox)
* @see [Select](guide/aria/select)
* @see [Multiselect](guide/aria/multiselect)
* @see [Autocomplete](guide/aria/autocomplete)
* @see [Dialog popup](guide/aria/combobox#dialog-popup)
* @see [Readonly mode](guide/aria/combobox#readonly-mode)
* @see [Autocomplete](guide/aria/combobox#autocomplete)
*
*/
@Directive({
selector: 'dialog[ngComboboxDialog]',
Expand Down
27 changes: 27 additions & 0 deletions src/aria/grid/grid.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,13 @@ import {GridPattern, GridRowPattern, GridCellPattern, GridCellWidgetPattern} fro
* ```
*
* @developerPreview 21.0
*
* @see [Grid](guide/aria/grid)
* @see [Selection and focus modes](guide/aria/grid#selection-and-focus-modes)
* @see [Data table grid](guide/aria/grid#data-table-grid)
* @see [Calendar grid](guide/aria/grid#calendar-grid)
* @see [Layout grid](guide/aria/grid#layout-grid)
*
*/
@Directive({
selector: '[ngGrid]',
Expand Down Expand Up @@ -172,6 +179,13 @@ export class Grid {
* ```
*
* @developerPreview 21.0
*
* @see [Grid](guide/aria/grid)
* @see [Selection and focus modes](guide/aria/grid#selection-and-focus-modes)
* @see [Data table grid](guide/aria/grid#data-table-grid)
* @see [Calendar grid](guide/aria/grid#calendar-grid)
* @see [Layout grid](guide/aria/grid#layout-grid)
*
*/
@Directive({
selector: '[ngGridRow]',
Expand Down Expand Up @@ -225,6 +239,13 @@ export class GridRow {
* ```
*
* @developerPreview 21.0
*
* @see [Grid](guide/aria/grid)
* @see [Selection and focus modes](guide/aria/grid#selection-and-focus-modes)
* @see [Data table grid](guide/aria/grid#data-table-grid)
* @see [Calendar grid](guide/aria/grid#calendar-grid)
* @see [Layout grid](guide/aria/grid#layout-grid)
*
*/
@Directive({
selector: '[ngGridCell]',
Expand Down Expand Up @@ -357,6 +378,12 @@ export class GridCell {
* ```
*
* @developerPreview 21.0
*
* @see [Grid](guide/aria/grid)
* @see [Selection and focus modes](guide/aria/grid#selection-and-focus-modes)
* @see [Data table grid](guide/aria/grid#data-table-grid)
* @see [Calendar grid](guide/aria/grid#calendar-grid)
* @see [Layout grid](guide/aria/grid#layout-grid)
*/
@Directive({
selector: '[ngGridCellWidget]',
Expand Down
12 changes: 12 additions & 0 deletions src/aria/listbox/listbox.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,12 @@ import {ComboboxPopup} from '../combobox';
* ```
*
* @developerPreview 21.0
*
* @see [Autocomplete](guide/aria/autocomplete)
* @see [Select](guide/aria/select)
* @see [Multiselect](guide/aria/multiselect)
* @see [Basic listbox](guide/aria/listbox#basic-listbox)
* @see [Horizontal listbox](guide/aria/listbox#horizontal-listbox)
*/
@Directive({
selector: '[ngListbox]',
Expand Down Expand Up @@ -229,6 +235,12 @@ export class Listbox<V> {
* ```
*
* @developerPreview 21.0
*
* @see [Autocomplete](guide/aria/autocomplete)
* @see [Select](guide/aria/select)
* @see [Multiselect](guide/aria/multiselect)
* @see [Basic listbox](guide/aria/listbox#basic-listbox)
* @see [Horizontal listbox](guide/aria/listbox#horizontal-listbox)
*/
@Directive({
selector: '[ngOption]',
Expand Down
30 changes: 30 additions & 0 deletions src/aria/menu/menu.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,12 @@ import {Directionality} from '@angular/cdk/bidi';
* ```
*
* @developerPreview 21.0
*
* @see [Menu](guide/aria/menu)
* @see [MenuBar](guide/aria/menubar)
* @see [Menu with trigger](guide/aria/menu#menu-with-trigger)
* @see [Context menu](guide/aria/menu#context-menu)
* @see [Standalone menu](guide/aria/menu#standalone-menu)
*/
@Directive({
selector: 'button[ngMenuTrigger]',
Expand Down Expand Up @@ -139,6 +145,12 @@ export class MenuTrigger<V> {
* ```
*
* @developerPreview 21.0
*
* @see [Menu](guide/aria/menu)
* @see [MenuBar](guide/aria/menubar)
* @see [Menu with trigger](guide/aria/menu#menu-with-trigger)
* @see [Context menu](guide/aria/menu#context-menu)
* @see [Standalone menu](guide/aria/menu#standalone-menu)
*/
@Directive({
selector: '[ngMenu]',
Expand Down Expand Up @@ -302,6 +314,12 @@ export class Menu<V> {
* ```
*
* @developerPreview 21.0
*
* @see [Menu](guide/aria/menu)
* @see [MenuBar](guide/aria/menubar)
* @see [Menu with trigger](guide/aria/menu#menu-with-trigger)
* @see [Context menu](guide/aria/menu#context-menu)
* @see [Standalone menu](guide/aria/menu#standalone-menu)
*/
@Directive({
selector: '[ngMenuBar]',
Expand Down Expand Up @@ -402,6 +420,12 @@ export class MenuBar<V> {
* ```
*
* @developerPreview 21.0
*
* @see [Menu](guide/aria/menu)
* @see [MenuBar](guide/aria/menubar)
* @see [Menu with trigger](guide/aria/menu#menu-with-trigger)
* @see [Context menu](guide/aria/menu#context-menu)
* @see [Standalone menu](guide/aria/menu#standalone-menu)
*/
@Directive({
selector: '[ngMenuItem]',
Expand Down Expand Up @@ -501,6 +525,12 @@ export class MenuItem<V> {
* ```
*
* @developerPreview 21.0
*
* @see [Menu](guide/aria/menu)
* @see [MenuBar](guide/aria/menubar)
* @see [Menu with trigger](guide/aria/menu#menu-with-trigger)
* @see [Context menu](guide/aria/menu#context-menu)
* @see [Standalone menu](guide/aria/menu#standalone-menu)
*/
@Directive({
selector: 'ng-template[ngMenuContent]',
Expand Down
40 changes: 40 additions & 0 deletions src/aria/tabs/tabs.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,14 @@ function sortDirectives(a: HasElement, b: HasElement) {
* ```
*
* @developerPreview 21.0
*
* @see [Tabs](guide/aria/tabs)
* @see [Selection follows focus](guide/aria/tabs#selection-follows-focus)
* @see [Manual activation](guide/aria/tabs#manual-activation)
* @see [Vertical tab](guide/aria/tabs#vertical-tabs)
* @see [Lazy content rendering](guide/aria/tabs#lazy-content-rendering)
* @see [Disabled tabs](guide/aria/tabs#disabled-tabs)
*
*/
@Directive({
selector: '[ngTabs]',
Expand Down Expand Up @@ -134,6 +142,14 @@ export class Tabs {
* ```
*
* @developerPreview 21.0
*
* @see [Tabs](guide/aria/tabs)
* @see [Selection follows focus](guide/aria/tabs#selection-follows-focus)
* @see [Manual activation](guide/aria/tabs#manual-activation)
* @see [Vertical tab](guide/aria/tabs#vertical-tabs)
* @see [Lazy content rendering](guide/aria/tabs#lazy-content-rendering)
* @see [Disabled tabs](guide/aria/tabs#disabled-tabs)
*
*/
@Directive({
selector: '[ngTabList]',
Expand Down Expand Up @@ -276,6 +292,14 @@ export class TabList implements OnInit, OnDestroy {
* ```
*
* @developerPreview 21.0
*
* @see [Tabs](guide/aria/tabs)
* @see [Selection follows focus](guide/aria/tabs#selection-follows-focus)
* @see [Manual activation](guide/aria/tabs#manual-activation)
* @see [Vertical tab](guide/aria/tabs#vertical-tabs)
* @see [Lazy content rendering](guide/aria/tabs#lazy-content-rendering)
* @see [Disabled tabs](guide/aria/tabs#disabled-tabs)
*
*/
@Directive({
selector: '[ngTab]',
Expand Down Expand Up @@ -365,6 +389,14 @@ export class Tab implements HasElement, OnInit, OnDestroy {
* ```
*
* @developerPreview 21.0
*
* @see [Tabs](guide/aria/tabs)
* @see [Selection follows focus](guide/aria/tabs#selection-follows-focus)
* @see [Manual activation](guide/aria/tabs#manual-activation)
* @see [Vertical tab](guide/aria/tabs#vertical-tabs)
* @see [Lazy content rendering](guide/aria/tabs#lazy-content-rendering)
* @see [Disabled tabs](guide/aria/tabs#disabled-tabs)
*
*/
@Directive({
selector: '[ngTabPanel]',
Expand Down Expand Up @@ -445,6 +477,14 @@ export class TabPanel implements OnInit, OnDestroy {
* ```
*
* @developerPreview 21.0
*
* @see [Tabs](guide/aria/tabs)
* @see [Selection follows focus](guide/aria/tabs#selection-follows-focus)
* @see [Manual activation](guide/aria/tabs#manual-activation)
* @see [Vertical tab](guide/aria/tabs#vertical-tabs)
* @see [Lazy content rendering](guide/aria/tabs#lazy-content-rendering)
* @see [Disabled tabs](guide/aria/tabs#disabled-tabs)
*
*/
@Directive({
selector: 'ng-template[ngTabContent]',
Expand Down
22 changes: 22 additions & 0 deletions src/aria/toolbar/toolbar.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,14 @@ function sortDirectives(a: HasElement, b: HasElement) {
* ```
*
* @developerPreview 21.0
*
* @see [Toolbar](guide/aria/toolbar)
* @see [Basic horizontal toolbar](guide/aria/toolbar#basic-horizontal-toolbar)
* @see [Vertical toolbar](guide/aria/toolbar#vertical-toolbar)
* @see [Widget groups](guide/aria/toolbar#widget-groups)
* @see [Disabled widgets](guide/aria/toolbar#disabled-widgets)
* @see [Right-to-left (RTL) support](guide/aria/toolbar#right-to-left-rtl-support)
*
*/
@Directive({
selector: '[ngToolbar]',
Expand Down Expand Up @@ -182,6 +190,13 @@ export class Toolbar<V> {
* ```
*
* @developerPreview 21.0
*
* @see [Toolbar](guide/aria/toolbar)
* @see [Basic horizontal toolbar](guide/aria/toolbar#basic-horizontal-toolbar)
* @see [Vertical toolbar](guide/aria/toolbar#vertical-toolbar)
* @see [Widget groups](guide/aria/toolbar#widget-groups)
* @see [Disabled widgets](guide/aria/toolbar#disabled-widgets)
* @see [Right-to-left (RTL) support](guide/aria/toolbar#right-to-left-rtl-support)
*/
@Directive({
selector: '[ngToolbarWidget]',
Expand Down Expand Up @@ -257,6 +272,13 @@ export class ToolbarWidget<V> implements OnInit, OnDestroy {
* that have their own internal navigation.
*
* @developerPreview 21.0
*
* @see [Toolbar](guide/aria/toolbar)
* @see [Basic horizontal toolbar](guide/aria/toolbar#basic-horizontal-toolbar)
* @see [Vertical toolbar](guide/aria/toolbar#vertical-toolbar)
* @see [Widget groups](guide/aria/toolbar#widget-groups)
* @see [Disabled widgets](guide/aria/toolbar#disabled-widgets)
* @see [Right-to-left (RTL) support](guide/aria/toolbar#right-to-left-rtl-support)
*/
@Directive({
selector: '[ngToolbarWidgetGroup]',
Expand Down
Loading
Loading