igniteui-angular 22.0.0-rc.1 → 22.0.0

package/types/igniteui-angular-chips.d.ts

@@ -111,7 +111,7 @@ declare class IgxChipComponent implements OnInit, OnDestroy {
      */
     data: any;
     /**
-     * Defines if the `IgxChipComponent` can be dragged in order to change it's position.
+     * Defines if the chip can be dragged in order to change it's position.
      * By default it is set to false.
      *
      * @example
@@ -141,7 +141,7 @@ declare class IgxChipComponent implements OnInit, OnDestroy {
      */
     hideBaseOnDrag: boolean;
     /**
-     * Defines if the `IgxChipComponent` should render remove button and throw remove events.
+     * Defines if the chip should render remove button and throw remove events.
      * By default it is set to false.
      *
      * @example
@@ -161,7 +161,7 @@ declare class IgxChipComponent implements OnInit, OnDestroy {
      */
     removeIcon: TemplateRef<any>;
     /**
-     * Defines if the `IgxChipComponent` can be selected on click or through navigation,
+     * Defines if the chip can be selected on click or through navigation,
      * By default it is set to false.
      *
      * @example
@@ -186,7 +186,7 @@ declare class IgxChipComponent implements OnInit, OnDestroy {
      */
     class: string;
     /**
-     * Disables the `IgxChipComponent`. When disabled it restricts user interactions
+     * Disables the chip. When disabled it restricts user interactions
      * like focusing on click or tab, selection on click or Space, dragging.
      * By default it is set to false.
      *
@@ -197,7 +197,7 @@ declare class IgxChipComponent implements OnInit, OnDestroy {
      */
     disabled: boolean;
     /**
-     * Sets the `IgxChipComponent` selected state.
+     * Sets the chip selected state.
      *
      * @example
      * ```html
@@ -211,7 +211,7 @@ declare class IgxChipComponent implements OnInit, OnDestroy {
      */
     set selected(newValue: boolean);
     /**
-     * Returns if the `IgxChipComponent` is selected.
+     * Returns if the chip is selected.
      *
      * @example
      * ```typescript
@@ -229,7 +229,7 @@ declare class IgxChipComponent implements OnInit, OnDestroy {
      */
     selectedChange: EventEmitter<boolean>;
     /**
-     * Sets the `IgxChipComponent` background color.
+     * Sets the chip background color.
      * The `color` property supports string, rgb, hex.
      *
      * @example
@@ -239,7 +239,7 @@ declare class IgxChipComponent implements OnInit, OnDestroy {
      */
     set color(newColor: any);
     /**
-     * Returns the background color of the `IgxChipComponent`.
+     * Returns the background color of the chip.
      *
      * @example
      * ```typescript
@@ -261,8 +261,8 @@ declare class IgxChipComponent implements OnInit, OnDestroy {
      */
     get resourceStrings(): IChipResourceStrings;
     /**
-     * Emits an event when the `IgxChipComponent` moving starts.
-     * Returns the moving `IgxChipComponent`.
+     * Emits an event when the chip moving starts.
+     * Returns the moving chip.
      *
      * @example
      * ```html
@@ -271,8 +271,8 @@ declare class IgxChipComponent implements OnInit, OnDestroy {
      */
     moveStart: EventEmitter<IBaseChipEventArgs>;
     /**
-     * Emits an event when the `IgxChipComponent` moving ends.
-     * Returns the moved `IgxChipComponent`.
+     * Emits an event when the chip moving ends.
+     * Returns the moved chip.
      *
      * @example
      * ```html
@@ -281,8 +281,8 @@ declare class IgxChipComponent implements OnInit, OnDestroy {
      */
     moveEnd: EventEmitter<IBaseChipEventArgs>;
     /**
-     * Emits an event when the `IgxChipComponent` is removed.
-     * Returns the removed `IgxChipComponent`.
+     * Emits an event when the chip is removed.
+     * Returns the removed chip.
      *
      * @example
      * ```html
@@ -291,8 +291,8 @@ declare class IgxChipComponent implements OnInit, OnDestroy {
      */
     remove: EventEmitter<IBaseChipEventArgs>;
     /**
-     * Emits an event when the `IgxChipComponent` is clicked.
-     * Returns the clicked `IgxChipComponent`, whether the event should be canceled.
+     * Emits an event when the chip is clicked.
+     * Returns the clicked chip, whether the event should be canceled.
      *
      * @example
      * ```html
@@ -301,7 +301,7 @@ declare class IgxChipComponent implements OnInit, OnDestroy {
      */
     chipClick: EventEmitter<IChipClickEventArgs>;
     /**
-     * Emits event when the `IgxChipComponent` is selected/deselected.
+     * Emits event when the chip is selected/deselected.
      * Returns the selected chip reference, whether the event should be canceled, what is the next selection state and
      * when the event is triggered by interaction `originalEvent` is provided, otherwise `originalEvent` is `null`.
      *
@@ -312,7 +312,7 @@ declare class IgxChipComponent implements OnInit, OnDestroy {
      */
     selectedChanging: EventEmitter<IChipSelectEventArgs>;
     /**
-     * Emits event when the `IgxChipComponent` is selected/deselected and any related animations and transitions also end.
+     * Emits event when the chip is selected/deselected and any related animations and transitions also end.
      *
      * @example
      * ```html
@@ -321,8 +321,8 @@ declare class IgxChipComponent implements OnInit, OnDestroy {
      */
     selectedChanged: EventEmitter<IBaseChipEventArgs>;
     /**
-     * Emits an event when the `IgxChipComponent` keyboard navigation is being used.
-     * Returns the focused/selected `IgxChipComponent`, whether the event should be canceled,
+     * Emits an event when the chip keyboard navigation is being used.
+     * Returns the focused/selected chip, whether the event should be canceled,
      * if the `alt`, `shift` or `control` key is pressed and the pressed key name.
      *
      * @example
@@ -332,8 +332,8 @@ declare class IgxChipComponent implements OnInit, OnDestroy {
      */
     keyDown: EventEmitter<IChipKeyDownEventArgs>;
     /**
-     * Emits an event when the `IgxChipComponent` has entered the `IgxChipsAreaComponent`.
-     * Returns the target `IgxChipComponent`, the drag `IgxChipComponent`, as  well as
+     * Emits an event when the chip has entered the chips area.
+     * Returns the target chip, the drag chip, as  well as
      * the original drop event arguments.
      *
      * @example
@@ -343,8 +343,8 @@ declare class IgxChipComponent implements OnInit, OnDestroy {
      */
     dragEnter: EventEmitter<IChipEnterDragAreaEventArgs>;
     /**
-     * Emits an event when the `IgxChipComponent` has left the `IgxChipsAreaComponent`.
-     * Returns the target `IgxChipComponent`, the drag `IgxChipComponent`, as  well as
+     * Emits an event when the chip has left the chips area.
+     * Returns the target chip, the drag chip, as  well as
      * the original drop event arguments.
      *
      * @example
@@ -354,8 +354,8 @@ declare class IgxChipComponent implements OnInit, OnDestroy {
      */
     dragLeave: EventEmitter<IChipEnterDragAreaEventArgs>;
     /**
-     * Emits an event when the `IgxChipComponent` is over the `IgxChipsAreaComponent`.
-     * Returns the target `IgxChipComponent`, the drag `IgxChipComponent`, as  well as
+     * Emits an event when the chip is over the chips area.
+     * Returns the target chip, the drag chip, as  well as
      * the original drop event arguments.
      *
      * @example
@@ -365,8 +365,8 @@ declare class IgxChipComponent implements OnInit, OnDestroy {
      */
     dragOver: EventEmitter<IChipEnterDragAreaEventArgs>;
     /**
-     * Emits an event when the `IgxChipComponent` has been dropped in the `IgxChipsAreaComponent`.
-     * Returns the target `IgxChipComponent`, the drag `IgxChipComponent`, as  well as
+     * Emits an event when the chip has been dropped in the chips area.
+     * Returns the target chip, the drag chip, as  well as
      * the original drop event arguments.
      *
      * @example
@@ -382,7 +382,7 @@ declare class IgxChipComponent implements OnInit, OnDestroy {
     protected get isWarning(): boolean;
     protected get isDanger(): boolean;
     /**
-     * Property that contains a reference to the `IgxDragDirective` the `IgxChipComponent` uses for dragging behavior.
+     * Property that contains a reference to the drag the chip uses for dragging behavior.
      *
      * @example
      * ```html
@@ -604,7 +604,7 @@ declare class IgxChipsAreaComponent implements DoCheck, AfterViewInit, OnDestroy
      */
     ariaLabel: string;
     /**
-     * Sets the width of the `IgxChipsAreaComponent`.
+     * Sets the width of the chips area.
      *
      * @example
      * ```html
@@ -615,7 +615,7 @@ declare class IgxChipsAreaComponent implements DoCheck, AfterViewInit, OnDestroy
     /** @hidden @internal */
     get _widthToRem(): number;
     /**
-     * Sets the height of the `IgxChipsAreaComponent`.
+     * Sets the height of the chips area.
      *
      * @example
      * ```html
@@ -626,8 +626,8 @@ declare class IgxChipsAreaComponent implements DoCheck, AfterViewInit, OnDestroy
     /** @hidden @internal */
     get _heightToRem(): number;
     /**
-     * Emits an event when `IgxChipComponent`s in the `IgxChipsAreaComponent` should be reordered.
-     * Returns an array of `IgxChipComponent`s.
+     * Emits an event when chips in the chips area should be reordered.
+     * Returns an array of chips.
      *
      * @example
      * ```html
@@ -636,9 +636,9 @@ declare class IgxChipsAreaComponent implements DoCheck, AfterViewInit, OnDestroy
      */
     reorder: EventEmitter<IChipsAreaReorderEventArgs>;
     /**
-     * Emits an event when an `IgxChipComponent` in the `IgxChipsAreaComponent` is selected/deselected.
+     * Emits an event when an chip in the chips area is selected/deselected.
      * Fired after the chips area is initialized if there are initially selected chips as well.
-     * Returns an array of selected `IgxChipComponent`s and the `IgxChipAreaComponent`.
+     * Returns an array of selected chips and the chip area.
      *
      * @example
      * ```html
@@ -647,7 +647,7 @@ declare class IgxChipsAreaComponent implements DoCheck, AfterViewInit, OnDestroy
      */
     selectionChange: EventEmitter<IChipsAreaSelectEventArgs>;
     /**
-     * Emits an event when an `IgxChipComponent` in the `IgxChipsAreaComponent` is moved.
+     * Emits an event when an chip in the chips area is moved.
      *
      * @example
      * ```html
@@ -656,7 +656,7 @@ declare class IgxChipsAreaComponent implements DoCheck, AfterViewInit, OnDestroy
      */
     moveStart: EventEmitter<IBaseChipsAreaEventArgs>;
     /**
-     * Emits an event after an `IgxChipComponent` in the `IgxChipsAreaComponent` is moved.
+     * Emits an event after an chip in the chips area is moved.
      *
      * @example
      * ```html
@@ -665,7 +665,7 @@ declare class IgxChipsAreaComponent implements DoCheck, AfterViewInit, OnDestroy
      */
     moveEnd: EventEmitter<IBaseChipsAreaEventArgs>;
     /**
-     * Holds the `IgxChipComponent` in the `IgxChipsAreaComponent`.
+     * Holds the chip in the chips area.
      *
      * @example
      * ```typescript

package/types/igniteui-angular-core.d.ts

@@ -833,7 +833,7 @@ interface AnimationPlayer {
 
 /**
  * [Documentation](https://www.infragistics.com/products/ignite-ui-angular/angular/components/overlay-position)
- * Position strategies determine where to display the component in the provided IgxOverlayService.
+ * Position strategies determine where to display the component in the provided overlay.
  */
 interface IPositionStrategy {
     /**
@@ -1146,7 +1146,7 @@ declare class IgxOverlayService implements OnDestroy {
 
 /**
  * [Documentation](https://www.infragistics.com/products/ignite-ui-angular/angular/components/overlay-scroll).
- * Scroll strategies determines how the scrolling will be handled in the provided IgxOverlayService.
+ * Scroll strategies determines how the scrolling will be handled in the provided overlay.
  */
 interface IScrollStrategy {
     /**
@@ -1583,7 +1583,7 @@ declare abstract class IgxActionStripActionsToken {
 /**
  * Templates the default toggle icon in the picker.
  *
- * @remarks Can be applied to IgxDatePickerComponent, IgxTimePickerComponent, IgxDateRangePickerComponent
+ * @remarks Can be applied to date picker, time picker, date range picker
  *
  * @example
  * ```html
@@ -1603,7 +1603,7 @@ declare class IgxPickerToggleComponent {
 /**
  * Templates the default clear icon in the picker.
  *
- * @remarks Can be applied to IgxDatePickerComponent, IgxTimePickerComponent, IgxDateRangePickerComponent
+ * @remarks Can be applied to date picker, time picker, date range picker
  *
  * @example
  * ```html
@@ -1619,9 +1619,9 @@ declare class IgxPickerClearComponent extends IgxPickerToggleComponent {
     static ɵcmp: i0.ɵɵComponentDeclaration<IgxPickerClearComponent, "igx-picker-clear", never, {}, {}, never, ["*"], true, never>;
 }
 /**
- * IgxPickerActionsDirective can be used to re-template the dropdown/dialog action buttons.
+ * Picker actions can be used to re-template the dropdown/dialog action buttons.
  *
- * @remarks Can be applied to IgxDatePickerComponent, IgxTimePickerComponent, IgxDateRangePickerComponent
+ * @remarks Can be applied to date picker, time picker, date range picker
  *
  */
 declare class IgxPickerActionsDirective {
@@ -2378,7 +2378,7 @@ interface ITreeGridRecord {
     expanded?: boolean;
 }
 /**
- * Stub type for IgxTreeGridAPIService - minimal interface for typing in core
+ * Stub type for tree grid api - minimal interface for typing in core
  */
 interface IgxTreeGridAPIService {
     get_row_id(rowData: any): any;
@@ -3026,7 +3026,7 @@ declare class IgxSorting implements IGridSortingStrategy {
     private prepareExpressions;
 }
 /**
- * Represents a class implementing the IGridGroupingStrategy interface and extending the IgxSorting class.
+ * Represents a class implementing the IGridGroupingStrategy interface and extending the sorting class.
  * It provides a method to group data based on the given grouping state.
  */
 declare class IgxGrouping extends IgxSorting implements IGridGroupingStrategy {
@@ -3061,7 +3061,7 @@ declare class NoopSortingStrategy implements IGridSortingStrategy {
     sort(data: any[]): any[];
 }
 /**
- * Represents a class extending the IgxSorting class
+ * Represents a class extending the sorting class
  * Provides custom data record sorting.
  */
 declare class IgxDataRecordSorting extends IgxSorting {

package/types/igniteui-angular-date-picker.d.ts

@@ -74,7 +74,7 @@ declare abstract class PickerBaseDirective implements IToggleView, EditorProvide
      */
     mode: PickerInteractionMode;
     /**
-     * Gets/Sets the orientation of the `IgxDatePickerComponent` header.
+     * Gets/Sets the orientation of the date picker header.
      *
      *  @example
      * ```html
@@ -399,7 +399,7 @@ declare class IgxDatePickerComponent extends PickerBaseDirective implements Cont
      */
     id: string;
     /**
-     * Gets/Sets the format views of the `IgxDatePickerComponent`.
+     * Gets/Sets the format views of the date picker.
      *
      * @example
      * ```typescript
@@ -431,7 +431,7 @@ declare class IgxDatePickerComponent extends PickerBaseDirective implements Cont
     get specialDates(): DateRangeDescriptor[];
     set specialDates(value: DateRangeDescriptor[]);
     /**
-     * Gets/Sets the format options of the `IgxDatePickerComponent`.
+     * Gets/Sets the format options of the date picker.
      *
      * @example
      * ```typescript
@@ -993,7 +993,7 @@ declare class IgxDateRangePickerComponent extends PickerBaseDirective implements
      */
     get resourceStrings(): IDateRangePickerResourceStrings;
     /**
-     * Sets the `placeholder` for single-input `IgxDateRangePickerComponent`.
+     * Sets the `placeholder` for single-input date range picker.
      *
      *   @example
      * ```html

package/types/igniteui-angular-directives.d.ts

@@ -150,7 +150,7 @@ declare class IgxButtonDirective extends IgxButtonBaseDirective {
     protected emitSelected(): void;
     /**
      * Gets or sets whether the button is selected.
-     * Mainly used in the IgxButtonGroup component and it will have no effect if set separately.
+     * Mainly used in the button group component and it will have no effect if set separately.
      *
      * @example
      * ```html
@@ -231,7 +231,7 @@ declare class CheckboxBaseDirective implements AfterViewInit {
     ngControl: NgControl;
     /**
      * An event that is emitted after the checkbox state is changed.
-     * Provides references to the `IgxCheckboxComponent` and the `checked` property as event arguments.
+     * Provides references to the checkbox and the `checked` property as event arguments.
      */
     readonly change: EventEmitter<IChangeCheckboxEventArgs>;
     /**
@@ -1243,12 +1243,12 @@ declare class IgxDropDirective implements OnInit, OnDestroy {
      */
     dropChannel: number | string | number[] | string[];
     /**
-     * Sets a drop strategy type that will be executed when an `IgxDrag` element is released inside
+     * Sets a drop strategy type that will be executed when an drag element is released inside
      *  the current drop area. The provided strategies are:
-     *  - IgxDefaultDropStrategy - This is the default base strategy and it doesn't perform any actions.
-     *  - IgxAppendDropStrategy - Appends the dropped element to last position as a direct child to the `igxDrop`.
-     *  - IgxPrependDropStrategy - Prepends the dropped element to first position as a direct child to the `igxDrop`.
-     *  - IgxInsertDropStrategy - If the dropped element is released above a child element of the `igxDrop`, it will be inserted
+     *  - default drop strategy - This is the default base strategy and it doesn't perform any actions.
+     *  - append drop strategy - Appends the dropped element to last position as a direct child to the `igxDrop`.
+     *  - prepend drop strategy - Prepends the dropped element to first position as a direct child to the `igxDrop`.
+     *  - insert drop strategy - If the dropped element is released above a child element of the `igxDrop`, it will be inserted
      *      at that position. Otherwise the dropped element will be appended if released outside any child of the `igxDrop`.
      * ```html
      * <div igxDrag>
@@ -1937,7 +1937,7 @@ declare class IgxForOfDirective<T, U extends T[] = T[]> extends IgxForOfToken<T,
      * Asserts the correct type of the context for the template that `igxForOf` will render.
      *
      * The presence of this method is a signal to the Ivy template type-check compiler that the
-     * `IgxForOf` structural directive renders its template with a specific context type.
+     * ForOf structural directive renders its template with a specific context type.
      */
     static ngTemplateContextGuard<T, U extends T[]>(_dir: IgxForOfDirective<T, U>, ctx: any): ctx is IgxForOfContext<T, U>;
     /**
@@ -2251,10 +2251,10 @@ declare class IgxGridForOfDirective<T, U extends T[] = T[]> extends IgxForOfDire
     dataChanging: EventEmitter<IForOfDataChangeEventArgs>;
     /**
      * @hidden @internal
-     * Asserts the correct type of the context for the template that `IgxGridForOfDirective` will render.
+     * Asserts the correct type of the context for the template that Grid ForOf will render.
      *
      * The presence of this method is a signal to the Ivy template type-check compiler that the
-     * `IgxGridForOfDirective` structural directive renders its template with a specific context type.
+     * Grid ForOf structural directive renders its template with a specific context type.
      */
     static ngTemplateContextGuard<T, U extends T[]>(_dir: IgxGridForOfDirective<T, U>, ctx: any): ctx is IgxGridForOfContext<T, U>;
     ngOnInit(): void;
@@ -2290,7 +2290,7 @@ declare class IgxGridForOfDirective<T, U extends T[] = T[]> extends IgxForOfDire
  */
 type IgxIconButtonType = typeof IgxBaseButtonType[keyof typeof IgxBaseButtonType];
 /**
- * The IgxIconButtonDirective provides a way to use an icon as a fully functional button.
+ * The icon button provides a way to use an icon as a fully functional button.
  *
  * @example
  * ```html
@@ -3215,7 +3215,7 @@ declare class IgxToggleDirective implements IToggleView, OnInit, OnDestroy {
      */
     get collapsed(): boolean;
     /**
-     * Identifier which is registered into `IgxNavigationService`
+     * Identifier which is registered into navigation
      *
      * ```typescript
      * let myToggleId = this.toggle.id;
@@ -3331,7 +3331,7 @@ declare class IgxToggleActionDirective implements OnInit {
      * <!--set-->
      * <div igxToggleAction [igxToggleOutlet]="outlet"></div>
      * ```
-     * Where `outlet` in an instance of `IgxOverlayOutletDirective` or an `ElementRef`
+     * Where outlet is an instance of overlay outlet or a reference to the element.
      *
      * @deprecated in version 21.2.0. Overlays now use the HTML Popover API and no longer move to the document
      * body by default, so using outlet is also no longer needed - just define the overlay in the intended
@@ -3819,7 +3819,7 @@ declare class IgxTooltipTargetDirective extends IgxToggleActionDirective impleme
      */
     private _evaluateStickyState;
     /**
-     * Creates (if not already created) an instance of the IgxTooltipCloseButtonComponent,
+     * Creates (if not already created) an instance of the tooltip close button,
      * and assigns it the provided custom template.
      */
     private _createCloseTemplate;
@@ -4201,7 +4201,7 @@ declare abstract class IgxNotificationsDirective extends IgxToggleDirective impl
      * Gets/Sets the container used for the element.
      *
      * @remarks
-     *  `outlet` is an instance of `IgxOverlayOutletDirective` or an `ElementRef`.
+     *  Outlet is an instance of overlay outlet or a reference to the element.
      *
      * @deprecated in version 21.2.0. Overlays now use the HTML Popover API and no longer move to the document
      * body by default, so using outlet is also no longer needed - just define the component in the intended

package/types/igniteui-angular-drop-down.d.ts

@@ -81,7 +81,7 @@ declare enum Navigate {
     Up = -1,
     Down = 1
 }
-/** Key actions that have designated handlers in IgxDropDownComponent */
+/** Key actions that have designated handlers in drop down */
 declare const DropDownActionKey: {
     readonly ESCAPE: "escape";
     readonly ENTER: "enter";
@@ -99,7 +99,7 @@ interface ISelectionEventArgs extends CancelableEventArgs, IBaseEventArgs {
     newSelection: IgxDropDownItemBaseDirective;
 }
 /**
- * Interface for an instance of IgxDropDownNavigationDirective
+ * Interface for an instance of drop down navigation
  *
  * @export
  */
@@ -279,7 +279,7 @@ declare class IgxDropDownItemBaseDirective implements DoCheck {
      *      </div>
      *  </igx-drop-down-item>
      * ```
-     * **NOTE:** Drop-down items inside of a disabled `IgxDropDownGroup` will always count as disabled
+     * **NOTE:** Drop-down items inside of a disabled drop down group will always count as disabled
      */
     get disabled(): boolean;
     set disabled(value: boolean);
@@ -392,7 +392,7 @@ declare class IgxDropDownItemComponent extends IgxDropDownItemBaseDirective {
 /**
  * An abstract class, defining a drop-down component, with:
  * Properties for display styles and classes
- * A collection items of type `IgxDropDownItemBaseDirective`
+ * A collection items of type drop down item base
  * Properties and methods for navigating (highlighting/focusing) items from the collection
  * Properties and methods for selecting items from the collection
  */
@@ -498,7 +498,7 @@ declare abstract class IgxDropDownBaseDirective implements IDropDownList, OnInit
      * @hidden @internal
      * Gets the id of the focused item during dropdown navigation.
      * This is used to update the `aria-activedescendant` attribute of
-     * the IgxDropDownNavigationDirective host element.
+     * the drop down navigation host element.
      */
     get activeDescendant(): string | null;
     /**
@@ -564,7 +564,7 @@ declare abstract class IgxDropDownBaseDirective implements IDropDownList, OnInit
 }
 
 /**
- * Navigation Directive that handles keyboard events on its host and controls a targeted IgxDropDownBaseDirective component
+ * Navigation Directive that handles keyboard events on its host and controls a targeted drop down base component
  */
 declare class IgxDropDownItemNavigationDirective implements IDropDownNavigationDirective {
     dropdown: IgxDropDownBaseDirective;