docs(select): fix Objects as Values docs #22143
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fix the Objects as Values documentation to add the necessary value
property to the template, simplify the compare function, and add an
interface for type checking.
Add an Objects as Values with Multiple Selection documentation section
to show the difference with the compare function which needs to
determine if an object is in the array of selected objects
This fixes an issue noted in the forums at https://forum.ionicframework.com/t/ionic-5-ion-select-objects-as-values-not-working/191807/2
Pull request checklist
Please check if your PR fulfills the following requirements:
npm run build) was run locally and any changes were pushednpm run lint) has passed locally and any fixes were made for failuresPull request type
Please check the type of change your PR introduces:
What is the current behavior?
Issue Number: https://forum.ionicframework.com/t/ionic-5-ion-select-objects-as-values-not-working/191807/2
What is the new behavior?
Does this introduce a breaking change?
Other information
This shows the proper addition of a
valueproperty to the template, fixing the issue brought up in https://forum.ionicframework.com/t/ionic-5-ion-select-objects-as-values-not-working/191807/2 where the sample comparison function fails (checks all items)The addition of an example for multiple selection of objects fixes the issue that the sample compare function (for single select) doesn't select any options when re-opening the select because the second parameter (
o2in the sample) is an array.