Skip to content

refactor(material/core): Update internal state of option to use signals #29698

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
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

refactor(material/core): Update internal state of option to use signals #29698

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
38 changes: 17 additions & 21 deletions src/material/core/option/option.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ import {
QueryList,
ViewChild,
booleanAttribute,
signal,
} from '@angular/core';
import {Subject} from 'rxjs';
import {MAT_OPTGROUP, MatOptgroup} from './optgroup';
Expand Down Expand Up @@ -83,9 +84,9 @@ export class MatOptionSelectionChange<T = any> {
imports: [MatPseudoCheckbox, MatRipple],
})
export class MatOption<T = any> implements FocusableOption, AfterViewChecked, OnDestroy {
private _selected = false;
private _active = false;
private _disabled = false;
private _selected = signal(false);
private _active = signal(false);
private _disabled = signal(false);
private _mostRecentViewValue = '';

/** Whether the wrapping component is in multiple selection mode. */
Expand All @@ -95,7 +96,7 @@ export class MatOption<T = any> implements FocusableOption, AfterViewChecked, On

/** Whether or not the option is currently selected. */
get selected(): boolean {
return this._selected;
return this._selected();
}

/** The form value of the option. */
Expand All @@ -107,10 +108,10 @@ export class MatOption<T = any> implements FocusableOption, AfterViewChecked, On
/** Whether the option is disabled. */
@Input({transform: booleanAttribute})
get disabled(): boolean {
return (this.group && this.group.disabled) || this._disabled;
return (this.group && this.group.disabled) || this._disabled();
Copy link
Member

Choose a reason for hiding this comment

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

Should we migrate the group as well and turn this into a computed?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hmmm, that's a good thought. It would either require a "breaking" change to the public API of the group or to add a getter/setter pair there so I can set an internal signal.

}
set disabled(value: boolean) {
this._disabled = value;
this._disabled.set(value);
}

/** Whether ripples for the option are disabled. */
Expand Down Expand Up @@ -147,7 +148,7 @@ export class MatOption<T = any> implements FocusableOption, AfterViewChecked, On
* for components like autocomplete where focus must remain on the input.
*/
get active(): boolean {
return this._active;
return this._active();
}

/**
Expand All @@ -161,9 +162,8 @@ export class MatOption<T = any> implements FocusableOption, AfterViewChecked, On

/** Selects the option. */
select(emitEvent = true): void {
if (!this._selected) {
this._selected = true;
this._changeDetectorRef.markForCheck();
if (!this._selected()) {
this._selected.set(true);

if (emitEvent) {
this._emitSelectionChangeEvent();
Expand All @@ -173,9 +173,8 @@ export class MatOption<T = any> implements FocusableOption, AfterViewChecked, On

/** Deselects the option. */
deselect(emitEvent = true): void {
if (this._selected) {
this._selected = false;
this._changeDetectorRef.markForCheck();
if (this._selected()) {
this._selected.set(false);

if (emitEvent) {
this._emitSelectionChangeEvent();
Expand All @@ -200,9 +199,8 @@ export class MatOption<T = any> implements FocusableOption, AfterViewChecked, On
* events will display the proper options as active on arrow key events.
*/
setActiveStyles(): void {
if (!this._active) {
this._active = true;
this._changeDetectorRef.markForCheck();
if (!this._active()) {
this._active.set(true);
}
}

Expand All @@ -213,8 +211,7 @@ export class MatOption<T = any> implements FocusableOption, AfterViewChecked, On
*/
setInactiveStyles(): void {
if (this._active) {
this._active = false;
this._changeDetectorRef.markForCheck();
this._active.set(false);
}
}

Expand All @@ -239,8 +236,7 @@ export class MatOption<T = any> implements FocusableOption, AfterViewChecked, On
*/
_selectViaInteraction(): void {
if (!this.disabled) {
this._selected = this.multiple ? !this._selected : true;
this._changeDetectorRef.markForCheck();
this._selected.set(this.multiple ? !this._selected() : true);
this._emitSelectionChangeEvent(true);
}
}
Expand All @@ -264,7 +260,7 @@ export class MatOption<T = any> implements FocusableOption, AfterViewChecked, On
// we have to check for changes in the DOM ourselves and dispatch an event. These checks are
// relatively cheap, however we still limit them only to selected options in order to avoid
// hitting the DOM too often.
if (this._selected) {
if (this._selected()) {
const viewValue = this.viewValue;

if (viewValue !== this._mostRecentViewValue) {
Expand Down
Loading