chore(combo): extend IBaseEventArgs & rename searchTerm #7282

Author: PlamenaMiteva

CHANGELOG.md

@@ -7,7 +7,7 @@ All notable changes for each version of this project will be documented in this
 ### General
 - `igxCombo`
     - **Behavioral Change** - Change default positioning strategy from `ConnectedPositioningStrategy` to `AutoPositionStrategy`. The [`Auto`](https://www.infragistics.com/products/ignite-ui-angular/angular/components/overlay_position.html#auto) strategy will initially try to show the element like the Connected strategy does. If the element goes out of the viewport Auto will flip the starting point and the direction, i.e. if the direction is 'bottom', it will switch it to 'top' and so on. If after flipping direction the content goes out of the view, auto strategy will revert to initial start point and direction and will push the content into the view. Note after pushing the content it may hide the combo's input.
-    - Make `onSearchInput` event cancellable. The event args type has been changed to `IComboSearchInputEventArgs`, which have two properties: `searchTerm` - holds the change in the search input and `cancel` - indicates whether the event should be canceled.
+    - Make `onSearchInput` event cancellable. The event args type has been changed to `IComboSearchInputEventArgs`, which have the following properties: `searchText` - holds the text typed into the search input and `cancel` - indicates whether the event should be canceled.
 - `IgxOverlay`
     - Added new property - `closeOnEsc` - in `OverlaySettings`. The overlay can now be prevented from closing, on escape keypress, by setting the property to `false`, by default it's `true`.
 - `igxDialog`

projects/igniteui-angular/src/lib/combo/combo.component.ts

@@ -81,7 +81,7 @@ export enum IgxComboState {
 }
 
 /** Event emitted when an igx-combo's selection is changing */
-export interface IComboSelectionChangeEventArgs extends CancelableEventArgs, IBaseEventArgs {
+export interface IComboSelectionChangeEventArgs extends CancelableEventArgs, IBaseEventonSeaArgs {
     /** An array containing the values that are currently selected */
     oldSelection: any[];
     /** An array containing the values that will be selected after this event */
@@ -97,9 +97,9 @@ export interface IComboSelectionChangeEventArgs extends CancelableEventArgs, IBa
 }
 
 /** Event emitted when the igx-combo's search input changes */
-export interface IComboSearchInputEventArgs extends CancelableEventArgs {
-    /** The change that has been made to the search input */
-    searchTerm: string;
+export interface IComboSearchInputEventArgs extends CancelableEventArgs, IBaseEventArgs {
+    /** The text that has been typed into the search input */
+    searchText: string;
 }
 
 export interface IComboItemAdditionEvent extends IBaseEventArgs {
@@ -489,7 +489,7 @@ export class IgxComboComponent extends DisplayDensityBase implements IgxComboBas
      * ```
      */
     @Output()
-    public onSearchInput = new EventEmitter<IComboSearchInputEventArgs>();
+    public onSearchInput = new EventEmitter<CancelableBrowserEventArgs & IBaseEventArgs>();
 
     /**
      * Emitted when new chunk of data is loaded from the virtualization
@@ -988,7 +988,7 @@ export class IgxComboComponent extends DisplayDensityBase implements IgxComboBas
     public handleInputChange(event?: string) {
         if (event !== undefined) {
             const args: IComboSearchInputEventArgs = {
-                searchTerm: event,
+                searchText: event,
                 cancel: false
             };
             this.onSearchInput.emit(args);