Skip to content

Commit 94a50a2

Browse files
authored
refactor(multiple): rename values to value for signal forms compatibility (#33012)
* refactor(multiple): rename values to value for signal forms compatibility Renames the values signal/model to value across ARIA components (Combobox, Listbox, Tree, Menu, Toolbar, Select) to ensure better compatibility with signal forms. BREAKING CHANGE: Renames the values input/model to value in Combobox, Listbox, Tree, Menu, Toolbar, and Select. Users must update their templates to use the value property instead of values. * refactor(multiple): update api goldens
1 parent 5b010dc commit 94a50a2

File tree

41 files changed

+714
-762
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+714
-762
lines changed

goldens/aria/listbox/index.api.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,10 @@ export class Listbox<V> {
2828
softDisabled: _angular_core.InputSignalWithTransform<boolean, unknown>;
2929
protected textDirection: _angular_core.Signal<_angular_cdk_bidi.Direction>;
3030
typeaheadDelay: _angular_core.InputSignal<number>;
31-
values: _angular_core.ModelSignal<V[]>;
31+
value: _angular_core.ModelSignal<V[]>;
3232
wrap: _angular_core.InputSignalWithTransform<boolean, unknown>;
3333
// (undocumented)
34-
static ɵdir: _angular_core.ɵɵDirectiveDeclaration<Listbox<any>, "[ngListbox]", ["ngListbox"], { "id": { "alias": "id"; "required": false; "isSignal": true; }; "orientation": { "alias": "orientation"; "required": false; "isSignal": true; }; "multi": { "alias": "multi"; "required": false; "isSignal": true; }; "wrap": { "alias": "wrap"; "required": false; "isSignal": true; }; "softDisabled": { "alias": "softDisabled"; "required": false; "isSignal": true; }; "focusMode": { "alias": "focusMode"; "required": false; "isSignal": true; }; "selectionMode": { "alias": "selectionMode"; "required": false; "isSignal": true; }; "typeaheadDelay": { "alias": "typeaheadDelay"; "required": false; "isSignal": true; }; "disabled": { "alias": "disabled"; "required": false; "isSignal": true; }; "readonly": { "alias": "readonly"; "required": false; "isSignal": true; }; "values": { "alias": "values"; "required": false; "isSignal": true; }; }, { "values": "valuesChange"; }, ["_options"], never, true, [{ directive: typeof ComboboxPopup; inputs: {}; outputs: {}; }]>;
34+
static ɵdir: _angular_core.ɵɵDirectiveDeclaration<Listbox<any>, "[ngListbox]", ["ngListbox"], { "id": { "alias": "id"; "required": false; "isSignal": true; }; "orientation": { "alias": "orientation"; "required": false; "isSignal": true; }; "multi": { "alias": "multi"; "required": false; "isSignal": true; }; "wrap": { "alias": "wrap"; "required": false; "isSignal": true; }; "softDisabled": { "alias": "softDisabled"; "required": false; "isSignal": true; }; "focusMode": { "alias": "focusMode"; "required": false; "isSignal": true; }; "selectionMode": { "alias": "selectionMode"; "required": false; "isSignal": true; }; "typeaheadDelay": { "alias": "typeaheadDelay"; "required": false; "isSignal": true; }; "disabled": { "alias": "disabled"; "required": false; "isSignal": true; }; "readonly": { "alias": "readonly"; "required": false; "isSignal": true; }; "value": { "alias": "value"; "required": false; "isSignal": true; }; }, { "value": "valueChange"; }, ["_options"], never, true, [{ directive: typeof ComboboxPopup; inputs: {}; outputs: {}; }]>;
3535
// (undocumented)
3636
static ɵfac: _angular_core.ɵɵFactoryDeclaration<Listbox<any>, never>;
3737
}

goldens/aria/menu/index.api.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,10 +47,10 @@ export class MenuBar<V> {
4747
readonly softDisabled: _angular_core.InputSignalWithTransform<boolean, unknown>;
4848
readonly textDirection: _angular_core.WritableSignal<_angular_cdk_bidi.Direction>;
4949
readonly typeaheadDelay: _angular_core.InputSignal<number>;
50-
readonly values: _angular_core.ModelSignal<V[]>;
50+
readonly value: _angular_core.ModelSignal<V[]>;
5151
readonly wrap: _angular_core.InputSignalWithTransform<boolean, unknown>;
5252
// (undocumented)
53-
static ɵdir: _angular_core.ɵɵDirectiveDeclaration<MenuBar<any>, "[ngMenuBar]", ["ngMenuBar"], { "disabled": { "alias": "disabled"; "required": false; "isSignal": true; }; "softDisabled": { "alias": "softDisabled"; "required": false; "isSignal": true; }; "values": { "alias": "values"; "required": false; "isSignal": true; }; "wrap": { "alias": "wrap"; "required": false; "isSignal": true; }; "typeaheadDelay": { "alias": "typeaheadDelay"; "required": false; "isSignal": true; }; }, { "values": "valuesChange"; "itemSelected": "itemSelected"; }, ["_allItems"], never, true, never>;
53+
static ɵdir: _angular_core.ɵɵDirectiveDeclaration<MenuBar<any>, "[ngMenuBar]", ["ngMenuBar"], { "disabled": { "alias": "disabled"; "required": false; "isSignal": true; }; "softDisabled": { "alias": "softDisabled"; "required": false; "isSignal": true; }; "value": { "alias": "value"; "required": false; "isSignal": true; }; "wrap": { "alias": "wrap"; "required": false; "isSignal": true; }; "typeaheadDelay": { "alias": "typeaheadDelay"; "required": false; "isSignal": true; }; }, { "value": "valueChange"; "itemSelected": "itemSelected"; }, ["_allItems"], never, true, never>;
5454
// (undocumented)
5555
static ɵfac: _angular_core.ɵɵFactoryDeclaration<MenuBar<any>, never>;
5656
}

goldens/aria/private/index.api.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -512,7 +512,7 @@ export class MenuBarPattern<V> {
512512
}
513513

514514
// @public
515-
export interface MenuInputs<V> extends Omit<ListInputs<MenuItemPattern<V>, V>, 'values'> {
515+
export interface MenuInputs<V> extends Omit<ListInputs<MenuItemPattern<V>, V>, 'value'> {
516516
expansionDelay: SignalLike<number>;
517517
id: SignalLike<string>;
518518
items: SignalLike<MenuItemPattern<V>[]>;
@@ -902,7 +902,7 @@ export class TreePattern<V> implements TreeInputs<V> {
902902
readonly typeaheadDelay: SignalLike<number>;
903903
readonly typeaheadRegexp: RegExp;
904904
validate(): string[];
905-
readonly values: WritableSignalLike<V[]>;
905+
readonly value: WritableSignalLike<V[]>;
906906
readonly visible: () => boolean;
907907
readonly wrap: SignalLike<boolean>;
908908
}

goldens/aria/toolbar/index.api.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,10 @@ export class Toolbar<V> {
2525
readonly textDirection: _angular_core.WritableSignal<_angular_cdk_bidi.Direction>;
2626
// (undocumented)
2727
_unregister(widget: ToolbarWidget<V>): void;
28-
readonly values: _angular_core.ModelSignal<V[]>;
28+
readonly value: _angular_core.ModelSignal<V[]>;
2929
readonly wrap: _angular_core.InputSignalWithTransform<boolean, unknown>;
3030
// (undocumented)
31-
static ɵdir: _angular_core.ɵɵDirectiveDeclaration<Toolbar<any>, "[ngToolbar]", ["ngToolbar"], { "orientation": { "alias": "orientation"; "required": false; "isSignal": true; }; "softDisabled": { "alias": "softDisabled"; "required": false; "isSignal": true; }; "disabled": { "alias": "disabled"; "required": false; "isSignal": true; }; "wrap": { "alias": "wrap"; "required": false; "isSignal": true; }; "values": { "alias": "values"; "required": false; "isSignal": true; }; }, { "values": "valuesChange"; }, never, never, true, never>;
31+
static ɵdir: _angular_core.ɵɵDirectiveDeclaration<Toolbar<any>, "[ngToolbar]", ["ngToolbar"], { "orientation": { "alias": "orientation"; "required": false; "isSignal": true; }; "softDisabled": { "alias": "softDisabled"; "required": false; "isSignal": true; }; "disabled": { "alias": "disabled"; "required": false; "isSignal": true; }; "wrap": { "alias": "wrap"; "required": false; "isSignal": true; }; "value": { "alias": "value"; "required": false; "isSignal": true; }; }, { "value": "valueChange"; }, never, never, true, never>;
3232
// (undocumented)
3333
static ɵfac: _angular_core.ɵɵFactoryDeclaration<Toolbar<any>, never>;
3434
}

goldens/aria/tree/index.api.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,10 @@ export class Tree<V> {
3434
readonly typeaheadDelay: _angular_core.InputSignal<number>;
3535
// (undocumented)
3636
_unregister(child: TreeItem<V>): void;
37-
readonly values: _angular_core.ModelSignal<V[]>;
37+
readonly value: _angular_core.ModelSignal<V[]>;
3838
readonly wrap: _angular_core.InputSignalWithTransform<boolean, unknown>;
3939
// (undocumented)
40-
static ɵdir: _angular_core.ɵɵDirectiveDeclaration<Tree<any>, "[ngTree]", ["ngTree"], { "id": { "alias": "id"; "required": false; "isSignal": true; }; "orientation": { "alias": "orientation"; "required": false; "isSignal": true; }; "multi": { "alias": "multi"; "required": false; "isSignal": true; }; "disabled": { "alias": "disabled"; "required": false; "isSignal": true; }; "selectionMode": { "alias": "selectionMode"; "required": false; "isSignal": true; }; "focusMode": { "alias": "focusMode"; "required": false; "isSignal": true; }; "wrap": { "alias": "wrap"; "required": false; "isSignal": true; }; "softDisabled": { "alias": "softDisabled"; "required": false; "isSignal": true; }; "typeaheadDelay": { "alias": "typeaheadDelay"; "required": false; "isSignal": true; }; "values": { "alias": "values"; "required": false; "isSignal": true; }; "nav": { "alias": "nav"; "required": false; "isSignal": true; }; "currentType": { "alias": "currentType"; "required": false; "isSignal": true; }; }, { "values": "valuesChange"; }, never, never, true, [{ directive: typeof ComboboxPopup; inputs: {}; outputs: {}; }]>;
40+
static ɵdir: _angular_core.ɵɵDirectiveDeclaration<Tree<any>, "[ngTree]", ["ngTree"], { "id": { "alias": "id"; "required": false; "isSignal": true; }; "orientation": { "alias": "orientation"; "required": false; "isSignal": true; }; "multi": { "alias": "multi"; "required": false; "isSignal": true; }; "disabled": { "alias": "disabled"; "required": false; "isSignal": true; }; "selectionMode": { "alias": "selectionMode"; "required": false; "isSignal": true; }; "focusMode": { "alias": "focusMode"; "required": false; "isSignal": true; }; "wrap": { "alias": "wrap"; "required": false; "isSignal": true; }; "softDisabled": { "alias": "softDisabled"; "required": false; "isSignal": true; }; "typeaheadDelay": { "alias": "typeaheadDelay"; "required": false; "isSignal": true; }; "value": { "alias": "value"; "required": false; "isSignal": true; }; "nav": { "alias": "nav"; "required": false; "isSignal": true; }; "currentType": { "alias": "currentType"; "required": false; "isSignal": true; }; }, { "value": "valueChange"; }, never, never, true, [{ directive: typeof ComboboxPopup; inputs: {}; outputs: {}; }]>;
4141
// (undocumented)
4242
static ɵfac: _angular_core.ɵɵFactoryDeclaration<Tree<any>, never>;
4343
}

0 commit comments

Comments
 (0)