-
Notifications
You must be signed in to change notification settings - Fork 6.8k
fix(api): updates the api to standard naming and adds docs for selection #8286
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.
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
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,34 @@ | ||
### Collections | ||
The `collections` package provides a set of utilities for managing collections. | ||
|
||
A set of utilities for managing collections. | ||
### `SelectionModel` | ||
`SelectionModel` is a utility for powering selection of one or more options from a list. | ||
This model is used in components such as the selection list, table selections and chip lists. | ||
|
||
#### Basic Usage | ||
```javascript | ||
const model = new SelectionModel( | ||
true, // multiple selection or not | ||
[2,1,3] // initial selected values | ||
); | ||
|
||
// select a value | ||
model.select(4); | ||
console.log(model.selected.length) //-> 4 | ||
|
||
// deselect a value | ||
model.deselect(4); | ||
console.log(model.selected.length) //-> 3 | ||
|
||
// toggle a value | ||
model.toggle(4); | ||
console.log(model.selected.length) //-> 4 | ||
|
||
// check for selection | ||
console.log(model.isSelected(4)) //-> true | ||
|
||
// sort the selections | ||
console.log(model.sort()) //-> [1,2,3,4] | ||
|
||
// listen for changes | ||
model.changes.subscribe(s => console.log(s)); | ||
``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -34,7 +34,14 @@ export class SelectionModel<T> { | |
} | ||
|
||
/** Event emitted when the value has changed. */ | ||
onChange: Subject<SelectionChange<T>> | null = this._emitChanges ? new Subject() : null; | ||
changed: Subject<SelectionChange<T>> | null = this._emitChanges ? new Subject() : null; | ||
|
||
/** | ||
* Event emitted when the value has changed. | ||
* @deprecated Use `changed` instead. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Need to add a deletion-target here (8.0) There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Done :) |
||
* @deletion-target 8.0.0 To be changed to `changed` | ||
*/ | ||
onChange: Subject<SelectionChange<T>> | null = this.changed; | ||
|
||
constructor( | ||
private _multiple = false, | ||
|
@@ -129,8 +136,8 @@ export class SelectionModel<T> { | |
this._selected = null; | ||
|
||
if (this._selectedToEmit.length || this._deselectedToEmit.length) { | ||
if (this.onChange) { | ||
this.onChange.next({ | ||
if (this.changed) { | ||
this.changed.next({ | ||
source: this, | ||
added: this._selectedToEmit, | ||
removed: this._deselectedToEmit | ||
|
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Didn't we land on
change
present-tense?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We landed on
myEventThingChange
but the rest of them ended up past tense.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Which things are
changed
?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A few I know of
selectedChanged
,_scrollDistanceChanged
and_selectedIndexChanged
. Let me know what you want to do.