8000 fix(forms): provide a method to compare options by DzmitryShylovich · Pull Request #13349 · angular/angular · GitHub
[go: up one dir, main page]
Skip to content

fix(forms): provide a method to compare options #13349

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

Jump to bottom
Closed
wants to merge 1 commit into from
Closed

fix(forms): provide a method to compare options #13349

wants to merge 1 commit into from

Conversation

DzmitryShylovich
Copy link
Contributor
@DzmitryShylovich DzmitryShylovich commented Dec 9, 2016 •
edited
Loading

Closes #13268 and #13274 / #13828 / #13884 #14121
Usage:

<select [compareWith]="equals"  [(ngModel)]="selectedCountries">
   <option *ngFor="let country of countries" [ngValue]="country">
      {{country.name}}
   </option>
</select>

equals(o1: Country, o2: Country) {
   return o1.id === o2.id;
}

@vicb vicb added area: forms action: review The PR is still awaiting reviews from at least one requested reviewer labels Dec 9, 2016
vicb
vicb reviewed Dec 9, 2016
View reviewed changes
modules/@angular/forms/src/directives/select_control_value_accessor.ts
@@ -82,6 +82,8 @@ export class SelectControlValueAccessor implements ControlValueAccessor {
onChange = (_: any) => {};
onTouched = () => {};

@Input() ngEquals: (o1: any, o2: any) => boolean = looseIdentical;
Copy link
Contributor

Choose a reason for hiding this comment

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

compareOptions/ equalOptions ?
compare implies 1, 0, -1 return... probably overkill.

Copy link
Contributor Author
@DzmitryShylovich DzmitryShylovich Dec 9, 2016 •
edited
Loading

Choose a reason for hiding this comment

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

compare implies 1, 0, -1 return

yeah, this is why I chose equals. We don't need to sort it.

@vicb
Copy link
Contributor
vicb commented Dec 9, 2016

LGTM, @kara could you please review ?

@DzmitryShylovich DzmitryShylovich force-pushed the gh/13295 branch 3 times, most recently from c6523b6 to 52ff71f Compare December 9, 2016 23:26
kara
kara suggested changes Dec 12, 2016
View reviewed changes
Copy link
Contributor
@kara kara left a comment

Choose a reason for hiding this comment

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

Can you also add a test for this?

modules/@angular/forms/src/directives/select_control_value_accessor.ts
@@ -82,6 +82,8 @@ export class SelectControlValueAccessor implements ControlValueAccessor {
onChange = (_: any) => {};
onTouched = () => {};

@Input() equalOptions: (o1: any, o2: any) => boolean = looseIdentical;
Copy link
Contributor

Choose a reason for hiding this comment

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

Hmm, I like the idea of an optional equality method, but I don't think this name is very intuitive. Perhaps compareWith? Discussed with @StephenFluin and we think that might fit the use case better.

<select [compareWith]="compareFn" [(ngModel)]="someProp">
   ...
</select>

@kara kara added action: cleanup The PR is in need of cleanup, either due to needing a rebase or in response to comments from reviews and removed action: review The PR is still awaiting reviews from at least one requested reviewer labels Dec 12, 2016
@DzmitryShylovich DzmitryShylovich force-pushed the gh/13295 branch 7 times, most recently from b359466 to c253668 Compare December 16, 2016 12:47
@DzmitryShylovich DzmitryShylovich changed the title fix(forms): provide a method to compare options [WIP] fix(forms): provide a method to compare options Dec 19, 2016
@DzmitryShylovich DzmitryShylovich changed the title [WIP] fix(forms): provide a method to compare options fix(forms): provide a method to compare options Jan 13, 2017
@DzmitryShylovich
Copy link
Contributor Author

@kara ready for review

This was referenced Jan 24, 2017
Closed
Closed
@jelbourn jelbourn mentioned this pull request Jan 27, 2017
Open
kara
kara approved these changes Jan 30, 2017
View reviewed changes
Copy link
Contributor
@kara kara left a comment

Choose a reason for hiding this comment

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

LGTM

@kara kara added action: merge The PR is ready for merge by the caretaker and removed action: cleanup The PR is in need of cleanup, either due to needing a rebase or in response to comments from reviews labels Jan 30, 2017
@mhevery mhevery closed this in f89d004 Jan 31, 2017
@DzmitryShylovich DzmitryShylovich deleted the gh/13295 branch January 31, 2017 23:13
asnowwolf pushed a commit to asnowwolf/angular that referenced this pull request Aug 11, 2017
fix(forms): provide a method to compare options (angular#13349)
4bd444f 
Closes angular#13268

PR Close angular#13349
juleskremer pushed a commit to juleskremer/angular that referenced this pull request Aug 28, 2017
@juleskremer
fix(forms): provide a method to compare options (angular#13349)
4432324 
Closes angular#13268

PR Close angular#13349
@JosephBL
Copy link
JosephBL commented Oct 2, 2017

Is a release date known for this feature? It would help a lot :)

@another-guy
Copy link

@JosephBL this feature has been released for many months. (since 4.0.0-beta.6 : https://github.com/angular/angular/blob/master/CHANGELOG.md#400-beta6-2017-02-03 "forms: provide a method to compare options (#13349) (f89d004), closes #13268" )

@JosephBL
Copy link
JosephBL commented Oct 9, 2017

Thanks a lot, I somehow missed it :$

@rawatfeb
Copy link

Thanks a lot

@chinthu
Copy link
chinthu commented Apr 6, 2018

Faced an issue with this compare, if the select is inside the form /formgroup, with name , compare is not working

@marticrespi
Copy link

As @chinthu said, if the select is in a form the compare function doesn't work properly.

@angular-automatic-lock-bot
Copy link

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

This action has been performed automatically by a bot.

@angular-automatic-lock-bot angular-automatic-lock-bot bot locked and limited conversation to collaborators Sep 13, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@vicb vicb vicb left review comments

@mhevery mhevery mhevery approved these changes

@kara kara kara approved these changes

Assignees
No one assigned
Labels
action: merge The PR is ready for merge by the caretaker area: forms cla: yes
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Provide customizable object comparison method for NgModel
10 participants
@DzmitryShylovich @vicb @JosephBL @another-guy @rawatfeb @chinthu @marticrespi @mhevery @kara @googlebot
0