Skip to content

Commit d8de83e

Browse files
SkyZeroZxSkyZeroZx
committed
docs: add reference links to ARIA
Adds see links in the ARIA components documentation to improve discoverability of related documentation and usage guides
1 parent 52720a3 commit d8de83e

File tree

8 files changed

+220
-0
lines changed

8 files changed

+220
-0
lines changed

‎src/aria/accordion/accordion.ts‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,12 @@ import {
4848
* ```
4949
*
5050
* @developerPreview 21.0
51+
* @see [Accordion](guide/aria/accordion)
52+
* @see [Single expansion mode](guide/aria/accordion#single-expansion-mode)
53+
* @see [Multiple expansion mode](guide/aria/accordion#multiple-expansion-mode)
54+
* @see [Disabled accordion items](guide/aria/accordion#disabled-accordion-items)
55+
* @see [Lazy content rendering](guide/aria/accordion#lazy-content-rendering)
56+
*
5157
*/
5258
@Directive({
5359
selector: '[ngAccordionPanel]',
@@ -128,6 +134,11 @@ export class AccordionPanel {
128134
* ```
129135
*
130136
* @developerPreview 21.0
137+
* @see [Accordion](guide/aria/accordion)
138+
* @see [Single expansion mode](guide/aria/accordion#single-expansion-mode)
139+
* @see [Multiple expansion mode](guide/aria/accordion#multiple-expansion-mode)
140+
* @see [Disabled accordion items](guide/aria/accordion#disabled-accordion-items)
141+
* @see [Lazy content rendering](guide/aria/accordion#lazy-content-rendering)
131142
*/
132143
@Directive({
133144
selector: '[ngAccordionTrigger]',
@@ -230,6 +241,11 @@ export class AccordionTrigger {
230241
* ```
231242
*
232243
* @developerPreview 21.0
244+
* @see [Accordion](guide/aria/accordion)
245+
* @see [Single expansion mode](guide/aria/accordion#single-expansion-mode)
246+
* @see [Multiple expansion mode](guide/aria/accordion#multiple-expansion-mode)
247+
* @see [Disabled accordion items](guide/aria/accordion#disabled-accordion-items)
248+
* @see [Lazy content rendering](guide/aria/accordion#lazy-content-rendering)
233249
*/
234250
@Directive({
235251
selector: '[ngAccordionGroup]',
@@ -345,6 +361,11 @@ export class AccordionGroup {
345361
* ```
346362
*
347363
* @developerPreview 21.0
364+
* @see [Accordion](guide/aria/accordion)
365+
* @see [Single expansion mode](guide/aria/accordion#single-expansion-mode)
366+
* @see [Multiple expansion mode](guide/aria/accordion#multiple-expansion-mode)
367+
* @see [Disabled accordion items](guide/aria/accordion#disabled-accordion-items)
368+
* @see [Lazy content rendering](guide/aria/accordion#lazy-content-rendering)
348369
*/
349370
@Directive({
350371
selector: 'ng-template[ngAccordionContent]',

‎src/aria/combobox/combobox.ts‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,15 @@ import {toSignal} from '@angular/core/rxjs-interop';
6161
* ```
6262
*
6363
* @developerPreview 21.0
64+
*
65+
* @see [Combobox](guide/aria/combobox)
66+
* @see [Select](guide/aria/select)
67+
* @see [Multiselect](guide/aria/multiselect)
68+
* @see [Autocomplete](guide/aria/autocomplete)
69+
* @see [Dialog popup](guide/aria/combobox#dialog-popup)
70+
* @see [Readonly mode](guide/aria/combobox#readonly-mode)
71+
* @see [Autocomplete](guide/aria/combobox#autocomplete)
72+
*
6473
*/
6574
@Directive({
6675
selector: '[ngCombobox]',
@@ -192,6 +201,15 @@ export class Combobox<V> {
192201
* ```
193202
*
194203
* @developerPreview 21.0
204+
*
205+
* @see [Combobox](guide/aria/combobox)
206+
* @see [Select](guide/aria/select)
207+
* @see [Multiselect](guide/aria/multiselect)
208+
* @see [Autocomplete](guide/aria/autocomplete)
209+
* @see [Dialog popup](guide/aria/combobox#dialog-popup)
210+
* @see [Readonly mode](guide/aria/combobox#readonly-mode)
211+
* @see [Autocomplete](guide/aria/combobox#autocomplete)
212+
*
195213
*/
196214
@Directive({
197215
selector: 'input[ngComboboxInput]',
@@ -270,6 +288,15 @@ export class ComboboxInput {
270288
* ```
271289
*
272290
* @developerPreview 21.0
291+
*
292+
* @see [Combobox](guide/aria/combobox)
293+
* @see [Select](guide/aria/select)
294+
* @see [Multiselect](guide/aria/multiselect)
295+
* @see [Autocomplete](guide/aria/autocomplete)
296+
* @see [Dialog popup](guide/aria/combobox#dialog-popup)
297+
* @see [Readonly mode](guide/aria/combobox#readonly-mode)
298+
* @see [Autocomplete](guide/aria/combobox#autocomplete)
299+
*
273300
*/
274301
@Directive({
275302
selector: 'ng-template[ngComboboxPopupContainer]',
@@ -287,6 +314,14 @@ export class ComboboxPopupContainer {}
287314
* exposing the popup's control pattern to the parent combobox.
288315
*
289316
* @developerPreview 21.0
317+
*
318+
* @see [Combobox](guide/aria/combobox)
319+
* @see [Select](guide/aria/select)
320+
* @see [Multiselect](guide/aria/multiselect)
321+
* @see [Autocomplete](guide/aria/autocomplete)
322+
* @see [Dialog popup](guide/aria/combobox#dialog-popup)
323+
* @see [Readonly mode](guide/aria/combobox#readonly-mode)
324+
* @see [Autocomplete](guide/aria/combobox#autocomplete)
290325
*/
291326
@Directive({
292327
selector: '[ngComboboxPopup]',
@@ -319,6 +354,15 @@ export class ComboboxPopup<V> {
319354
* ```
320355
*
321356
* @developerPreview 21.0
357+
*
358+
* @see [Combobox](guide/aria/combobox)
359+
* @see [Select](guide/aria/select)
360+
* @see [Multiselect](guide/aria/multiselect)
361+
* @see [Autocomplete](guide/aria/autocomplete)
362+
* @see [Dialog popup](guide/aria/combobox#dialog-popup)
363+
* @see [Readonly mode](guide/aria/combobox#readonly-mode)
364+
* @see [Autocomplete](guide/aria/combobox#autocomplete)
365+
*
322366
*/
323367
@Directive({
324368
selector: 'dialog[ngComboboxDialog]',

‎src/aria/grid/grid.ts‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,13 @@ import {GridPattern, GridRowPattern, GridCellPattern, GridCellWidgetPattern} fro
4343
* ```
4444
*
4545
* @developerPreview 21.0
46+
*
47+
* @see [Grid](guide/aria/grid)
48+
* @see [Selection and focus modes](guide/aria/grid#selection-and-focus-modes)
49+
* @see [Data table grid](guide/aria/grid#data-table-grid)
50+
* @see [Calendar grid](guide/aria/grid#calendar-grid)
51+
* @see [Layout grid](guide/aria/grid#layout-grid)
52+
*
4653
*/
4754
@Directive({
4855
selector: '[ngGrid]',
@@ -172,6 +179,13 @@ export class Grid {
172179
* ```
173180
*
174181
* @developerPreview 21.0
182+
*
183+
* @see [Grid](guide/aria/grid)
184+
* @see [Selection and focus modes](guide/aria/grid#selection-and-focus-modes)
185+
* @see [Data table grid](guide/aria/grid#data-table-grid)
186+
* @see [Calendar grid](guide/aria/grid#calendar-grid)
187+
* @see [Layout grid](guide/aria/grid#layout-grid)
188+
*
175189
*/
176190
@Directive({
177191
selector: '[ngGridRow]',
@@ -225,6 +239,13 @@ export class GridRow {
225239
* ```
226240
*
227241
* @developerPreview 21.0
242+
*
243+
* @see [Grid](guide/aria/grid)
244+
* @see [Selection and focus modes](guide/aria/grid#selection-and-focus-modes)
245+
* @see [Data table grid](guide/aria/grid#data-table-grid)
246+
* @see [Calendar grid](guide/aria/grid#calendar-grid)
247+
* @see [Layout grid](guide/aria/grid#layout-grid)
248+
*
228249
*/
229250
@Directive({
230251
selector: '[ngGridCell]',
@@ -357,6 +378,12 @@ export class GridCell {
357378
* ```
358379
*
359380
* @developerPreview 21.0
381+
*
382+
* @see [Grid](guide/aria/grid)
383+
* @see [Selection and focus modes](guide/aria/grid#selection-and-focus-modes)
384+
* @see [Data table grid](guide/aria/grid#data-table-grid)
385+
* @see [Calendar grid](guide/aria/grid#calendar-grid)
386+
* @see [Layout grid](guide/aria/grid#layout-grid)
360387
*/
361388
@Directive({
362389
selector: '[ngGridCellWidget]',

‎src/aria/listbox/listbox.ts‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,12 @@ import {ComboboxPopup} from '../combobox';
4444
* ```
4545
*
4646
* @developerPreview 21.0
47+
*
48+
* @see [Autocomplete](guide/aria/autocomplete)
49+
* @see [Select](guide/aria/select)
50+
* @see [Multiselect](guide/aria/multiselect)
51+
* @see [Basic listbox](guide/aria/listbox#basic-listbox)
52+
* @see [Horizontal listbox](guide/aria/listbox#horizontal-listbox)
4753
*/
4854
@Directive({
4955
selector: '[ngListbox]',
@@ -229,6 +235,12 @@ export class Listbox<V> {
229235
* ```
230236
*
231237
* @developerPreview 21.0
238+
*
239+
* @see [Autocomplete](guide/aria/autocomplete)
240+
* @see [Select](guide/aria/select)
241+
* @see [Multiselect](guide/aria/multiselect)
242+
* @see [Basic listbox](guide/aria/listbox#basic-listbox)
243+
* @see [Horizontal listbox](guide/aria/listbox#horizontal-listbox)
232244
*/
233245
@Directive({
234246
selector: '[ngOption]',

‎src/aria/menu/menu.ts‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,12 @@ import {Directionality} from '@angular/cdk/bidi';
5151
* ```
5252
*
5353
* @developerPreview 21.0
54+
*
55+
* @see [Menu](guide/aria/menu)
56+
* @see [MenuBar](guide/aria/menubar)
57+
* @see [Menu with trigger](guide/aria/menu#menu-with-trigger)
58+
* @see [Context menu](guide/aria/menu#context-menu)
59+
* @see [Standalone menu](guide/aria/menu#standalone-menu)
5460
*/
5561
@Directive({
5662
selector: 'button[ngMenuTrigger]',
@@ -139,6 +145,12 @@ export class MenuTrigger<V> {
139145
* ```
140146
*
141147
* @developerPreview 21.0
148+
*
149+
* @see [Menu](guide/aria/menu)
150+
* @see [MenuBar](guide/aria/menubar)
151+
* @see [Menu with trigger](guide/aria/menu#menu-with-trigger)
152+
* @see [Context menu](guide/aria/menu#context-menu)
153+
* @see [Standalone menu](guide/aria/menu#standalone-menu)
142154
*/
143155
@Directive({
144156
selector: '[ngMenu]',
@@ -302,6 +314,12 @@ export class Menu<V> {
302314
* ```
303315
*
304316
* @developerPreview 21.0
317+
*
318+
* @see [Menu](guide/aria/menu)
319+
* @see [MenuBar](guide/aria/menubar)
320+
* @see [Menu with trigger](guide/aria/menu#menu-with-trigger)
321+
* @see [Context menu](guide/aria/menu#context-menu)
322+
* @see [Standalone menu](guide/aria/menu#standalone-menu)
305323
*/
306324
@Directive({
307325
selector: '[ngMenuBar]',
@@ -402,6 +420,12 @@ export class MenuBar<V> {
402420
* ```
403421
*
404422
* @developerPreview 21.0
423+
*
424+
* @see [Menu](guide/aria/menu)
425+
* @see [MenuBar](guide/aria/menubar)
426+
* @see [Menu with trigger](guide/aria/menu#menu-with-trigger)
427+
* @see [Context menu](guide/aria/menu#context-menu)
428+
* @see [Standalone menu](guide/aria/menu#standalone-menu)
405429
*/
406430
@Directive({
407431
selector: '[ngMenuItem]',
@@ -501,6 +525,12 @@ export class MenuItem<V> {
501525
* ```
502526
*
503527
* @developerPreview 21.0
528+
*
529+
* @see [Menu](guide/aria/menu)
530+
* @see [MenuBar](guide/aria/menubar)
531+
* @see [Menu with trigger](guide/aria/menu#menu-with-trigger)
532+
* @see [Context menu](guide/aria/menu#context-menu)
533+
* @see [Standalone menu](guide/aria/menu#standalone-menu)
504534
*/
505535
@Directive({
506536
selector: 'ng-template[ngMenuContent]',

‎src/aria/tabs/tabs.ts‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,14 @@ function sortDirectives(a: HasElement, b: HasElement) {
7070
* ```
7171
*
7272
* @developerPreview 21.0
73+
*
74+
* @see [Tabs](guide/aria/tabs)
75+
* @see [Selection follows focus](guide/aria/tabs#selection-follows-focus)
76+
* @see [Manual activation](guide/aria/tabs#manual-activation)
77+
* @see [Vertical tab](guide/aria/tabs#vertical-tabs)
78+
* @see [Lazy content rendering](guide/aria/tabs#lazy-content-rendering)
79+
* @see [Disabled tabs](guide/aria/tabs#disabled-tabs)
80+
*
7381
*/
7482
@Directive({
7583
selector: '[ngTabs]',
@@ -134,6 +142,14 @@ export class Tabs {
134142
* ```
135143
*
136144
* @developerPreview 21.0
145+
*
146+
* @see [Tabs](guide/aria/tabs)
147+
* @see [Selection follows focus](guide/aria/tabs#selection-follows-focus)
148+
* @see [Manual activation](guide/aria/tabs#manual-activation)
149+
* @see [Vertical tab](guide/aria/tabs#vertical-tabs)
150+
* @see [Lazy content rendering](guide/aria/tabs#lazy-content-rendering)
151+
* @see [Disabled tabs](guide/aria/tabs#disabled-tabs)
152+
*
137153
*/
138154
@Directive({
139155
selector: '[ngTabList]',
@@ -276,6 +292,14 @@ export class TabList implements OnInit, OnDestroy {
276292
* ```
277293
*
278294
* @developerPreview 21.0
295+
*
296+
* @see [Tabs](guide/aria/tabs)
297+
* @see [Selection follows focus](guide/aria/tabs#selection-follows-focus)
298+
* @see [Manual activation](guide/aria/tabs#manual-activation)
299+
* @see [Vertical tab](guide/aria/tabs#vertical-tabs)
300+
* @see [Lazy content rendering](guide/aria/tabs#lazy-content-rendering)
301+
* @see [Disabled tabs](guide/aria/tabs#disabled-tabs)
302+
*
279303
*/
280304
@Directive({
281305
selector: '[ngTab]',
@@ -365,6 +389,14 @@ export class Tab implements HasElement, OnInit, OnDestroy {
365389
* ```
366390
*
367391
* @developerPreview 21.0
392+
*
393+
* @see [Tabs](guide/aria/tabs)
394+
* @see [Selection follows focus](guide/aria/tabs#selection-follows-focus)
395+
* @see [Manual activation](guide/aria/tabs#manual-activation)
396+
* @see [Vertical tab](guide/aria/tabs#vertical-tabs)
397+
* @see [Lazy content rendering](guide/aria/tabs#lazy-content-rendering)
398+
* @see [Disabled tabs](guide/aria/tabs#disabled-tabs)
399+
*
368400
*/
369401
@Directive({
370402
selector: '[ngTabPanel]',
@@ -445,6 +477,14 @@ export class TabPanel implements OnInit, OnDestroy {
445477
* ```
446478
*
447479
* @developerPreview 21.0
480+
*
481+
* @see [Tabs](guide/aria/tabs)
482+
* @see [Selection follows focus](guide/aria/tabs#selection-follows-focus)
483+
* @see [Manual activation](guide/aria/tabs#manual-activation)
484+
* @see [Vertical tab](guide/aria/tabs#vertical-tabs)
485+
* @see [Lazy content rendering](guide/aria/tabs#lazy-content-rendering)
486+
* @see [Disabled tabs](guide/aria/tabs#disabled-tabs)
487+
*
448488
*/
449489
@Directive({
450490
selector: 'ng-template[ngTabContent]',

‎src/aria/toolbar/toolbar.ts‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,14 @@ function sortDirectives(a: HasElement, b: HasElement) {
6161
* ```
6262
*
6363
* @developerPreview 21.0
64+
*
65+
* @see [Toolbar](guide/aria/toolbar)
66+
* @see [Basic horizontal toolbar](guide/aria/toolbar#basic-horizontal-toolbar)
67+
* @see [Vertical toolbar](guide/aria/toolbar#vertical-toolbar)
68+
* @see [Widget groups](guide/aria/toolbar#widget-groups)
69+
* @see [Disabled widgets](guide/aria/toolbar#disabled-widgets)
70+
* @see [Right-to-left (RTL) support](guide/aria/toolbar#right-to-left-rtl-support)
71+
*
6472
*/
6573
@Directive({
6674
selector: '[ngToolbar]',
@@ -182,6 +190,13 @@ export class Toolbar<V> {
182190
* ```
183191
*
184192
* @developerPreview 21.0
193+
*
194+
* @see [Toolbar](guide/aria/toolbar)
195+
* @see [Basic horizontal toolbar](guide/aria/toolbar#basic-horizontal-toolbar)
196+
* @see [Vertical toolbar](guide/aria/toolbar#vertical-toolbar)
197+
* @see [Widget groups](guide/aria/toolbar#widget-groups)
198+
* @see [Disabled widgets](guide/aria/toolbar#disabled-widgets)
199+
* @see [Right-to-left (RTL) support](guide/aria/toolbar#right-to-left-rtl-support)
185200
*/
186201
@Directive({
187202
selector: '[ngToolbarWidget]',
@@ -257,6 +272,13 @@ export class ToolbarWidget<V> implements OnInit, OnDestroy {
257272
* that have their own internal navigation.
258273
*
259274
* @developerPreview 21.0
275+
*
276+
* @see [Toolbar](guide/aria/toolbar)
277+
* @see [Basic horizontal toolbar](guide/aria/toolbar#basic-horizontal-toolbar)
278+
* @see [Vertical toolbar](guide/aria/toolbar#vertical-toolbar)
279+
* @see [Widget groups](guide/aria/toolbar#widget-groups)
280+
* @see [Disabled widgets](guide/aria/toolbar#disabled-widgets)
281+
* @see [Right-to-left (RTL) support](guide/aria/toolbar#right-to-left-rtl-support)
260282
*/
261283
@Directive({
262284
selector: '[ngToolbarWidgetGroup]',

0 commit comments

Comments
 (0)