Skip to content

Commit a00b489

Browse files
crisbetocrisbeto
authored
build: set up API goldens for aria (#32441)
Sets up API golden testing for the Aria package.
1 parent 2c0ba8d commit a00b489

File tree

11 files changed

+1690
-0
lines changed

11 files changed

+1690
-0
lines changed

‎goldens/BUILD.bazel‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,3 +39,12 @@ api_golden_test_npm_package(
3939
"//:node_modules/@types/youtube": "youtube",
4040
},
4141
)
42+
43+
api_golden_test_npm_package(
44+
name = "aria_api",
45+
data = glob(["aria/**"]) + [
46+
"//src/aria:npm_package",
47+
],
48+
golden_dir = "goldens/aria",
49+
npm_package = "src/aria/npm_package",
50+
)

‎goldens/aria/accordion/index.api.md‎

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
## API Report File for "@angular/aria_accordion"
2+
3+
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4+
5+
```ts
6+
7+
import { AccordionGroupPattern } from '@angular/aria/private';
8+
import { AccordionPanelPattern } from '@angular/aria/private';
9+
import { AccordionTriggerPattern } from '@angular/aria/private';
10+
import * as _angular_cdk_bidi from '@angular/cdk/bidi';
11+
import * as _angular_core from '@angular/core';
12+
import * as i1 from '@angular/aria/private';
13+
import { WritableSignal } from '@angular/core';
14+
15+
// @public
16+
export class AccordionContent {
17+
// (undocumented)
18+
static ɵdir: _angular_core.ɵɵDirectiveDeclaration<AccordionContent, "ng-template[ngAccordionContent]", never, {}, {}, never, never, true, [{ directive: typeof i1.DeferredContent; inputs: {}; outputs: {}; }]>;
19+
// (undocumented)
20+
static ɵfac: _angular_core.ɵɵFactoryDeclaration<AccordionContent, never>;
21+
}
22+
23+
// @public
24+
export class AccordionGroup {
25+
constructor();
26+
collapseAll(): void;
27+
readonly disabled: _angular_core.InputSignalWithTransform<boolean, unknown>;
28+
readonly element: HTMLElement;
29+
expandAll(): void;
30+
readonly multiExpandable: _angular_core.InputSignalWithTransform<boolean, unknown>;
31+
readonly _pattern: AccordionGroupPattern;
32+
readonly softDisabled: _angular_core.InputSignalWithTransform<boolean, unknown>;
33+
readonly textDirection: WritableSignal<_angular_cdk_bidi.Direction>;
34+
readonly wrap: _angular_core.InputSignalWithTransform<boolean, unknown>;
35+
// (undocumented)
36+
static ɵdir: _angular_core.ɵɵDirectiveDeclaration<AccordionGroup, "[ngAccordionGroup]", ["ngAccordionGroup"], { "disabled": { "alias": "disabled"; "required": false; "isSignal": true; }; "multiExpandable": { "alias": "multiExpandable"; "required": false; "isSignal": true; }; "softDisabled": { "alias": "softDisabled"; "required": false; "isSignal": true; }; "wrap": { "alias": "wrap"; "required": false; "isSignal": true; }; }, {}, ["_triggers", "_panels"], never, true, never>;
37+
// (undocumented)
38+
static ɵfac: _angular_core.ɵɵFactoryDeclaration<AccordionGroup, never>;
39+
}
40+
41+
// @public
42+
export class AccordionPanel {
43+
constructor();
44+
readonly _accordionTriggerPattern: WritableSignal<AccordionTriggerPattern | undefined>;
45+
collapse(): void;
46+
expand(): void;
47+
readonly id: _angular_core.InputSignal<string>;
48+
readonly panelId: _angular_core.InputSignal<string>;
49+
readonly _pattern: AccordionPanelPattern;
50+
toggle(): void;
51+
readonly visible: _angular_core.Signal<boolean>;
52+
// (undocumented)
53+
static ɵdir: _angular_core.ɵɵDirectiveDeclaration<AccordionPanel, "[ngAccordionPanel]", ["ngAccordionPanel"], { "id": { "alias": "id"; "required": false; "isSignal": true; }; "panelId": { "alias": "panelId"; "required": true; "isSignal": true; }; }, {}, never, never, true, [{ directive: typeof i1.DeferredContentAware; inputs: { "preserveContent": "preserveContent"; }; outputs: {}; }]>;
54+
// (undocumented)
55+
static ɵfac: _angular_core.ɵɵFactoryDeclaration<AccordionPanel, never>;
56+
}
57+
58+
// @public
59+
export class AccordionTrigger {
60+
readonly _accordionPanelPattern: WritableSignal<AccordionPanelPattern | undefined>;
61+
readonly active: _angular_core.Signal<boolean>;
62+
collapse(): void;
63+
readonly disabled: _angular_core.InputSignalWithTransform<boolean, unknown>;
64+
readonly element: HTMLElement;
65+
expand(): void;
66+
readonly expanded: _angular_core.ModelSignal<boolean>;
67+
readonly id: _angular_core.InputSignal<string>;
68+
readonly panelId: _angular_core.InputSignal<string>;
69+
readonly _pattern: AccordionTriggerPattern;
70+
toggle(): void;
71+
// (undocumented)
72+
static ɵdir: _angular_core.ɵɵDirectiveDeclaration<AccordionTrigger, "[ngAccordionTrigger]", ["ngAccordionTrigger"], { "id": { "alias": "id"; "required": false; "isSignal": true; }; "panelId": { "alias": "panelId"; "required": true; "isSignal": true; }; "disabled": { "alias": "disabled"; "required": false; "isSignal": true; }; "expanded": { "alias": "expanded"; "required": false; "isSignal": true; }; }, { "expanded": "expandedChange"; }, never, never, true, never>;
73+
// (undocumented)
74+
static ɵfac: _angular_core.ɵɵFactoryDeclaration<AccordionTrigger, never>;
75+
}
76+
77+
// (No @packageDocumentation comment for this package)
78+
79+
```

‎goldens/aria/combobox/index.api.md‎

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
## API Report File for "@angular/aria_combobox"
2+
3+
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4+
5+
```ts
6+
7+
import * as _angular_cdk_bidi from '@angular/cdk/bidi';
8+
import * as _angular_core from '@angular/core';
9+
import { ComboboxDialogPattern } from '@angular/aria/private';
10+
import { ComboboxListboxControls } from '@angular/aria/private';
11+
import { ComboboxPattern } from '@angular/aria/private';
12+
import { ComboboxTreeControls } from '@angular/aria/private';
13+
import * as i1 from '@angular/aria/private';
14+
import { WritableSignal } from '@angular/core';
15+
16+
// @public
17+
export class Combobox<V> {
18+
constructor();
19+
readonly alwaysExpanded: _angular_core.InputSignalWithTransform<boolean, unknown>;
20+
close(): void;
21+
readonly disabled: _angular_core.InputSignalWithTransform<boolean, unknown>;
22+
readonly element: HTMLElement;
23+
readonly expanded: _angular_core.Signal<boolean>;
24+
filterMode: _angular_core.InputSignal<"manual" | "auto-select" | "highlight">;
25+
readonly firstMatch: _angular_core.InputSignal<V | undefined>;
26+
readonly inputElement: _angular_core.Signal<HTMLInputElement | undefined>;
27+
open(): void;
28+
readonly _pattern: ComboboxPattern<any, V>;
29+
readonly popup: _angular_core.Signal<ComboboxPopup<V> | undefined>;
30+
readonly readonly: _angular_core.InputSignalWithTransform<boolean, unknown>;
31+
protected textDirection: _angular_core.Signal<_angular_cdk_bidi.Direction>;
32+
// (undocumented)
33+
static ɵdir: _angular_core.ɵɵDirectiveDeclaration<Combobox<any>, "[ngCombobox]", ["ngCombobox"], { "filterMode": { "alias": "filterMode"; "required": false; "isSignal": true; }; "disabled": { "alias": "disabled"; "required": false; "isSignal": true; }; "readonly": { "alias": "readonly"; "required": false; "isSignal": true; }; "firstMatch": { "alias": "firstMatch"; "required": false; "isSignal": true; }; "alwaysExpanded": { "alias": "alwaysExpanded"; "required": false; "isSignal": true; }; }, {}, ["popup"], never, true, [{ directive: typeof i1.DeferredContentAware; inputs: { "preserveContent": "preserveContent"; }; outputs: {}; }]>;
34+
// (undocumented)
35+
static ɵfac: _angular_core.ɵɵFactoryDeclaration<Combobox<any>, never>;
36+
}
37+
38+
// @public
39+
export class ComboboxDialog {
40+
constructor();
41+
// (undocumented)
42+
close(): void;
43+
readonly combobox: Combobox<any>;
44+
readonly element: HTMLElement;
45+
// (undocumented)
46+
_pattern: ComboboxDialogPattern;
47+
// (undocumented)
48+
static ɵdir: _angular_core.ɵɵDirectiveDeclaration<ComboboxDialog, "dialog[ngComboboxDialog]", ["ngComboboxDialog"], {}, {}, never, never, true, [{ directive: typeof ComboboxPopup; inputs: {}; outputs: {}; }]>;
49+
// (undocumented)
50+
static ɵfac: _angular_core.ɵɵFactoryDeclaration<ComboboxDialog, never>;
51+
}
52+
53+
// @public
54+
export class ComboboxInput {
55+
constructor();
56+
readonly combobox: Combobox<any>;
57+
readonly element: HTMLElement;
58+
value: _angular_core.ModelSignal<string>;
59+
// (undocumented)
60+
static ɵdir: _angular_core.ɵɵDirectiveDeclaration<ComboboxInput, "input[ngComboboxInput]", ["ngComboboxInput"], { "value": { "alias": "value"; "required": false; "isSignal": true; }; }, { "value": "valueChange"; }, never, never, true, never>;
61+
// (undocumented)
62+
static ɵfac: _angular_core.ɵɵFactoryDeclaration<ComboboxInput, never>;
63+
}
64+
65+
// @public
66+
export class ComboboxPopup<V> {
67+
readonly combobox: Combobox<V> | null;
68+
readonly _controls: WritableSignal<ComboboxDialogPattern | ComboboxListboxControls<any, V> | ComboboxTreeControls<any, V> | undefined>;
69+
// (undocumented)
70+
static ɵdir: _angular_core.ɵɵDirectiveDeclaration<ComboboxPopup<any>, "[ngComboboxPopup]", ["ngComboboxPopup"], {}, {}, never, never, true, never>;
71+
// (undocumented)
72+
static ɵfac: _angular_core.ɵɵFactoryDeclaration<ComboboxPopup<any>, never>;
73+
}
74+
75+
// @public
76+
export class ComboboxPopupContainer {
77+
// (undocumented)
78+
static ɵdir: _angular_core.ɵɵDirectiveDeclaration<ComboboxPopupContainer, "ng-template[ngComboboxPopupContainer]", ["ngComboboxPopupContainer"], {}, {}, never, never, true, [{ directive: typeof i1.DeferredContent; inputs: {}; outputs: {}; }]>;
79+
// (undocumented)
80+
static ɵfac: _angular_core.ɵɵFactoryDeclaration<ComboboxPopupContainer, never>;
81+
}
82+
83+
// (No @packageDocumentation comment for this package)
84+
85+
```

‎goldens/aria/grid/index.api.md‎

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
## API Report File for "@angular/aria_grid"
2+
3+
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4+
5+
```ts
6+
7+
import * as _angular_cdk_bidi from '@angular/cdk/bidi';
8+
import * as _angular_core from '@angular/core';
9+
import { ElementRef } from '@angular/core';
10+
import { Signal } from '@angular/core';
11+
import { WritableSignal } from '@angular/core';
12+
13+
// @public
14+
export class Grid {
15+
constructor();
16+
readonly colWrap: _angular_core.InputSignal<"continuous" | "loop" | "nowrap">;
17+
readonly disabled: _angular_core.InputSignalWithTransform<boolean, unknown>;
18+
readonly element: HTMLElement;
19+
readonly enableRangeSelection: _angular_core.InputSignalWithTransform<boolean, unknown>;
20+
readonly enableSelection: _angular_core.InputSignalWithTransform<boolean, unknown>;
21+
readonly focusMode: _angular_core.InputSignal<"roving" | "activedescendant">;
22+
readonly multi: _angular_core.InputSignalWithTransform<boolean, unknown>;
23+
readonly _pattern: GridPattern;
24+
readonly rowWrap: _angular_core.InputSignal<"continuous" | "loop" | "nowrap">;
25+
readonly selectionMode: _angular_core.InputSignal<"follow" | "explicit">;
26+
readonly softDisabled: _angular_core.InputSignalWithTransform<boolean, unknown>;
27+
readonly textDirection: _angular_core.WritableSignal<_angular_cdk_bidi.Direction>;
28+
// (undocumented)
29+
static ɵdir: _angular_core.ɵɵDirectiveDeclaration<Grid, "[ngGrid]", ["ngGrid"], { "enableSelection": { "alias": "enableSelection"; "required": false; "isSignal": true; }; "disabled": { "alias": "disabled"; "required": false; "isSignal": true; }; "softDisabled": { "alias": "softDisabled"; "required": false; "isSignal": true; }; "focusMode": { "alias": "focusMode"; "required": false; "isSignal": true; }; "rowWrap": { "alias": "rowWrap"; "required": false; "isSignal": true; }; "colWrap": { "alias": "colWrap"; "required": false; "isSignal": true; }; "multi": { "alias": "multi"; "required": false; "isSignal": true; }; "selectionMode": { "alias": "selectionMode"; "required": false; "isSignal": true; }; "enableRangeSelection": { "alias": "enableRangeSelection"; "required": false; "isSignal": true; }; }, {}, ["_rows"], never, true, never>;
30+
// (undocumented)
31+
static ɵfac: _angular_core.ɵɵFactoryDeclaration<Grid, never>;
32+
}
33+
34+
// @public
35+
export class GridCell {
36+
constructor();
37+
readonly active: Signal<boolean>;
38+
readonly colIndex: _angular_core.InputSignal<number | undefined>;
39+
readonly colSpan: _angular_core.InputSignal<number>;
40+
readonly disabled: _angular_core.InputSignalWithTransform<boolean, unknown>;
41+
readonly element: HTMLElement;
42+
readonly id: _angular_core.InputSignal<string>;
43+
readonly orientation: _angular_core.InputSignal<"vertical" | "horizontal">;
44+
readonly _pattern: GridCellPattern;
45+
readonly role: _angular_core.InputSignal<"gridcell" | "columnheader" | "rowheader">;
46+
readonly rowIndex: _angular_core.InputSignal<number | undefined>;
47+
readonly rowSpan: _angular_core.InputSignal<number>;
48+
readonly selectable: _angular_core.InputSignal<boolean>;
49+
readonly selected: _angular_core.ModelSignal<boolean>;
50+
protected readonly _tabIndex: Signal<number>;
51+
readonly tabindex: _angular_core.InputSignal<number | undefined>;
52+
readonly textDirection: _angular_core.WritableSignal<_angular_cdk_bidi.Direction>;
53+
readonly wrap: _angular_core.InputSignalWithTransform<boolean, unknown>;
54+
// (undocumented)
55+
static ɵdir: _angular_core.ɵɵDirectiveDeclaration<GridCell, "[ngGridCell]", ["ngGridCell"], { "id": { "alias": "id"; "required": false; "isSignal": true; }; "role": { "alias": "role"; "required": false; "isSignal": true; }; "rowSpan": { "alias": "rowSpan"; "required": false; "isSignal": true; }; "colSpan": { "alias": "colSpan"; "required": false; "isSignal": true; }; "rowIndex": { "alias": "rowIndex"; "required": false; "isSignal": true; }; "colIndex": { "alias": "colIndex"; "required": false; "isSignal": true; }; "disabled": { "alias": "disabled"; "required": false; "isSignal": true; }; "selected": { "alias": "selected"; "required": false; "isSignal": true; }; "selectable": { "alias": "selectable"; "required": false; "isSignal": true; }; "orientation": { "alias": "orientation"; "required": false; "isSignal": true; }; "wrap": { "alias": "wrap"; "required": false; "isSignal": true; }; "tabindex": { "alias": "tabindex"; "required": false; "isSignal": true; }; }, { "selected": "selectedChange"; }, ["_widgets"], never, true, never>;
56+
// (undocumented)
57+
static ɵfac: _angular_core.ɵɵFactoryDeclaration<GridCell, never>;
58+
}
59+
60+
// @public
61+
export class GridCellWidget {
62+
constructor();
63+
activate(): void;
64+
readonly active: Signal<boolean>;
65+
deactivate(): void;
66+
readonly disabled: _angular_core.InputSignalWithTransform<boolean, unknown>;
67+
readonly element: HTMLElement;
68+
readonly focusTarget: _angular_core.InputSignal<ElementRef<any> | HTMLElement | undefined>;
69+
readonly id: _angular_core.InputSignal<string>;
70+
get isActivated(): Signal<boolean>;
71+
readonly onActivate: _angular_core.OutputEmitterRef<KeyboardEvent | FocusEvent | undefined>;
72+
readonly onDeactivate: _angular_core.OutputEmitterRef<KeyboardEvent | FocusEvent | undefined>;
73+
readonly _pattern: GridCellWidgetPattern;
74+
protected readonly _tabIndex: Signal<number>;
75+
readonly tabindex: _angular_core.InputSignal<number | undefined>;
76+
readonly widgetType: _angular_core.InputSignal<"simple" | "complex" | "editable">;
77+
// (undocumented)
78+
static ɵdir: _angular_core.ɵɵDirectiveDeclaration<GridCellWidget, "[ngGridCellWidget]", ["ngGridCellWidget"], { "id": { "alias": "id"; "required": false; "isSignal": true; }; "widgetType": { "alias": "widgetType"; "required": false; "isSignal": true; }; "disabled": { "alias": "disabled"; "required": false; "isSignal": true; }; "focusTarget": { "alias": "focusTarget"; "required": false; "isSignal": true; }; "tabindex": { "alias": "tabindex"; "required": false; "isSignal": true; }; }, { "onActivate": "onActivate"; "onDeactivate": "onDeactivate"; }, never, never, true, never>;
79+
// (undocumented)
80+
static ɵfac: _angular_core.ɵɵFactoryDeclaration<GridCellWidget, never>;
81+
}
82+
83+
// @public
84+
export class GridRow {
85+
readonly element: HTMLElement;
86+
readonly _gridPattern: Signal<GridPattern>;
87+
readonly _pattern: GridRowPattern;
88+
readonly rowIndex: _angular_core.InputSignal<number | undefined>;
89+
// (undocumented)
90+
static ɵdir: _angular_core.ɵɵDirectiveDeclaration<GridRow, "[ngGridRow]", ["ngGridRow"], { "rowIndex": { "alias": "rowIndex"; "required": false; "isSignal": true; }; }, {}, ["_cells"], never, true, never>;
91+
// (undocumented)
92+
static ɵfac: _angular_core.ɵɵFactoryDeclaration<GridRow, never>;
93+
}
94+
95+
// (No @packageDocumentation comment for this package)
96+
97+
```

‎goldens/aria/index.api.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
## API Report File for "@angular/aria"
2+
3+
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4+
5+
```ts
6+
7+
import { Version } from '@angular/core';
8+
9+
// @public
10+
export const VERSION: Version;
11+
12+
// (No @packageDocumentation comment for this package)
13+
14+
```

0 commit comments

Comments
 (0)