Skip to content

Commit 86f2a7a

Browse files
ViktorSlavovViktorSlavov
committed
docs(combo): update docs for combo IComboSelectionChangeEvents, #5523
# Conflicts: # CHANGELOG.md
1 parent f364093 commit 86f2a7a

File tree

2 files changed

+52
-10
lines changed

2 files changed

+52
-10
lines changed

‎CHANGELOG.md‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,53 @@
22

33
All notable changes for each version of this project will be documented in this file.
44

5+
## 8.2.0
6+
- `IgxCombo`
7+
- Combo `onSelectionChange` events now emits the item(s) that were added to or removed from the collection:
8+
```html
9+
<igx-combo (onSelectionChange)="handleChange($event)">
10+
```
11+
```typescript
12+
export class Example {
13+
...
14+
handleChange(event: {
15+
newSelection: any[],
16+
oldSelection: any[],
17+
added: any[], // the items added to the selection in this change
18+
removed: any[], // the items removed for the selection in this change
19+
...
20+
}) {
21+
console.log("Items added: ", [...event.added]);
22+
console.log("Items removed: ", [...event.removed]);
23+
}
24+
}
25+
```
26+
527
## 8.1.2
628

729
### New Features
830
- `IgxDatePicker`
931
- `valueChange` event is added.
32+
- `IgxCombo`
33+
- Combo `onSelectionChange` events now emits the item(s) that were added to or removed from the collection:
34+
```html
35+
<igx-combo (onSelectionChange)="handleChange($event)">
36+
```
37+
```typescript
38+
export class Example {
39+
...
40+
handleChange(event: {
41+
newSelection: any[],
42+
oldSelection: any[],
43+
added: any[], // the items added to the selection in this change
44+
removed: any[], // the items removed for the selection in this change
45+
...
46+
}) {
47+
console.log("Items added: ", [...event.added]);
48+
console.log("Items removed: ", [...event.removed]);
49+
}
50+
}
51+
```
1052

1153
## 8.1.0
1254

‎projects/igniteui-angular/src/lib/combo/README.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -276,14 +276,14 @@ Setting `[displayDensity]` affects the control's items' and inputs' css properti
276276

277277
| Name | Description | Cancelable | Parameters |
278278
|------------------ |-------------------------------------------------------------------------|------------- |-----------------------------------------|
279-
| `onSelectionChange` | Emitted when item selection is changing, before the selection completes | true | { oldSelection: `Array<any>`, newSelection: `Array<any>`, event: Event } |
279+
| `onSelectionChange` | Emitted when item selection is changing, before the selection completes | true | { oldSelection: `any[]`, newSelection: `any[]`, event?: `Event`, added: `any[]`, removed: `any[]`, cancel: `boolean` } |
280280
| `onSearchInput` | Emitted when an the search input's input event is triggered | false | { searchValue: `string` } |
281-
| `onAddition` | Emitted when an item is being added to the data collection | false | { oldCollection: `Array<any>`, addedItem: `<any>`, newCollection: `Array<any>` }|
282-
| `onDataPreLoad` | Emitted when new chunk of data is loaded from the virtualization | false | { event: Event } |
283-
| `onOpening` | Emitted before the dropdown is opened | false | { event: Event } |
284-
| `onOpened` | Emitted after the dropdown is opened | false | { event: Event } |
285-
| `onClosing` | Emitted before the dropdown is closed | false | { event: Event } |
286-
| `onClosed` | Emitted after the dropdown is closed | false | { event: Event } |
281+
| `onAddition` | Emitted when an item is being added to the data collection | false | { oldCollection: `any[]`, addedItem: `<any>`, newCollection: `any[]` }|
282+
| `onDataPreLoad` | Emitted when new chunk of data is loaded from the virtualization | false | { event: `Event` } |
283+
| `onOpening` | Emitted before the dropdown is opened | false | { event: `Event` } |
284+
| `onOpened` | Emitted after the dropdown is opened | false | { event: `Event` } |
285+
| `onClosing` | Emitted before the dropdown is closed | false | { event: `Event` } |
286+
| `onClosed` | Emitted after the dropdown is closed | false | { event: `Event` } |
287287

288288
### Methods
289289

@@ -292,9 +292,9 @@ Setting `[displayDensity]` affects the control's items' and inputs' css properti
292292
| `open` | Opens drop down | `void` | `None` |
293293
| `close` | Closes drop down | `void` | `None` |
294294
| `toggle` | Toggles drop down | `void` | `None` |
295-
| `selectedItems` | Get current selection state | `Array<any>` | `None` |
296-
| `selectItems` | Select defined items | `void` | items: `Array<any>`, clearCurrentSelection: `boolean` |
297-
| `deselectItems` | Deselect defined items | `void` | items: `Array<any>` |
295+
| `selectedItems` | Get current selection state | `any[]` | `None` |
296+
| `selectItems` | Select defined items | `void` | items: `any[]`, clearCurrentSelection: `boolean` |
297+
| `deselectItems` | Deselect defined items | `void` | items: `any[]` |
298298
| `selectAllItems` | Select all (filtered) items | `void` | ignoreFilter?: `boolean` - if `true` selects **all** values |
299299
| `deselectAllItems` | Deselect (filtered) all items | `void` | ignoreFilter?: `boolean` - if `true` deselects **all** values |
300300
| `setSelectedItem` | Toggles (select/deselect) an item by key | `void` | itemID: any, select = true, event?: Event |

0 commit comments

Comments
 (0)