diff --git a/package-lock.json b/package-lock.json index 919ed175033..951638dcfdc 100644 --- a/package-lock.json +++ b/package-lock.json @@ -22368,31 +22368,6 @@ "sassdoc-extras": "^2.5.0" } }, - "node_modules/sassdoc-theme-default/node_modules/chokidar": { - "version": "3.6.0", - "resolved": "https://registry.npmjs.org/chokidar/-/chokidar-3.6.0.tgz", - "integrity": "sha512-7VT13fmjotKpGipCW9JEQAusEPE+Ei8nl6/g4FBAmIm0GOOLMua9NDDo/DWp0ZAxCr3cPq5ZpBqmPAQgDda2Pw==", - "extraneous": true, - "license": "MIT", - "dependencies": { - "anymatch": "~3.1.2", - "braces": "~3.0.2", - "glob-parent": "~5.1.2", - "is-binary-path": "~2.1.0", - "is-glob": "~4.0.1", - "normalize-path": "~3.0.0", - "readdirp": "~3.6.0" - }, - "engines": { - "node": ">= 8.10.0" - }, - "funding": { - "url": "https://paulmillr.com/funding/" - }, - "optionalDependencies": { - "fsevents": "~2.3.2" - } - }, "node_modules/sassdoc-theme-default/node_modules/commander": { "version": "5.1.0", "resolved": "https://registry.npmjs.org/commander/-/commander-5.1.0.tgz", @@ -22421,19 +22396,6 @@ "jsonfile": "^2.1.0" } }, - "node_modules/sassdoc-theme-default/node_modules/glob-parent": { - "version": "5.1.2", - "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-5.1.2.tgz", - "integrity": "sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow==", - "extraneous": true, - "license": "ISC", - "dependencies": { - "is-glob": "^4.0.1" - }, - "engines": { - "node": ">= 6" - } - }, "node_modules/sassdoc-theme-default/node_modules/jsonfile": { "version": "2.4.0", "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-2.4.0.tgz", @@ -22470,6 +22432,8 @@ } } }, +<<<<<<< copilot/improve-public-api-docs +======= "node_modules/sassdoc-theme-default/node_modules/picomatch": { "version": "2.3.2", "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.3.2.tgz", @@ -22496,6 +22460,7 @@ "node": ">=8.10.0" } }, +>>>>>>> master "node_modules/sassdoc/node_modules/argparse": { "version": "1.0.10", "resolved": "https://registry.npmjs.org/argparse/-/argparse-1.0.10.tgz", diff --git a/projects/igniteui-angular/accordion/src/accordion/accordion.component.ts b/projects/igniteui-angular/accordion/src/accordion/accordion.component.ts index a5516df2921..9e9b94d5957 100644 --- a/projects/igniteui-angular/accordion/src/accordion/accordion.component.ts +++ b/projects/igniteui-angular/accordion/src/accordion/accordion.component.ts @@ -13,13 +13,13 @@ const ACCORDION_NAVIGATION_KEYS = new Set('up down arrowup arrowdown home end'.s export interface IAccordionEventArgs extends IExpansionPanelEventArgs { owner: IgxAccordionComponent; - /** Provides a reference to the `IgxExpansionPanelComponent` which was expanded/collapsed. */ + /** Provides a reference to the expansion panel which was expanded/collapsed. */ panel: IgxExpansionPanelBase; } export interface IAccordionCancelableEventArgs extends IExpansionPanelCancelableEventArgs { owner: IgxAccordionComponent; - /** Provides a reference to the `IgxExpansionPanelComponent` which is currently expanding/collapsing. */ + /** Provides a reference to the expansion panel which is currently expanding/collapsing. */ panel: IgxExpansionPanelBase; /** Enables canceling the expansion/collapse operation. */ cancel: boolean; @@ -28,7 +28,7 @@ export interface IAccordionCancelableEventArgs extends IExpansionPanelCancelable let NEXT_ID = 0; /** - * IgxAccordion is a container-based component that contains that can house multiple expansion panels. + * Accordion is a container-based component that contains that can house multiple expansion panels. * * @igxModule IgxAccordionModule * diff --git a/projects/igniteui-angular/action-strip/src/action-strip/action-strip.component.ts b/projects/igniteui-angular/action-strip/src/action-strip/action-strip.component.ts index d56215f99d8..a578518a779 100644 --- a/projects/igniteui-angular/action-strip/src/action-strip/action-strip.component.ts +++ b/projects/igniteui-angular/action-strip/src/action-strip/action-strip.component.ts @@ -232,7 +232,7 @@ export class IgxActionStripComponent implements IgxActionStripToken, AfterViewIn /** - * Getter for the 'display' property of the current `IgxActionStrip` + * Getter for the 'display' property of the current action strip */ @HostBinding('style.display') private get display(): string { diff --git a/projects/igniteui-angular/button-group/src/button-group/button-group.component.ts b/projects/igniteui-angular/button-group/src/button-group/button-group.component.ts index f11590b12c7..768f7cf8ec1 100644 --- a/projects/igniteui-angular/button-group/src/button-group/button-group.component.ts +++ b/projects/igniteui-angular/button-group/src/button-group/button-group.component.ts @@ -88,7 +88,7 @@ export class IgxButtonGroupComponent implements AfterViewInit, OnDestroy { } /** - * Returns the CSS class of the item content of the `IgxButtonGroup`. + * Returns the CSS class of the item content of the button group. * ```typescript * @ViewChild("MyChild") * public buttonG: IgxButtonGroupComponent; diff --git a/projects/igniteui-angular/calendar/src/calendar/calendar.directives.ts b/projects/igniteui-angular/calendar/src/calendar/calendar.directives.ts index 93688d4dc74..223fbf6ebb5 100644 --- a/projects/igniteui-angular/calendar/src/calendar/calendar.directives.ts +++ b/projects/igniteui-angular/calendar/src/calendar/calendar.directives.ts @@ -1,5 +1,5 @@ /** - * This file contains all the directives used by the @link IgxCalendarComponent. + * This file contains all the directives used by the @link calendar. * Except for the directives which are used for templating the calendar itself * you should generally not use them directly. * diff --git a/projects/igniteui-angular/card/src/card/card.component.ts b/projects/igniteui-angular/card/src/card/card.component.ts index 8e1dda11c68..81803ad5848 100644 --- a/projects/igniteui-angular/card/src/card/card.component.ts +++ b/projects/igniteui-angular/card/src/card/card.component.ts @@ -3,7 +3,7 @@ import { Component, Directive, HostBinding, Input, OnInit, OnChanges, SimpleChan let NEXT_ID = 0; /** - * IgxCardMedia is container for the card media section. + * Card media is container for the card media section. * Use it to wrap images and videos. */ @Directive({ @@ -52,7 +52,7 @@ export class IgxCardMediaDirective { } /** - * IgxCardHeader is container for the card header + * Card header is container for the card header */ @Component({ selector: 'igx-card-header', @@ -79,7 +79,7 @@ export class IgxCardHeaderComponent { } /** - * IgxCardThumbnail is container for the card thumbnail section. + * Card thumbnail is container for the card thumbnail section. * Use it to wrap anything you want to be used as a thumbnail. */ @Directive({ @@ -116,7 +116,7 @@ export class IgxCardHeaderSubtitleDirective { public cssClass = 'igx-card-header__subtitle'; } /** - * IgxCardContent is container for the card content. + * Card content is container for the card content. */ @Directive({ // eslint-disable-next-line @angular-eslint/directive-selector @@ -130,7 +130,7 @@ export class IgxCardContentDirective { } /** - * IgxCardFooter is container for the card footer + * Card footer is container for the card footer */ @Directive({ // eslint-disable-next-line @angular-eslint/directive-selector @@ -264,7 +264,7 @@ export const IgxCardActionsLayout = { export type IgxCardActionsLayout = (typeof IgxCardActionsLayout)[keyof typeof IgxCardActionsLayout]; /** - * IgxCardActions is container for the card actions. + * Card actions is container for the card actions. */ @Component({ selector: 'igx-card-actions', diff --git a/projects/igniteui-angular/carousel/src/carousel/carousel.component.ts b/projects/igniteui-angular/carousel/src/carousel/carousel.component.ts index c7c27892c08..f8c431fcc58 100644 --- a/projects/igniteui-angular/carousel/src/carousel/carousel.component.ts +++ b/projects/igniteui-angular/carousel/src/carousel/carousel.component.ts @@ -311,7 +311,7 @@ export class IgxCarouselComponent extends IgxCarouselComponentBase implements On /** * An event that is emitted after a slide transition has happened. - * Provides references to the `IgxCarouselComponent` and `IgxSlideComponent` as event arguments. + * Provides references to the carousel and slide as event arguments. * ```html * * ``` @@ -322,7 +322,7 @@ export class IgxCarouselComponent extends IgxCarouselComponentBase implements On /** * An event that is emitted after a slide has been added to the carousel. - * Provides references to the `IgxCarouselComponent` and `IgxSlideComponent` as event arguments. + * Provides references to the carousel and slide as event arguments. * ```html * * ``` @@ -333,7 +333,7 @@ export class IgxCarouselComponent extends IgxCarouselComponentBase implements On /** * An event that is emitted after a slide has been removed from the carousel. - * Provides references to the `IgxCarouselComponent` and `IgxSlideComponent` as event arguments. + * Provides references to the carousel and slide as event arguments. * ```html * * ``` @@ -344,7 +344,7 @@ export class IgxCarouselComponent extends IgxCarouselComponentBase implements On /** * An event that is emitted after the carousel has been paused. - * Provides a reference to the `IgxCarouselComponent` as an event argument. + * Provides a reference to the carousel as an event argument. * ```html * * ``` @@ -355,7 +355,7 @@ export class IgxCarouselComponent extends IgxCarouselComponentBase implements On /** * An event that is emitted after the carousel has resumed transitioning between `slides`. - * Provides a reference to the `IgxCarouselComponent` as an event argument. + * Provides a reference to the carousel as an event argument. * ```html * * ``` diff --git a/projects/igniteui-angular/carousel/src/carousel/slide.component.ts b/projects/igniteui-angular/carousel/src/carousel/slide.component.ts index 308f5d52d16..b693b4810ed 100644 --- a/projects/igniteui-angular/carousel/src/carousel/slide.component.ts +++ b/projects/igniteui-angular/carousel/src/carousel/slide.component.ts @@ -4,7 +4,7 @@ import { CarouselAnimationDirection, IgxSlideComponentBase } from './carousel-ba /** * A slide component that usually holds an image and/or a caption text. - * IgxSlideComponent is usually a child component of an IgxCarouselComponent. + * Slide is usually a child component of an carousel. * * ``` * diff --git a/projects/igniteui-angular/chips/src/chips/chip.component.ts b/projects/igniteui-angular/chips/src/chips/chip.component.ts index 237decb0311..f8c0f0309e3 100644 --- a/projects/igniteui-angular/chips/src/chips/chip.component.ts +++ b/projects/igniteui-angular/chips/src/chips/chip.component.ts @@ -163,7 +163,7 @@ export class IgxChipComponent implements OnInit, OnDestroy { public 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 @@ -199,7 +199,7 @@ export class IgxChipComponent implements OnInit, OnDestroy { public hideBaseOnDrag = true; /** - * 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 @@ -223,7 +223,7 @@ export class IgxChipComponent implements OnInit, OnDestroy { public removeIcon: TemplateRef; /** - * 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 @@ -254,7 +254,7 @@ export class IgxChipComponent implements OnInit, OnDestroy { public class = ''; /** - * 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. * @@ -268,7 +268,7 @@ export class IgxChipComponent implements OnInit, OnDestroy { public disabled = false; /** - * Sets the `IgxChipComponent` selected state. + * Sets the chip selected state. * * @example * ```html @@ -287,7 +287,7 @@ export class IgxChipComponent implements OnInit, OnDestroy { } /** - * Returns if the `IgxChipComponent` is selected. + * Returns if the chip is selected. * * @example * ```typescript @@ -310,7 +310,7 @@ export class IgxChipComponent implements OnInit, OnDestroy { public selectedChange = new EventEmitter(); /** - * Sets the `IgxChipComponent` background color. + * Sets the chip background color. * The `color` property supports string, rgb, hex. * * @example @@ -324,7 +324,7 @@ export class IgxChipComponent implements OnInit, OnDestroy { } /** - * Returns the background color of the `IgxChipComponent`. + * Returns the background color of the chip. * * @example * ```typescript @@ -356,8 +356,8 @@ export class IgxChipComponent implements OnInit, OnDestroy { } /** - * 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 @@ -368,8 +368,8 @@ export class IgxChipComponent implements OnInit, OnDestroy { public moveStart = new EventEmitter(); /** - * 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 @@ -380,8 +380,8 @@ export class IgxChipComponent implements OnInit, OnDestroy { public moveEnd = new EventEmitter(); /** - * 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 @@ -392,8 +392,8 @@ export class IgxChipComponent implements OnInit, OnDestroy { public remove = new EventEmitter(); /** - * 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 @@ -404,7 +404,7 @@ export class IgxChipComponent implements OnInit, OnDestroy { public chipClick = new EventEmitter(); /** - * 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`. * @@ -417,7 +417,7 @@ export class IgxChipComponent implements OnInit, OnDestroy { public selectedChanging = new EventEmitter(); /** - * 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 @@ -428,8 +428,8 @@ export class IgxChipComponent implements OnInit, OnDestroy { public selectedChanged = new EventEmitter(); /** - * 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 @@ -441,8 +441,8 @@ export class IgxChipComponent implements OnInit, OnDestroy { public keyDown = new EventEmitter(); /** - * 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 @@ -454,8 +454,8 @@ export class IgxChipComponent implements OnInit, OnDestroy { public dragEnter = new EventEmitter(); /** - * 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 @@ -467,8 +467,8 @@ export class IgxChipComponent implements OnInit, OnDestroy { public dragLeave = new EventEmitter(); /** - * 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 @@ -480,8 +480,8 @@ export class IgxChipComponent implements OnInit, OnDestroy { public dragOver = new EventEmitter(); /** - * 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 @@ -521,7 +521,7 @@ export class IgxChipComponent implements OnInit, OnDestroy { } /** - * 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 diff --git a/projects/igniteui-angular/chips/src/chips/chips-area.component.ts b/projects/igniteui-angular/chips/src/chips/chips-area.component.ts index 1146c073d6c..64e83442573 100644 --- a/projects/igniteui-angular/chips/src/chips/chips-area.component.ts +++ b/projects/igniteui-angular/chips/src/chips/chips-area.component.ts @@ -80,7 +80,7 @@ export class IgxChipsAreaComponent implements DoCheck, AfterViewInit, OnDestroy public ariaLabel = 'chip area'; /** - * Sets the width of the `IgxChipsAreaComponent`. + * Sets the width of the chips area. * * @example * ```html @@ -97,7 +97,7 @@ export class IgxChipsAreaComponent implements DoCheck, AfterViewInit, OnDestroy } /** - * Sets the height of the `IgxChipsAreaComponent`. + * Sets the height of the chips area. * * @example * ```html @@ -114,8 +114,8 @@ export class IgxChipsAreaComponent implements DoCheck, AfterViewInit, OnDestroy } /** - * 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 @@ -126,9 +126,9 @@ export class IgxChipsAreaComponent implements DoCheck, AfterViewInit, OnDestroy public reorder = new EventEmitter(); /** - * 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 @@ -139,7 +139,7 @@ export class IgxChipsAreaComponent implements DoCheck, AfterViewInit, OnDestroy public selectionChange = new EventEmitter(); /** - * 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 @@ -150,7 +150,7 @@ export class IgxChipsAreaComponent implements DoCheck, AfterViewInit, OnDestroy public moveStart = new EventEmitter(); /** - * 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 @@ -161,7 +161,7 @@ export class IgxChipsAreaComponent implements DoCheck, AfterViewInit, OnDestroy public moveEnd = new EventEmitter(); /** - * Holds the `IgxChipComponent` in the `IgxChipsAreaComponent`. + * Holds the chip in the chips area. * * @example * ```typescript diff --git a/projects/igniteui-angular/core/src/data-operations/grid-sorting-strategy.ts b/projects/igniteui-angular/core/src/data-operations/grid-sorting-strategy.ts index c41c50759e1..9cfba2b3075 100644 --- a/projects/igniteui-angular/core/src/data-operations/grid-sorting-strategy.ts +++ b/projects/igniteui-angular/core/src/data-operations/grid-sorting-strategy.ts @@ -158,7 +158,7 @@ export class IgxSorting implements IGridSortingStrategy { } /** - * 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. */ export class IgxGrouping extends IgxSorting implements IGridGroupingStrategy { @@ -372,7 +372,7 @@ export class NoopSortingStrategy implements IGridSortingStrategy { } /** - * Represents a class extending the IgxSorting class + * Represents a class extending the sorting class * Provides custom data record sorting. */ export class IgxDataRecordSorting extends IgxSorting { diff --git a/projects/igniteui-angular/core/src/data-operations/grid-types.ts b/projects/igniteui-angular/core/src/data-operations/grid-types.ts index ae8c6830160..d4895133204 100644 --- a/projects/igniteui-angular/core/src/data-operations/grid-types.ts +++ b/projects/igniteui-angular/core/src/data-operations/grid-types.ts @@ -410,7 +410,7 @@ export interface ITreeGridRecord { } /** - * Stub type for IgxTreeGridAPIService - minimal interface for typing in core + * Stub type for tree grid api - minimal interface for typing in core */ export interface IgxTreeGridAPIService { get_row_id(rowData: any): any; diff --git a/projects/igniteui-angular/core/src/date-common/picker-icons.common.ts b/projects/igniteui-angular/core/src/date-common/picker-icons.common.ts index c3b3b0f6e80..d27ad19fc97 100644 --- a/projects/igniteui-angular/core/src/date-common/picker-icons.common.ts +++ b/projects/igniteui-angular/core/src/date-common/picker-icons.common.ts @@ -3,7 +3,7 @@ import { Component, Output, EventEmitter, HostListener, Directive, TemplateRef, /** * 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 @@ -34,7 +34,7 @@ export 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 @@ -53,9 +53,9 @@ export class IgxPickerToggleComponent { export class IgxPickerClearComponent extends IgxPickerToggleComponent { } /** - * 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 * */ @Directive({ diff --git a/projects/igniteui-angular/core/src/services/overlay/position/IPositionStrategy.ts b/projects/igniteui-angular/core/src/services/overlay/position/IPositionStrategy.ts index 8f1ef360412..55d4e94ad1c 100644 --- a/projects/igniteui-angular/core/src/services/overlay/position/IPositionStrategy.ts +++ b/projects/igniteui-angular/core/src/services/overlay/position/IPositionStrategy.ts @@ -2,7 +2,7 @@ import { PositionSettings, Size, Point } from './../utilities'; /** * [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. */ export interface IPositionStrategy { /** diff --git a/projects/igniteui-angular/core/src/services/overlay/scroll/IScrollStrategy.ts b/projects/igniteui-angular/core/src/services/overlay/scroll/IScrollStrategy.ts index 36392d53701..7ced552a91a 100644 --- a/projects/igniteui-angular/core/src/services/overlay/scroll/IScrollStrategy.ts +++ b/projects/igniteui-angular/core/src/services/overlay/scroll/IScrollStrategy.ts @@ -1,7 +1,7 @@ import { IgxOverlayService } from '../overlay'; /** * [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. */ export interface IScrollStrategy { /* blazorSuppress */ @@ -9,7 +9,7 @@ export interface IScrollStrategy { * Initializes the strategy. Should be called once * * @param document reference to Document object. - * @param overlayService IgxOverlay service to use in this strategy. + * @param overlayService overlay service to use in this strategy. * @param id Unique id for this strategy. * ```typescript * settings.scrollStrategy.initialize(document, overlay, id); diff --git a/projects/igniteui-angular/core/src/services/overlay/scroll/absolute-scroll-strategy.ts b/projects/igniteui-angular/core/src/services/overlay/scroll/absolute-scroll-strategy.ts index d4d85d57306..03532c482ac 100644 --- a/projects/igniteui-angular/core/src/services/overlay/scroll/absolute-scroll-strategy.ts +++ b/projects/igniteui-angular/core/src/services/overlay/scroll/absolute-scroll-strategy.ts @@ -22,7 +22,7 @@ export class AbsoluteScrollStrategy extends ScrollStrategy { * Initializes the strategy. Should be called once * * @param document reference to Document object. - * @param overlayService IgxOverlay service to use in this strategy. + * @param overlayService overlay service to use in this strategy. * @param id Unique id for this strategy. * ```typescript * settings.scrollStrategy.initialize(document, overlay, id); diff --git a/projects/igniteui-angular/core/src/services/overlay/scroll/close-scroll-strategy.ts b/projects/igniteui-angular/core/src/services/overlay/scroll/close-scroll-strategy.ts index f7dff177fee..93318a8332c 100644 --- a/projects/igniteui-angular/core/src/services/overlay/scroll/close-scroll-strategy.ts +++ b/projects/igniteui-angular/core/src/services/overlay/scroll/close-scroll-strategy.ts @@ -27,7 +27,7 @@ export class CloseScrollStrategy extends ScrollStrategy { * Initializes the strategy. Should be called once * * @param document reference to Document object. - * @param overlayService IgxOverlay service to use in this strategy. + * @param overlayService overlay service to use in this strategy. * @param id Unique id for this strategy. * ```typescript * settings.scrollStrategy.initialize(document, overlay, id); diff --git a/projects/igniteui-angular/core/src/services/overlay/scroll/scroll-strategy.ts b/projects/igniteui-angular/core/src/services/overlay/scroll/scroll-strategy.ts index 946afa27b83..d3a2c1cbba2 100644 --- a/projects/igniteui-angular/core/src/services/overlay/scroll/scroll-strategy.ts +++ b/projects/igniteui-angular/core/src/services/overlay/scroll/scroll-strategy.ts @@ -6,7 +6,7 @@ export abstract class ScrollStrategy implements IScrollStrategy { * Initializes the strategy. Should be called once * * @param document reference to Document object. - * @param overlayService IgxOverlay service to use in this strategy. + * @param overlayService overlay service to use in this strategy. * @param id Unique id for this strategy. * ```typescript * settings.scrollStrategy.initialize(document, overlay, id); diff --git a/projects/igniteui-angular/date-picker/src/date-picker/date-picker.component.ts b/projects/igniteui-angular/date-picker/src/date-picker/date-picker.component.ts index 61e0a3270ab..480efee25ad 100644 --- a/projects/igniteui-angular/date-picker/src/date-picker/date-picker.component.ts +++ b/projects/igniteui-angular/date-picker/src/date-picker/date-picker.component.ts @@ -246,7 +246,7 @@ export class IgxDatePickerComponent extends PickerBaseDirective implements Contr /** * Gets/Sets the container used for the popup element. * @remarks - * `outlet` is an instance of `IgxOverlayOutletDirective` or an `ElementRef`. + * `outlet` is an instance of overlay outlet or an `ElementRef`. * @example * ```html *
@@ -278,7 +278,7 @@ export class IgxDatePickerComponent extends PickerBaseDirective implements Contr //#region calendar members /** - * Gets/Sets the format views of the `IgxDatePickerComponent`. + * Gets/Sets the format views of the date picker. * * @example * ```typescript @@ -326,7 +326,7 @@ export class IgxDatePickerComponent extends PickerBaseDirective implements Contr /** - * Gets/Sets the format options of the `IgxDatePickerComponent`. + * Gets/Sets the format options of the date picker. * * @example * ```typescript diff --git a/projects/igniteui-angular/date-picker/src/date-picker/picker-base.directive.ts b/projects/igniteui-angular/date-picker/src/date-picker/picker-base.directive.ts index 7b56131951a..f82d4bbbbd7 100644 --- a/projects/igniteui-angular/date-picker/src/date-picker/picker-base.directive.ts +++ b/projects/igniteui-angular/date-picker/src/date-picker/picker-base.directive.ts @@ -100,7 +100,7 @@ export abstract class PickerBaseDirective implements IToggleView, EditorProvider public mode: PickerInteractionMode = PickerInteractionMode.DropDown; /** - * Gets/Sets the orientation of the `IgxDatePickerComponent` header. + * Gets/Sets the orientation of the date picker header. * * @example * ```html diff --git a/projects/igniteui-angular/date-picker/src/date-range-picker/date-range-picker.component.ts b/projects/igniteui-angular/date-picker/src/date-range-picker/date-range-picker.component.ts index c3c941c52d4..275a29c762a 100644 --- a/projects/igniteui-angular/date-picker/src/date-range-picker/date-range-picker.component.ts +++ b/projects/igniteui-angular/date-picker/src/date-range-picker/date-range-picker.component.ts @@ -354,7 +354,7 @@ export class IgxDateRangePickerComponent extends PickerBaseDirective } /** - * Sets the `placeholder` for single-input `IgxDateRangePickerComponent`. + * Sets the `placeholder` for single-input date range picker. * * @example * ```html @@ -368,7 +368,7 @@ export class IgxDateRangePickerComponent extends PickerBaseDirective * Gets/Sets the container used for the popup element. * * @remarks - * `outlet` is an instance of `IgxOverlayOutletDirective` or an `ElementRef`. + * `outlet` is an instance of overlay outlet or an `ElementRef`. * @example * ```html *
diff --git a/projects/igniteui-angular/directives/src/directives/button/button.directive.ts b/projects/igniteui-angular/directives/src/directives/button/button.directive.ts index 15714511be0..e60ba67208c 100644 --- a/projects/igniteui-angular/directives/src/directives/button/button.directive.ts +++ b/projects/igniteui-angular/directives/src/directives/button/button.directive.ts @@ -102,7 +102,7 @@ export class IgxButtonDirective extends IgxButtonBaseDirective { /** * 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 diff --git a/projects/igniteui-angular/directives/src/directives/button/icon-button.directive.ts b/projects/igniteui-angular/directives/src/directives/button/icon-button.directive.ts index 7cad2ca3ae8..beeea335120 100644 --- a/projects/igniteui-angular/directives/src/directives/button/icon-button.directive.ts +++ b/projects/igniteui-angular/directives/src/directives/button/icon-button.directive.ts @@ -7,7 +7,7 @@ import { IgxBaseButtonType, IgxButtonBaseDirective } from './button-base'; export 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 diff --git a/projects/igniteui-angular/directives/src/directives/checkbox/checkbox-base.directive.ts b/projects/igniteui-angular/directives/src/directives/checkbox/checkbox-base.directive.ts index e37e78cc1ba..b5ff879b848 100644 --- a/projects/igniteui-angular/directives/src/directives/checkbox/checkbox-base.directive.ts +++ b/projects/igniteui-angular/directives/src/directives/checkbox/checkbox-base.directive.ts @@ -30,7 +30,7 @@ export class CheckboxBaseDirective implements AfterViewInit { /** * 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. */ // eslint-disable-next-line @angular-eslint/no-output-native @Output() public readonly change: EventEmitter = diff --git a/projects/igniteui-angular/directives/src/directives/drag-drop/drag-drop.directive.ts b/projects/igniteui-angular/directives/src/directives/drag-drop/drag-drop.directive.ts index 23dd0b25719..489805e51c7 100644 --- a/projects/igniteui-angular/directives/src/directives/drag-drop/drag-drop.directive.ts +++ b/projects/igniteui-angular/directives/src/directives/drag-drop/drag-drop.directive.ts @@ -1646,12 +1646,12 @@ export class IgxDropDirective implements OnInit, OnDestroy { public 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 *
diff --git a/projects/igniteui-angular/directives/src/directives/for-of/for_of.directive.ts b/projects/igniteui-angular/directives/src/directives/for-of/for_of.directive.ts index 61ef7f970ee..d2c7465b3f2 100644 --- a/projects/igniteui-angular/directives/src/directives/for-of/for_of.directive.ts +++ b/projects/igniteui-angular/directives/src/directives/for-of/for_of.directive.ts @@ -554,7 +554,7 @@ export class IgxForOfDirective extends IgxForOfToken(dir: IgxForOfDirective, ctx: any): ctx is IgxForOfContext { @@ -1661,10 +1661,10 @@ export class IgxGridForOfDirective extends IgxForOfDirec /** * @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 for of 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 for of structural directive renders its template with a specific context type. */ public static override ngTemplateContextGuard(dir: IgxGridForOfDirective, ctx: any): ctx is IgxGridForOfContext { diff --git a/projects/igniteui-angular/directives/src/directives/mask/mask.directive.ts b/projects/igniteui-angular/directives/src/directives/mask/mask.directive.ts index b92a9cb15d3..0152847ead0 100644 --- a/projects/igniteui-angular/directives/src/directives/mask/mask.directive.ts +++ b/projects/igniteui-angular/directives/src/directives/mask/mask.directive.ts @@ -412,7 +412,7 @@ export class IgxMaskDirective implements OnInit, AfterViewChecked, ControlValueA } /** - * The IgxMaskModule provides the {@link IgxMaskDirective} inside your application. + * The mask provides the {@link mask} inside your application. */ export interface IMaskEventArgs extends IBaseEventArgs { rawValue: string; diff --git a/projects/igniteui-angular/directives/src/directives/notification/notifications.directive.ts b/projects/igniteui-angular/directives/src/directives/notification/notifications.directive.ts index 4961236e67d..af3a58bf610 100644 --- a/projects/igniteui-angular/directives/src/directives/notification/notifications.directive.ts +++ b/projects/igniteui-angular/directives/src/directives/notification/notifications.directive.ts @@ -33,11 +33,15 @@ export abstract class IgxNotificationsDirective extends IgxToggleDirective * Gets/Sets the container used for the element. * * @remarks +<<<<<<< copilot/improve-public-api-docs + * `outlet` is an instance of overlay outlet or an `ElementRef`. +======= * `outlet` is an instance of `IgxOverlayOutletDirective` or an `ElementRef`. * * @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 * DOM tree position instead and use `positioning` property as needed. +>>>>>>> master */ @Input() public outlet: IgxOverlayOutletDirective | ElementRef; diff --git a/projects/igniteui-angular/directives/src/directives/toggle/toggle.directive.ts b/projects/igniteui-angular/directives/src/directives/toggle/toggle.directive.ts index 0424bb58d75..8439ea44b22 100644 --- a/projects/igniteui-angular/directives/src/directives/toggle/toggle.directive.ts +++ b/projects/igniteui-angular/directives/src/directives/toggle/toggle.directive.ts @@ -150,7 +150,7 @@ export class IgxToggleDirective implements IToggleView, OnInit, OnDestroy { } /** - * Identifier which is registered into `IgxNavigationService` + * Identifier which is registered into navigation * * ```typescript * let myToggleId = this.toggle.id; @@ -443,11 +443,15 @@ export class IgxToggleActionDirective implements OnInit { * *
* ``` +<<<<<<< copilot/improve-public-api-docs + * Where `outlet` in an instance of overlay outlet or an `ElementRef` +======= * Where `outlet` in an instance of `IgxOverlayOutletDirective` or an `ElementRef` * * @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 * DOM tree position instead or use `container` property instead. +>>>>>>> master */ @Input('igxToggleOutlet') public outlet: IgxOverlayOutletDirective | ElementRef; diff --git a/projects/igniteui-angular/directives/src/directives/tooltip/tooltip-target.directive.ts b/projects/igniteui-angular/directives/src/directives/tooltip/tooltip-target.directive.ts index c55e158f229..77bca12da8a 100644 --- a/projects/igniteui-angular/directives/src/directives/tooltip/tooltip-target.directive.ts +++ b/projects/igniteui-angular/directives/src/directives/tooltip/tooltip-target.directive.ts @@ -663,7 +663,7 @@ export class IgxTooltipTargetDirective extends IgxToggleActionDirective implemen } /** - * 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(template?: TemplateRef | undefined): void { diff --git a/projects/igniteui-angular/drop-down/src/drop-down/drop-down-item.base.ts b/projects/igniteui-angular/drop-down/src/drop-down/drop-down-item.base.ts index 4d6d57664bb..7d6746557e5 100644 --- a/projects/igniteui-angular/drop-down/src/drop-down/drop-down-item.base.ts +++ b/projects/igniteui-angular/drop-down/src/drop-down/drop-down-item.base.ts @@ -198,7 +198,7 @@ export class IgxDropDownItemBaseDirective implements DoCheck { *
* * ``` - * **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 */ @Input({ transform: booleanAttribute }) @HostBinding('attr.aria-disabled') diff --git a/projects/igniteui-angular/drop-down/src/drop-down/drop-down-navigation.directive.ts b/projects/igniteui-angular/drop-down/src/drop-down/drop-down-navigation.directive.ts index 840a220c879..1e1a9e0b298 100644 --- a/projects/igniteui-angular/drop-down/src/drop-down/drop-down-navigation.directive.ts +++ b/projects/igniteui-angular/drop-down/src/drop-down/drop-down-navigation.directive.ts @@ -5,7 +5,7 @@ import { IgxDropDownBaseDirective } from './drop-down.base'; import { DropDownActionKey } from './drop-down.common'; /** - * 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 */ @Directive({ selector: '[igxDropDownItemNavigation]', diff --git a/projects/igniteui-angular/drop-down/src/drop-down/drop-down.base.ts b/projects/igniteui-angular/drop-down/src/drop-down/drop-down.base.ts index 6a65ef09274..16fad77242a 100644 --- a/projects/igniteui-angular/drop-down/src/drop-down/drop-down.base.ts +++ b/projects/igniteui-angular/drop-down/src/drop-down/drop-down.base.ts @@ -15,7 +15,7 @@ let NEXT_ID = 0; /** * 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 */ @@ -170,7 +170,7 @@ export 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. */ public get activeDescendant (): string { return this.focusedItem ? this.focusedItem.id : null; diff --git a/projects/igniteui-angular/drop-down/src/drop-down/drop-down.common.ts b/projects/igniteui-angular/drop-down/src/drop-down/drop-down.common.ts index 5a2d064c592..ffb933e4703 100644 --- a/projects/igniteui-angular/drop-down/src/drop-down/drop-down.common.ts +++ b/projects/igniteui-angular/drop-down/src/drop-down/drop-down.common.ts @@ -9,7 +9,7 @@ export enum Navigate { Down = 1 } -/** Key actions that have designated handlers in IgxDropDownComponent */ +/** Key actions that have designated handlers in drop down */ export const DropDownActionKey = { ESCAPE: 'escape', ENTER: 'enter', @@ -29,7 +29,7 @@ export interface ISelectionEventArgs extends CancelableEventArgs, IBaseEventArgs } /** - * Interface for an instance of IgxDropDownNavigationDirective + * Interface for an instance of drop down navigation * * @export */ diff --git a/projects/igniteui-angular/grids/core/src/cell.component.ts b/projects/igniteui-angular/grids/core/src/cell.component.ts index dba01a886aa..9b479fd5692 100644 --- a/projects/igniteui-angular/grids/core/src/cell.component.ts +++ b/projects/igniteui-angular/grids/core/src/cell.component.ts @@ -64,7 +64,7 @@ import { IgxDatePickerComponent } from 'igniteui-angular/date-picker'; import { IgxTimePickerComponent } from 'igniteui-angular/time-picker'; /** - * Providing reference to `IgxGridCellComponent`: + * Providing reference to grid cell: * ```typescript * @ViewChild('grid', { read: IgxGridComponent }) * public grid: IgxGridComponent; diff --git a/projects/igniteui-angular/grids/core/src/column-actions/column-actions.component.ts b/projects/igniteui-angular/grids/core/src/column-actions/column-actions.component.ts index 0c474bc8585..167cd772390 100644 --- a/projects/igniteui-angular/grids/core/src/column-actions/column-actions.component.ts +++ b/projects/igniteui-angular/grids/core/src/column-actions/column-actions.component.ts @@ -11,7 +11,7 @@ import { ColumnType } from 'igniteui-angular/core'; let NEXT_ID = 0; /** - * Providing reference to `IgxColumnActionsComponent`: + * Providing reference to column actions: * ```typescript * @ViewChild('columnActions', { read: IgxColumnActionsComponent }) * public columnActions: IgxColumnActionsComponent; @@ -246,7 +246,7 @@ export class IgxColumnActionsComponent implements DoCheck { * Gets the text of the button that unchecks all columns. * * @remarks - * If unset it is obtained from the IgxColumnActionsBased derived directive applied. + * If unset it is obtained from the column actions based derived directive applied. * @example * ```typescript * let uncheckAllText = this.columnActions.uncheckAllText; @@ -271,7 +271,7 @@ export class IgxColumnActionsComponent implements DoCheck { * Gets the text of the button that checks all columns. * * @remarks - * If unset it is obtained from the IgxColumnActionsBased derived directive applied. + * If unset it is obtained from the column actions based derived directive applied. * @example * ```typescript * let uncheckAllText = this.columnActions.uncheckAllText; @@ -285,7 +285,7 @@ export class IgxColumnActionsComponent implements DoCheck { * Sets the text of the button that checks all columns. * * @remarks - * If unset it is obtained from the IgxColumnActionsBased derived directive applied. + * If unset it is obtained from the column actions based derived directive applied. * @example * ```html * diff --git a/projects/igniteui-angular/grids/core/src/common/events.ts b/projects/igniteui-angular/grids/core/src/common/events.ts index f1e9b6d4d9c..ec5c9423177 100644 --- a/projects/igniteui-angular/grids/core/src/common/events.ts +++ b/projects/igniteui-angular/grids/core/src/common/events.ts @@ -280,14 +280,14 @@ export interface IGridToolbarExportEventArgs extends IBaseEventArgs { grid: GridType; /** * The `exporter` is a base service. - * The type (an abstract class `IgxBaseExporter`) has it's own properties and methods + * The type (an abstract class base exporter) has it's own properties and methods * It is used to define the format and options of the export, the exported element * and methods for preparing the data from the elements for exporting */ exporter: IgxBaseExporter; /** * Represents the different settings, that can be given to an export - * The type (an abstract class `IgxExporterOptionsBase`) has properties for column settings + * The type (an abstract class exporter options base) has properties for column settings * (whether they should be ignored) as well as method for generating a file name */ options: IgxExporterOptionsBase; @@ -461,7 +461,7 @@ export interface IGridScrollEventArgs extends IBaseEventArgs { /** * Event emitted when a checkbox in the checkbox - * list of an IgxColumnActions component is clicked. + * list of an column actions component is clicked. */ export interface IColumnToggledEventArgs extends IBaseEventArgs { /** The column that is toggled. */ diff --git a/projects/igniteui-angular/grids/core/src/filtering/grid-filtering.service.ts b/projects/igniteui-angular/grids/core/src/filtering/grid-filtering.service.ts index 8754c91d499..a196db3474a 100644 --- a/projects/igniteui-angular/grids/core/src/filtering/grid-filtering.service.ts +++ b/projects/igniteui-angular/grids/core/src/filtering/grid-filtering.service.ts @@ -280,7 +280,7 @@ export class IgxFilteringService implements OnDestroy { } /** - * Filters all the `IgxColumnComponent` in the `IgxGridComponent` with the same condition. + * Filters all the column in the grid with the same condition. * @deprecated in version 19.0.0. */ public filterGlobal(value: any, condition, ignoreCase?) { diff --git a/projects/igniteui-angular/grids/core/src/grid-public-row.ts b/projects/igniteui-angular/grids/core/src/grid-public-row.ts index 6f4e95258ba..c4adfcee680 100644 --- a/projects/igniteui-angular/grids/core/src/grid-public-row.ts +++ b/projects/igniteui-angular/grids/core/src/grid-public-row.ts @@ -175,7 +175,7 @@ abstract class BaseRow implements RowType { } /** - * Returns if the row has child rows. Always return false for IgxGridRow. + * Returns if the row has child rows. Always return false for grid row. */ public get hasChildren(): boolean { return false; @@ -412,7 +412,7 @@ export class IgxTreeGridRow extends BaseRow implements RowType { } /** - * Returns true if child rows exist. Always return false for IgxGridRow. + * Returns true if child rows exist. Always return false for grid row. */ public override get hasChildren(): boolean { if (this.treeRow.children) { @@ -550,7 +550,7 @@ export class IgxGroupByRow implements RowType { public grid: GridType; /** - * Returns always true, because this is in instance of an IgxGroupByRow. + * Returns always true, because this is in instance of an group by row. */ public isGroupByRow: boolean; @@ -703,7 +703,7 @@ export class IgxSummaryRow implements RowType { public grid: GridType; /** - * Returns always true, because this is in instance of an IgxGroupByRow. + * Returns always true, because this is in instance of an group by row. */ public isSummaryRow: boolean; diff --git a/projects/igniteui-angular/grids/core/src/pivot-grid.interface.ts b/projects/igniteui-angular/grids/core/src/pivot-grid.interface.ts index edbb95dc676..ecb96cb4294 100644 --- a/projects/igniteui-angular/grids/core/src/pivot-grid.interface.ts +++ b/projects/igniteui-angular/grids/core/src/pivot-grid.interface.ts @@ -74,7 +74,7 @@ export interface IPivotAggregator { /* blazorOnlyScript */ /** * Aggregator function can be a custom implementation of `PivotAggregation`, or - * use predefined ones from `IgxPivotAggregate` and its variants. + * use predefined ones from pivot aggregate and its variants. */ aggregator?: (members: any[], data?: any[]) => any; } @@ -161,7 +161,7 @@ export interface IPivotValue { aggregateList?: IPivotAggregator[]; /** Enables/Disables a particular value from pivot aggregation. */ enabled: boolean; - /** Allow conditionally styling of the IgxPivotGrid cells. */ + /** Allow conditionally styling of the pivot grid cells. */ styles?: any; /** Enables a data type specific template of the cells */ dataType?: GridColumnDataType; diff --git a/projects/igniteui-angular/grids/core/src/services/csv/csv-exporter.ts b/projects/igniteui-angular/grids/core/src/services/csv/csv-exporter.ts index a85e1affe0a..a45624ff4e4 100644 --- a/projects/igniteui-angular/grids/core/src/services/csv/csv-exporter.ts +++ b/projects/igniteui-angular/grids/core/src/services/csv/csv-exporter.ts @@ -16,7 +16,7 @@ export interface ICsvExportEndedEventArgs extends IBaseEventArgs { * [Documentation](https://www.infragistics.com/products/ignite-ui-angular/angular/components/exporter-csv) * * The Ignite UI for Angular CSV Exporter service can export data in a Character Separated Values format from - * both raw data (array) or from an `IgxGrid`. + * both raw data (array) or from an grid. * * Example: * ```typescript diff --git a/projects/igniteui-angular/grids/core/src/services/excel/excel-exporter.ts b/projects/igniteui-angular/grids/core/src/services/excel/excel-exporter.ts index 299373c5127..8b235c784fb 100644 --- a/projects/igniteui-angular/grids/core/src/services/excel/excel-exporter.ts +++ b/projects/igniteui-angular/grids/core/src/services/excel/excel-exporter.ts @@ -25,7 +25,7 @@ const EXCEL_MAX_COLS = 16384; * [Documentation](https://www.infragistics.com/products/ignite-ui-angular/angular/components/exporter_excel.html) * * The Ignite UI for Angular Excel Exporter service can export data in Microsoft® Excel® format from both raw data - * (array) or from an `IgxGrid`. + * (array) or from an grid. * * Example: * ```typescript diff --git a/projects/igniteui-angular/grids/core/src/services/exporter-common/base-export-service.ts b/projects/igniteui-angular/grids/core/src/services/exporter-common/base-export-service.ts index 3261ec5fbaf..8300701f48d 100644 --- a/projects/igniteui-angular/grids/core/src/services/exporter-common/base-export-service.ts +++ b/projects/igniteui-angular/grids/core/src/services/exporter-common/base-export-service.ts @@ -217,7 +217,7 @@ export abstract class IgxBaseExporter { /* alternateName: exportGrid */ /** - * Method for exporting IgxGrid component's data. + * Method for exporting grid component's data. * ```typescript * this.exporterService.export(this.igxGridForExport, this.exportOptions); * ``` diff --git a/projects/igniteui-angular/grids/core/src/services/exporter-common/exporter-options-base.ts b/projects/igniteui-angular/grids/core/src/services/exporter-common/exporter-options-base.ts index db18b6659f1..a7a6de40a0e 100644 --- a/projects/igniteui-angular/grids/core/src/services/exporter-common/exporter-options-base.ts +++ b/projects/igniteui-angular/grids/core/src/services/exporter-common/exporter-options-base.ts @@ -22,7 +22,7 @@ export abstract class IgxExporterOptionsBase { public ignoreFiltering = false; /** - * Specifies if the exporter should ignore the current column order in the IgxGrid. + * Specifies if the exporter should ignore the current column order in the grid. * ```typescript * let ignoreColumnsOrder = this.exportOptions.ignoreColumnsOrder; * this.exportOptions.ignoreColumnsOrder = true; @@ -33,7 +33,7 @@ export abstract class IgxExporterOptionsBase { public ignoreColumnsOrder = false; /** - * Specifies whether the exported data should be sorted as in the provided IgxGrid. + * Specifies whether the exported data should be sorted as in the provided grid. * When you export grouped data, setting ignoreSorting to true will cause * the grouping to fail because it relies on the sorting of the records. * ```typescript @@ -46,7 +46,7 @@ export abstract class IgxExporterOptionsBase { public ignoreSorting = false; /** - * Specifies whether the exported data should be grouped as in the provided IgxGrid. + * Specifies whether the exported data should be grouped as in the provided grid. * ```typescript * let ignoreGrouping = this.exportOptions.ignoreGrouping; * this.exportOptions.ignoreGrouping = true; @@ -57,7 +57,7 @@ export abstract class IgxExporterOptionsBase { public ignoreGrouping = false; /** - * Specifies whether the exported data should include multi column headers as in the provided IgxGrid. + * Specifies whether the exported data should include multi column headers as in the provided grid. * ```typescript * let ignoreMultiColumnHeaders = this.exportOptions.ignoreMultiColumnHeaders; * this.exportOptions.ignoreMultiColumnHeaders = true; diff --git a/projects/igniteui-angular/grids/core/src/services/pdf/pdf-exporter.ts b/projects/igniteui-angular/grids/core/src/services/pdf/pdf-exporter.ts index f8d9dcb7b24..e8fe3dd4fc5 100644 --- a/projects/igniteui-angular/grids/core/src/services/pdf/pdf-exporter.ts +++ b/projects/igniteui-angular/grids/core/src/services/pdf/pdf-exporter.ts @@ -14,7 +14,7 @@ export interface IPdfExportEndedEventArgs extends IBaseEventArgs { * [Documentation](https://www.infragistics.com/products/ignite-ui-angular/angular/components/exporter_pdf.html) * * The Ignite UI for Angular PDF Exporter service can export data in PDF format from both raw data - * (array) or from an `IgxGrid`. + * (array) or from an grid. * * Example: * ```typescript diff --git a/projects/igniteui-angular/grids/core/src/state-base.directive.ts b/projects/igniteui-angular/grids/core/src/state-base.directive.ts index d1e2afecf97..da1edc41ca7 100644 --- a/projects/igniteui-angular/grids/core/src/state-base.directive.ts +++ b/projects/igniteui-angular/grids/core/src/state-base.directive.ts @@ -615,7 +615,7 @@ export class IgxGridStateBaseDirective { /** * This method restores complex objects in the pivot dimensions - * Like the IgxPivotDateDimension and filters. + * Like the pivot date dimension and filters. */ private restoreDimensions(config: IPivotConfiguration) { const collections = [config.rows, config.columns, config.filters]; @@ -635,7 +635,7 @@ export class IgxGridStateBaseDirective { /** - * This method restores the IgxPivotDateDimension with its default functions and resource strings. + * This method restores the pivot date dimension with its default functions and resource strings. */ private restoreDateDimension(dim: IgxPivotDateDimension) { const dateDim = new IgxPivotDateDimension((dim as any)._baseDimension, (dim as any)._options); @@ -652,7 +652,7 @@ export class IgxGridStateBaseDirective { } /** - * Returns if this is a IgxPivotDateDimension. + * Returns if this is a pivot date dimension. */ private isDateDimension(dim: IPivotDimension) { return (dim as any)._baseDimension; diff --git a/projects/igniteui-angular/grids/core/src/summaries/grid-summary.ts b/projects/igniteui-angular/grids/core/src/summaries/grid-summary.ts index 6e62b803bfb..4e979cd62b4 100644 --- a/projects/igniteui-angular/grids/core/src/summaries/grid-summary.ts +++ b/projects/igniteui-angular/grids/core/src/summaries/grid-summary.ts @@ -19,7 +19,7 @@ export class IgxSummaryOperand { return data.length; } /** - * Executes the static `count` method and returns `IgxSummaryResult[]`. + * Executes the static `count` method and returns summary result[]`. * ```typescript * interface IgxSummaryResult { * key: string; @@ -110,7 +110,7 @@ export class IgxNumberSummaryOperand extends IgxSummaryOperand { return data.length && data.filter(clear).length ? this.sum(data) / this.count(data) : 0; } /** - * Executes the static methods and returns `IgxSummaryResult[]`. + * Executes the static methods and returns summary result[]`. * ```typescript * interface IgxSummaryResult { * key: string; @@ -204,7 +204,7 @@ export class IgxDateSummaryOperand extends IgxSummaryOperand { last(data.filter(clear).sort((a, b) => new Date(b).valueOf() - new Date(a).valueOf())) : undefined; } /** - * Executes the static methods and returns `IgxSummaryResult[]`. + * Executes the static methods and returns summary result[]`. * ```typescript * interface IgxSummaryResult { * key: string; diff --git a/projects/igniteui-angular/grids/grid/index.ts b/projects/igniteui-angular/grids/grid/index.ts index caec6711424..0f8b896ab92 100644 --- a/projects/igniteui-angular/grids/grid/index.ts +++ b/projects/igniteui-angular/grids/grid/index.ts @@ -1,5 +1,5 @@ /** - * IgxGrid - Standard data grid component + * Grid - Standard data grid component * * Import grid-specific components and re-export core grid functionality */ diff --git a/projects/igniteui-angular/grids/grid/src/grid-base.directive.ts b/projects/igniteui-angular/grids/grid/src/grid-base.directive.ts index e83e4f0e266..fd0c04fe09d 100644 --- a/projects/igniteui-angular/grids/grid/src/grid-base.directive.ts +++ b/projects/igniteui-angular/grids/grid/src/grid-base.directive.ts @@ -285,7 +285,7 @@ export abstract class IgxGridBaseDirective implements GridType, } /** - * Get/Set IgxSummaryRow height + * Get/Set summary row height */ @Input() public set summaryRowHeight(value: number) { @@ -484,7 +484,7 @@ export abstract class IgxGridBaseDirective implements GridType, * Emitted when a cell is clicked. * * @remarks - * Returns the `IgxGridCell`. + * Returns the grid cell. * @example * ```html * @@ -497,7 +497,7 @@ export abstract class IgxGridBaseDirective implements GridType, * Emitted when a row is clicked. * * @remarks - * Returns the `IgxGridRow`. + * Returns the grid row. * @example * ```html * @@ -533,7 +533,7 @@ export abstract class IgxGridBaseDirective implements GridType, * Emitted when a cell is selected. * * @remarks - * Returns the `IgxGridCell`. + * Returns the grid cell. * @example * ```html * @@ -543,7 +543,7 @@ export abstract class IgxGridBaseDirective implements GridType, public selected = new EventEmitter(); /** - * Emitted when `IgxGridRowComponent` is selected. + * Emitted when grid row is selected. * * @example * ```html @@ -554,7 +554,7 @@ export abstract class IgxGridBaseDirective implements GridType, public rowSelectionChanging = new EventEmitter(); /** - * Emitted when `IgxColumnComponent` is selected. + * Emitted when column is selected. * * @example * ```html @@ -565,7 +565,7 @@ export abstract class IgxGridBaseDirective implements GridType, public columnSelectionChanging = new EventEmitter(); /** - * Emitted before `IgxColumnComponent` is pinned. + * Emitted before column is pinned. * * @remarks * The index at which to insert the column may be changed through the `insertAtIndex` property. @@ -582,7 +582,7 @@ export abstract class IgxGridBaseDirective implements GridType, public columnPin = new EventEmitter(); /** - * Emitted after `IgxColumnComponent` is pinned. + * Emitted after column is pinned. * * @remarks * The index that the column is inserted at may be changed through the `insertAtIndex` property. @@ -795,7 +795,7 @@ export abstract class IgxGridBaseDirective implements GridType, * Emitted when a row is added. * * @remarks - * Returns the data for the new `IgxGridRowComponent` object. + * Returns the data for the new grid row object. * @example * ```html * @@ -850,7 +850,7 @@ export abstract class IgxGridBaseDirective implements GridType, * Emitted after column is resized. * * @remarks - * Returns the `IgxColumnComponent` object's old and new width. + * Returns the column object's old and new width. * @example * ```html * @@ -863,7 +863,7 @@ export abstract class IgxGridBaseDirective implements GridType, * Emitted when a cell or row is right clicked. * * @remarks - * Returns the `IgxGridCell` object if the immediate context menu target is a cell or an `IgxGridRow` otherwise. + * Returns the grid cell object if the immediate context menu target is a cell or an grid row otherwise. * ```html * * ``` @@ -875,7 +875,7 @@ export abstract class IgxGridBaseDirective implements GridType, * Emitted when a cell is double clicked. * * @remarks - * Returns the `IgxGridCell` object. + * Returns the grid cell object. * @example * ```html * @@ -901,7 +901,7 @@ export abstract class IgxGridBaseDirective implements GridType, * Emitted after column visibility is changed. * * @remarks - * Args: { column: IgxColumnComponent, newValue: boolean } + * Args: { column: column, newValue: boolean } * @example * ```html * @@ -914,7 +914,7 @@ export abstract class IgxGridBaseDirective implements GridType, * Emitted when column moving starts. * * @remarks - * Returns the moved `IgxColumnComponent` object. + * Returns the moved column object. * @example * ```html * @@ -927,7 +927,7 @@ export abstract class IgxGridBaseDirective implements GridType, * Emitted during the column moving operation. * * @remarks - * Returns the source and target `IgxColumnComponent` objects. This event is cancelable. + * Returns the source and target column objects. This event is cancelable. * @example * ```html * @@ -940,7 +940,7 @@ export abstract class IgxGridBaseDirective implements GridType, * Emitted when column moving ends. * * @remarks - * Returns the source and target `IgxColumnComponent` objects. + * Returns the source and target column objects. * @example * ```html * @@ -985,7 +985,7 @@ export abstract class IgxGridBaseDirective implements GridType, * Emitted when a copy operation is executed. * * @remarks - * Fired only if copy behavior is enabled through the [`clipboardOptions`]{@link IgxGridBaseDirective#clipboardOptions}. + * Fired only if copy behavior is enabled through the [`clipboardOptions`]{@link grid base#clipboardOptions}. */ @Output() public gridCopy = new EventEmitter(); @@ -1851,7 +1851,7 @@ export abstract class IgxGridBaseDirective implements GridType, } /** - * Gets/Sets the filtering logic of the `IgxGridComponent`. + * Gets/Sets the filtering logic of the grid. * * @remarks * The default is AND. @@ -2587,7 +2587,7 @@ export abstract class IgxGridBaseDirective implements GridType, /* csSuppress */ /** - * A list of `IgxGridRowComponent`. + * A list of grid row. * * @example * ```typescript @@ -2608,7 +2608,7 @@ export abstract class IgxGridBaseDirective implements GridType, /* csSuppress */ /** - * A list of currently rendered `IgxGridRowComponent`'s. + * A list of currently rendered grid row's. * * @example * ```typescript @@ -2927,7 +2927,7 @@ export abstract class IgxGridBaseDirective implements GridType, * * @remarks * By default the row selection mode is 'none' - * Note that in IgxGrid and IgxHierarchicalGrid 'multipleCascade' behaves like 'multiple' + * Note that in grid and hierarchical grid 'multipleCascade' behaves like 'multiple' */ @WatchChanges() @Input() @@ -4625,7 +4625,7 @@ export abstract class IgxGridBaseDirective implements GridType, } /** - * Gets an array of `IgxColumnComponent`s. + * Gets an array of columns. * * @example * ```typescript @@ -4637,7 +4637,7 @@ export abstract class IgxGridBaseDirective implements GridType, } /** - * Gets an array of the pinned `IgxColumnComponent`s. + * Gets an array of the pinned columns. * * @example * ```typescript @@ -4653,7 +4653,7 @@ export abstract class IgxGridBaseDirective implements GridType, } /** - * Gets an array of the pinned to the left `IgxColumnComponent`s. + * Gets an array of the pinned to the left columns. * * @example * ```typescript @@ -4665,7 +4665,7 @@ export abstract class IgxGridBaseDirective implements GridType, } /** - * Gets an array of the pinned to the right `IgxColumnComponent`s. + * Gets an array of the pinned to the right columns. * * @example * ```typescript @@ -4678,7 +4678,7 @@ export abstract class IgxGridBaseDirective implements GridType, /* csSuppress */ /** - * Gets an array of the pinned `IgxRowComponent`s. + * Gets an array of the pinned rows. * * @example * ```typescript @@ -4690,7 +4690,7 @@ export abstract class IgxGridBaseDirective implements GridType, } /** - * Gets an array of unpinned `IgxColumnComponent`s. + * Gets an array of unpinned columns. * * @example * ```typescript @@ -4706,7 +4706,7 @@ export abstract class IgxGridBaseDirective implements GridType, } /** - * Gets the `width` to be set on `IgxGridHeaderGroupComponent`. + * Gets the `width` to be set on grid header group. */ public getHeaderGroupWidth(column: IgxColumnComponent): string { return this.hasColumnLayouts @@ -4715,7 +4715,7 @@ export abstract class IgxGridBaseDirective implements GridType, } /** - * Returns the `IgxColumnComponent` by field name. + * Returns the column by field name. * * @example * ```typescript @@ -4753,7 +4753,7 @@ export abstract class IgxGridBaseDirective implements GridType, } /** - * Returns an array of visible `IgxColumnComponent`s. + * Returns an array of visible columns. * * @example * ```typescript @@ -4920,7 +4920,7 @@ export abstract class IgxGridBaseDirective implements GridType, } /** - * Triggers change detection for the `IgxGridComponent`. + * Triggers change detection for the grid. * Calling markForCheck also triggers the grid pipes explicitly, resulting in all updates being processed. * May degrade performance if used when not needed, or if misused: * ```typescript @@ -4952,7 +4952,7 @@ export abstract class IgxGridBaseDirective implements GridType, /* csSuppress */ /** - * Creates a new `IgxGridRowComponent` and adds the data record to the end of the data source. + * Creates a new grid row and adds the data record to the end of the data source. * * @example * ```typescript @@ -4972,7 +4972,7 @@ export abstract class IgxGridBaseDirective implements GridType, /* blazorCSSuppress */ /** - * Removes the `IgxGridRowComponent` and the corresponding data record by primary key. + * Removes the grid row and the corresponding data record by primary key. * * @remarks * Requires that the `primaryKey` property is set. @@ -5023,7 +5023,7 @@ export abstract class IgxGridBaseDirective implements GridType, /* blazorCSSuppress */ /** - * Updates the `IgxGridRowComponent` and the corresponding data record by primary key. + * Updates the grid row and the corresponding data record by primary key. * * @remarks * Requires that the `primaryKey` property is set. @@ -5064,7 +5064,7 @@ export abstract class IgxGridBaseDirective implements GridType, /* blazorCSSuppress */ /** - * Updates the `IgxGridRowComponent` + * Updates the grid row * * @remarks * The row is specified by @@ -5119,10 +5119,10 @@ export abstract class IgxGridBaseDirective implements GridType, } /** - * Sort a single `IgxColumnComponent`. + * Sort a single column. * * @remarks - * Sort the `IgxGridComponent`'s `IgxColumnComponent` based on the provided array of sorting expressions. + * Sort the grid's column based on the provided array of sorting expressions. * @example * ```typescript * this.grid.sort({ fieldName: name, dir: SortingDirection.Asc, ignoreCase: false }); @@ -5163,7 +5163,7 @@ export abstract class IgxGridBaseDirective implements GridType, } /** - * Filters a single `IgxColumnComponent`. + * Filters a single column. * * @example * ```typescript @@ -5182,7 +5182,7 @@ export abstract class IgxGridBaseDirective implements GridType, } /** - * Filters all the `IgxColumnComponent` in the `IgxGridComponent` with the same condition. + * Filters all the column in the grid with the same condition. * * @example * ```typescript @@ -5244,10 +5244,10 @@ export abstract class IgxGridBaseDirective implements GridType, } /** - * If name is provided, clears the filtering state of the corresponding `IgxColumnComponent`. + * If name is provided, clears the filtering state of the corresponding column. * * @remarks - * Otherwise clears the filtering state of all `IgxColumnComponent`s. + * Otherwise clears the filtering state of all columns. * @example * ```typescript * this.grid.clearFilter(); @@ -5259,10 +5259,10 @@ export abstract class IgxGridBaseDirective implements GridType, } /** - * If name is provided, clears the sorting state of the corresponding `IgxColumnComponent`. + * If name is provided, clears the sorting state of the corresponding column. * * @remarks - * otherwise clears the sorting state of all `IgxColumnComponent`. + * otherwise clears the sorting state of all column. * @example * ```typescript * this.grid.clearSort(); @@ -6286,7 +6286,7 @@ export abstract class IgxGridBaseDirective implements GridType, * * @remarks * You can pass callback function as a third parameter of `getPreviousCell` method. - * The callback function accepts IgxColumnComponent as a param + * The callback function accepts column as a param * @example * ```typescript * const nextEditableCellPosition = this.grid.getNextCell(0, 3, (column) => column.editable); @@ -6322,7 +6322,7 @@ export abstract class IgxGridBaseDirective implements GridType, * * @remarks * You can pass callback function as a third parameter of `getPreviousCell` method. - * The callback function accepts IgxColumnComponent as a param + * The callback function accepts column as a param * @example * ```typescript * const previousEditableCellPosition = this.grid.getPreviousCell(0, 3, (column) => column.editable); diff --git a/projects/igniteui-angular/grids/grid/src/grid.component.ts b/projects/igniteui-angular/grids/grid/src/grid.component.ts index 602070787a0..142f47429d7 100644 --- a/projects/igniteui-angular/grids/grid/src/grid.component.ts +++ b/projects/igniteui-angular/grids/grid/src/grid.component.ts @@ -207,7 +207,7 @@ export class IgxGridComponent extends IgxGridBaseDirective implements GridType, * The `groupingDone` event would be raised only once if several columns get grouped at once by calling * the `groupBy()` or `clearGrouping()` API methods and passing an array as an argument. * The event arguments provide the `expressions`, `groupedColumns` and `ungroupedColumns` properties, which contain - * the `ISortingExpression` and the `IgxColumnComponent` related to the grouping/ungrouping operation. + * the `ISortingExpression` and the column related to the grouping/ungrouping operation. * Please note that `groupedColumns` and `ungroupedColumns` show only the **newly** changed columns (affected by the **last** * grouping/ungrouping operation), not all columns which are currently grouped/ungrouped. * columns. @@ -591,7 +591,7 @@ export class IgxGridComponent extends IgxGridBaseDirective implements GridType, /** * Gets/Sets the grouping strategy of the grid. * - * @remarks The default IgxGrouping extends from IgxSorting and a custom one can be used as a `sortStrategy` as well. + * @remarks The default grouping extends from sorting and a custom one can be used as a `sortStrategy` as well. * * @example * ```html @@ -744,7 +744,7 @@ export class IgxGridComponent extends IgxGridBaseDirective implements GridType, public trackChanges: (index, rec) => any; /** - * Groups by a new `IgxColumnComponent` based on the provided expression, or modifies an existing one. + * Groups by a new column based on the provided expression, or modifies an existing one. * * @remarks * Also allows for multiple columns to be grouped at once if an array of `ISortingExpression` is passed. @@ -897,7 +897,7 @@ export class IgxGridComponent extends IgxGridBaseDirective implements GridType, } /** - * Returns whether the `IgxGridComponent` has group area. + * Returns whether the grid has group area. * * @example * ```typescript @@ -1126,7 +1126,7 @@ export class IgxGridComponent extends IgxGridBaseDirective implements GridType, } /** - * Returns the `IgxGridRow` by index. + * Returns the grid row by index. * * @example * ```typescript @@ -1154,7 +1154,7 @@ export class IgxGridComponent extends IgxGridBaseDirective implements GridType, } /** - * Returns `IgxGridRow` object by the specified primary key. + * Returns grid row object by the specified primary key. * * @remarks * Requires that the `primaryKey` property is set. @@ -1188,7 +1188,7 @@ export class IgxGridComponent extends IgxGridBaseDirective implements GridType, } /** - * Returns the collection of `IgxGridRow`s for current page. + * Returns the collection of grid rows for current page. * * @hidden @internal */ @@ -1197,7 +1197,7 @@ export class IgxGridComponent extends IgxGridBaseDirective implements GridType, } /** - * Returns an array of the selected `IgxGridCell`s. + * Returns an array of the selected grid cells. * * @example * ```typescript diff --git a/projects/igniteui-angular/grids/hierarchical-grid/index.ts b/projects/igniteui-angular/grids/hierarchical-grid/index.ts index dd3d9f120c0..45298ce9417 100644 --- a/projects/igniteui-angular/grids/hierarchical-grid/index.ts +++ b/projects/igniteui-angular/grids/hierarchical-grid/index.ts @@ -1,5 +1,5 @@ /** - * IgxHierarchicalGrid - Hierarchical grid component for parent-child data + * Hierarchical grid - Hierarchical grid component for parent-child data * * Import hierarchical-grid-specific components and re-export core grid functionality */ diff --git a/projects/igniteui-angular/grids/hierarchical-grid/src/hierarchical-grid.component.ts b/projects/igniteui-angular/grids/hierarchical-grid/src/hierarchical-grid.component.ts index 96951a552b1..0e061b09a26 100644 --- a/projects/igniteui-angular/grids/hierarchical-grid/src/hierarchical-grid.component.ts +++ b/projects/igniteui-angular/grids/hierarchical-grid/src/hierarchical-grid.component.ts @@ -477,7 +477,7 @@ export class IgxHierarchicalGridComponent extends IgxHierarchicalGridBaseDirecti } /** - * Returns an array of data set to the `IgxHierarchicalGridComponent`. + * Returns an array of data set to the hierarchical grid. * ```typescript * let filteredData = this.grid.filteredData; * ``` @@ -523,7 +523,7 @@ export class IgxHierarchicalGridComponent extends IgxHierarchicalGridBaseDirecti } /** - * Sets if all immediate children of the `IgxHierarchicalGridComponent` should be expanded/collapsed. + * Sets if all immediate children of the hierarchical grid should be expanded/collapsed. * Default value is false. * ```html * @@ -538,7 +538,7 @@ export class IgxHierarchicalGridComponent extends IgxHierarchicalGridBaseDirecti } /** - * Gets if all immediate children of the `IgxHierarchicalGridComponent` previously have been set to be expanded/collapsed. + * Gets if all immediate children of the hierarchical grid previously have been set to be expanded/collapsed. * If previously set and some rows have been manually expanded/collapsed it will still return the last set value. * ```typescript * const expanded = this.grid.expandChildren; @@ -790,7 +790,7 @@ export class IgxHierarchicalGridComponent extends IgxHierarchicalGridBaseDirecti } /** - * Returns the collection of `IgxHierarchicalGridRow`s for current page. + * Returns the collection of hierarchical grid rows for current page. * * @hidden @internal */ @@ -799,7 +799,7 @@ export class IgxHierarchicalGridComponent extends IgxHierarchicalGridBaseDirecti } /** - * Returns an array of the selected `IgxGridCell`s. + * Returns an array of the selected grid cells. * * @example * ```typescript diff --git a/projects/igniteui-angular/grids/hierarchical-grid/src/row-island.component.ts b/projects/igniteui-angular/grids/hierarchical-grid/src/row-island.component.ts index 9f605bf95f1..0f6b2690f80 100644 --- a/projects/igniteui-angular/grids/hierarchical-grid/src/row-island.component.ts +++ b/projects/igniteui-angular/grids/hierarchical-grid/src/row-island.component.ts @@ -319,7 +319,7 @@ export class IgxRowIslandComponent extends IgxHierarchicalGridBaseDirective private _paginatorTemplate: TemplateRef; /** - * Sets if all immediate children of the grids for this `IgxRowIslandComponent` should be expanded/collapsed. + * Sets if all immediate children of the grids for this row island should be expanded/collapsed. * ```html * * @@ -346,7 +346,7 @@ export class IgxRowIslandComponent extends IgxHierarchicalGridBaseDirective } /** - * Gets if all immediate children of the grids for this `IgxRowIslandComponent` have been set to be expanded/collapsed. + * Gets if all immediate children of the grids for this row island have been set to be expanded/collapsed. * ```typescript * const expanded = this.rowIsland.expandChildren; * ``` diff --git a/projects/igniteui-angular/grids/lite/src/grid-lite.component.ts b/projects/igniteui-angular/grids/lite/src/grid-lite.component.ts index e79e9fd20d1..2e163507098 100644 --- a/projects/igniteui-angular/grids/lite/src/grid-lite.component.ts +++ b/projects/igniteui-angular/grids/lite/src/grid-lite.component.ts @@ -204,7 +204,7 @@ export class IgxGridLiteComponent implements OnInit { } /** - * Returns a {@link IgxGridLiteColumnConfiguration} for a given column. + * Returns a {@link grid lite column configuration} for a given column. */ public getColumn(id: Keys | number): IgxGridLiteColumnConfiguration | undefined { return this.gridRef.nativeElement.getColumn(id); diff --git a/projects/igniteui-angular/grids/pivot-grid/index.ts b/projects/igniteui-angular/grids/pivot-grid/index.ts index f8d1bc52029..815c65af133 100644 --- a/projects/igniteui-angular/grids/pivot-grid/index.ts +++ b/projects/igniteui-angular/grids/pivot-grid/index.ts @@ -1,5 +1,5 @@ /** - * IgxPivotGrid - Pivot grid component for data analysis + * Pivot grid - Pivot grid component for data analysis * * Import pivot-grid-specific components and re-export core grid functionality */ diff --git a/projects/igniteui-angular/grids/tree-grid/index.ts b/projects/igniteui-angular/grids/tree-grid/index.ts index 348c2d252f1..138c09ba310 100644 --- a/projects/igniteui-angular/grids/tree-grid/index.ts +++ b/projects/igniteui-angular/grids/tree-grid/index.ts @@ -1,5 +1,5 @@ /** - * IgxTreeGrid - Tree grid component for hierarchical data + * Tree grid - Tree grid component for hierarchical data * * Import tree-grid-specific components and re-export core grid functionality */ diff --git a/projects/igniteui-angular/grids/tree-grid/src/tree-grid.component.ts b/projects/igniteui-angular/grids/tree-grid/src/tree-grid.component.ts index 111e589abb0..217e9856131 100644 --- a/projects/igniteui-angular/grids/tree-grid/src/tree-grid.component.ts +++ b/projects/igniteui-angular/grids/tree-grid/src/tree-grid.component.ts @@ -149,7 +149,7 @@ export class IgxTreeGridComponent extends IgxGridBaseDirective implements GridTy protected override transactionFactory = inject(IgxHierarchicalTransactionFactory); /** - * Sets the child data key of the `IgxTreeGridComponent`. + * Sets the child data key of the tree grid. * ```html * * ``` @@ -160,7 +160,7 @@ export class IgxTreeGridComponent extends IgxGridBaseDirective implements GridTy public childDataKey: string; /** - * Sets the foreign key of the `IgxTreeGridComponent`. + * Sets the foreign key of the tree grid. * ```html * * @@ -375,7 +375,7 @@ export class IgxTreeGridComponent extends IgxGridBaseDirective implements GridTy } /** - * Sets the count of levels to be expanded in the `IgxTreeGridComponent`. By default it is + * Sets the count of levels to be expanded in the tree grid. By default it is * set to `Infinity` which means all levels would be expanded. * ```html * @@ -564,7 +564,7 @@ export class IgxTreeGridComponent extends IgxGridBaseDirective implements GridTy /* blazorCSSuppress */ /** - * Creates a new `IgxTreeGridRowComponent` with the given data. If a parentRowID is not specified, the newly created + * Creates a new tree grid row with the given data. If a parentRowID is not specified, the newly created * row would be added at the root level. Otherwise, it would be added as a child of the row whose primaryKey matches * the specified parentRowID. If the parentRowID does not exist, an error would be thrown. * ```typescript @@ -741,7 +741,7 @@ export class IgxTreeGridComponent extends IgxGridBaseDirective implements GridTy } /** - * Returns the `IgxTreeGridRow` by index. + * Returns the tree grid row by index. * * @example * ```typescript @@ -785,7 +785,7 @@ export class IgxTreeGridComponent extends IgxGridBaseDirective implements GridTy } /** - * Returns the collection of `IgxTreeGridRow`s for current page. + * Returns the collection of tree grid rows for current page. * * @hidden @internal */ @@ -794,7 +794,7 @@ export class IgxTreeGridComponent extends IgxGridBaseDirective implements GridTy } /** - * Returns an array of the selected `IgxGridCell`s. + * Returns an array of the selected grid cells. * * @example * ```typescript diff --git a/projects/igniteui-angular/icon/src/icon/icon.service.ts b/projects/igniteui-angular/icon/src/icon/icon.service.ts index 1371da2a988..096d7411738 100644 --- a/projects/igniteui-angular/icon/src/icon/icon.service.ts +++ b/projects/igniteui-angular/icon/src/icon/icon.service.ts @@ -24,8 +24,8 @@ export interface IgxIconLoadedEvent { /** * **Ignite UI for Angular Icon Service** - * - * The Ignite UI Icon Service makes it easy for developers to include custom SVG images and use them with IgxIconComponent. - * In addition it could be used to associate a custom class to be applied on IgxIconComponent according to given font-family. + * The Ignite UI Icon Service makes it easy for developers to include custom SVG images and use them with icon. + * In addition it could be used to associate a custom class to be applied on icon according to given font-family. * * Example: * ```typescript @@ -107,7 +107,7 @@ export class IgxIconService { } /** - * Registers a custom class to be applied to IgxIconComponent for a given font-family. + * Registers a custom class to be applied to icon for a given font-family. * ```typescript * this.iconService.registerFamilyAlias('material', 'material-icons'); * ``` @@ -158,7 +158,7 @@ export class IgxIconService { } /** - * Creates a family to className relationship that is applied to the IgxIconComponent + * Creates a family to className relationship that is applied to the icon * whenever that family name is used. * ```typescript * this.iconService.setFamily('material', { className: 'material-icons', type: 'liga' }); diff --git a/projects/igniteui-angular/input-group/src/input-group/input-group.component.ts b/projects/igniteui-angular/input-group/src/input-group/input-group.component.ts index a383dd82702..ee155b97204 100644 --- a/projects/igniteui-angular/input-group/src/input-group/input-group.component.ts +++ b/projects/igniteui-angular/input-group/src/input-group/input-group.component.ts @@ -61,7 +61,7 @@ export class IgxInputGroupComponent implements IgxInputGroupBase, AfterContentCh } /** - * Property that enables/disables the auto-generated class of the `IgxInputGroupComponent`. + * Property that enables/disables the auto-generated class of the input group. * By default applied the class is applied. * ```typescript * @ViewChild("MyInputGroup") @@ -88,8 +88,8 @@ export class IgxInputGroupComponent implements IgxInputGroupBase, AfterContentCh /** * @hidden @internal - * When truthy, disables the `IgxInputGroupComponent`. - * Controlled by the underlying `IgxInputDirective`. + * When truthy, disables the input group. + * Controlled by the underlying input. * ```html * * ``` @@ -173,7 +173,7 @@ export class IgxInputGroupComponent implements IgxInputGroupBase, AfterContentCh /** * Sets how the input will be styled. - * Allowed values of type IgxInputGroupType. + * Allowed values of type input group type. * ```html * * ``` @@ -184,7 +184,7 @@ export class IgxInputGroupComponent implements IgxInputGroupBase, AfterContentCh } /** - * Returns the type of the `IgxInputGroupComponent`. How the input is styled. + * Returns the type of the input group. How the input is styled. * The default is `line`. * ```typescript * @ViewChild("MyInputGroup") @@ -200,7 +200,7 @@ export class IgxInputGroupComponent implements IgxInputGroupBase, AfterContentCh /** * Sets the theme of the input. - * Allowed values of type IgxInputGroupTheme. + * Allowed values of type input group theme. * ```typescript * @ViewChild("MyInputGroup") * public inputGroup: IgxInputGroupComponent; @@ -215,7 +215,7 @@ export class IgxInputGroupComponent implements IgxInputGroupBase, AfterContentCh /** * Returns the theme of the input. - * The returned value is of type IgxInputGroupType. + * The returned value is of type input group type. * ```typescript * @ViewChild("MyInputGroup") * public inputGroup: IgxInputGroupComponent; @@ -267,7 +267,7 @@ export class IgxInputGroupComponent implements IgxInputGroupBase, AfterContentCh } /** - * Returns whether the `IgxInputGroupComponent` has hints. + * Returns whether the input group has hints. * ```typescript * @ViewChild("MyInputGroup") * public inputGroup: IgxInputGroupComponent; @@ -303,7 +303,7 @@ export class IgxInputGroupComponent implements IgxInputGroupBase, AfterContentCh } /** - * Returns whether the `IgxInputGroupComponent` has border. + * Returns whether the input group has border. * ```typescript * @ViewChild("MyInputGroup") * public inputGroup: IgxInputGroupComponent; @@ -320,7 +320,7 @@ export class IgxInputGroupComponent implements IgxInputGroupBase, AfterContentCh } /** - * Returns whether the `IgxInputGroupComponent` type is line. + * Returns whether the input group type is line. * ```typescript * @ViewChild("MyInputGroup1") * public inputGroup: IgxInputGroupComponent; @@ -334,7 +334,7 @@ export class IgxInputGroupComponent implements IgxInputGroupBase, AfterContentCh } /** - * Returns whether the `IgxInputGroupComponent` type is box. + * Returns whether the input group type is box. * ```typescript * @ViewChild("MyInputGroup1") * public inputGroup: IgxInputGroupComponent; @@ -389,7 +389,7 @@ export class IgxInputGroupComponent implements IgxInputGroupBase, AfterContentCh } /** - * Returns whether the `IgxInputGroupComponent` type is border. + * Returns whether the input group type is border. * ```typescript * @ViewChild("MyInputGroup1") * public inputGroup: IgxInputGroupComponent; @@ -404,7 +404,7 @@ export class IgxInputGroupComponent implements IgxInputGroupBase, AfterContentCh } /** - * Returns true if the `IgxInputGroupComponent` theme is Fluent. + * Returns true if the input group theme is Fluent. * ```typescript * @ViewChild("MyInputGroup1") * public inputGroup: IgxInputGroupComponent; @@ -419,7 +419,7 @@ export class IgxInputGroupComponent implements IgxInputGroupBase, AfterContentCh } /** - * Returns true if the `IgxInputGroupComponent` theme is Bootstrap. + * Returns true if the input group theme is Bootstrap. * ```typescript * @ViewChild("MyInputGroup1") * public inputGroup: IgxInputGroupComponent; @@ -434,7 +434,7 @@ export class IgxInputGroupComponent implements IgxInputGroupBase, AfterContentCh } /** - * Returns true if the `IgxInputGroupComponent` theme is Indigo. + * Returns true if the input group theme is Indigo. * ```typescript * @ViewChild("MyInputGroup1") * public inputGroup: IgxInputGroupComponent; @@ -449,7 +449,7 @@ export class IgxInputGroupComponent implements IgxInputGroupBase, AfterContentCh } /** - * Returns whether the `IgxInputGroupComponent` type is search. + * Returns whether the input group type is search. * ```typescript * @ViewChild("MyInputGroup1") * public inputGroup: IgxInputGroupComponent; diff --git a/projects/igniteui-angular/list/src/list/list-item.component.ts b/projects/igniteui-angular/list/src/list/list-item.component.ts index 2616f6c47b8..67dbe72630c 100644 --- a/projects/igniteui-angular/list/src/list/list-item.component.ts +++ b/projects/igniteui-angular/list/src/list/list-item.component.ts @@ -193,7 +193,7 @@ export class IgxListItemComponent implements IListChild { /** * Returns the `context` object which represents the `template context` binding into the `list item container` - * by providing the `$implicit` declaration which is the `IgxListItemComponent` itself. + * by providing the `$implicit` declaration which is the list item itself. * ```typescript * let listItemComponent = this.listItem.context; * ``` diff --git a/projects/igniteui-angular/list/src/list/list.component.ts b/projects/igniteui-angular/list/src/list/list.component.ts index 6a32ac34d52..ef1b41b70e8 100644 --- a/projects/igniteui-angular/list/src/list/list.component.ts +++ b/projects/igniteui-angular/list/src/list/list.component.ts @@ -169,7 +169,7 @@ export class IgxListComponent extends IgxListBaseDirective { * Sets/gets the empty list template. * * @remarks - * This template is used by IgxList in case there are no list items + * This template is used by list in case there are no list items * defined and `isLoading` is set to `false`. * * @example @@ -191,7 +191,7 @@ export class IgxListComponent extends IgxListBaseDirective { * Sets/gets the list loading template. * * @remarks - * This template is used by IgxList in case there are no list items defined and `isLoading` is set to `true`. + * This template is used by list in case there are no list items defined and `isLoading` is set to `true`. * * @example * ```html @@ -394,7 +394,7 @@ export class IgxListComponent extends IgxListBaseDirective { * Event emitted when a pan item is returned to its original position. * * @remarks - * Provides a reference to an object of type `IgxListComponent` as an event argument. + * Provides a reference to an object of type list as an event argument. * * @example * ```html @@ -409,7 +409,7 @@ export class IgxListComponent extends IgxListBaseDirective { * Event emitted when a pan gesture is executed on a list item. * * @remarks - * Provides references to the `IgxListItemComponent` and `IgxListPanState` as event arguments. + * Provides references to the list item and list pan state as event arguments. * * @example * ```html @@ -423,7 +423,7 @@ export class IgxListComponent extends IgxListBaseDirective { * Event emitted when a list item is clicked. * * @remarks - * Provides references to the `IgxListItemComponent` and `Event` as event arguments. + * Provides references to the list item and `Event` as event arguments. * * @example * ```html @@ -572,7 +572,7 @@ export class IgxListComponent extends IgxListBaseDirective { * * @remarks * Gets the `context` object which represents the `template context` binding into the `list container` - * by providing the `$implicit` declaration which is the `IgxListComponent` itself. + * by providing the `$implicit` declaration which is the list itself. * * @example * ```typescript diff --git a/projects/igniteui-angular/navbar/src/navbar/navbar.component.ts b/projects/igniteui-angular/navbar/src/navbar/navbar.component.ts index a77b55962a6..f1409a41e64 100644 --- a/projects/igniteui-angular/navbar/src/navbar/navbar.component.ts +++ b/projects/igniteui-angular/navbar/src/navbar/navbar.component.ts @@ -12,7 +12,7 @@ import { import { IgxIconComponent } from 'igniteui-angular/icon'; /** - * IgxActionIcon is a container for the action nav icon of the IgxNavbar. + * Action icon is a container for the action nav icon of the navbar. */ @Directive({ selector: '[igxNavbarAction],igx-navbar-action', @@ -69,7 +69,7 @@ export class IgxNavbarComponent { public id = `igx-navbar-${NEXT_ID++}`; /** - * Sets the icon of the `IgxNavbarComponent`. + * Sets the icon of the navbar. * ```html * * ``` @@ -77,7 +77,7 @@ export class IgxNavbarComponent { @Input() public actionButtonIcon: string; /** - * Sets the title of the `IgxNavbarComponent`. + * Sets the title of the navbar. * ```html * * ``` @@ -86,7 +86,7 @@ export class IgxNavbarComponent { /** * The event that will be thrown when the action is executed, - * provides reference to the `IgxNavbar` component as argument + * provides reference to the navbar component as argument * ```typescript * public actionExc(event){ * alert("Action Execute!"); @@ -100,7 +100,7 @@ export class IgxNavbarComponent { @Output() public action = new EventEmitter(); /** - * Sets the titleId of the `IgxNavbarComponent`. If not set it will be automatically generated. + * Sets the titleId of the navbar. If not set it will be automatically generated. * ```html * * ``` @@ -123,7 +123,7 @@ export class IgxNavbarComponent { private isVisible = true; /** - * Sets whether the action button of the `IgxNavbarComponent` is visible. + * Sets whether the action button of the navbar is visible. * ```html * * ``` @@ -133,7 +133,7 @@ export class IgxNavbarComponent { } /** - * Returns whether the `IgxNavbarComponent` action button is visible, true/false. + * Returns whether the navbar action button is visible, true/false. * ```typescript * @ViewChild("MyChild") * public navBar: IgxNavbarComponent; diff --git a/projects/igniteui-angular/paginator/src/paginator/paginator.component.ts b/projects/igniteui-angular/paginator/src/paginator/paginator.component.ts index ea384e6f111..a3d93733f61 100644 --- a/projects/igniteui-angular/paginator/src/paginator/paginator.component.ts +++ b/projects/igniteui-angular/paginator/src/paginator/paginator.component.ts @@ -316,7 +316,7 @@ export class IgxPaginatorComponent implements IgxPaginatorToken { } /** - * Goes to the next page of the `IgxPaginatorComponent`, if the paginator is not already at the last page. + * Goes to the next page of the paginator, if the paginator is not already at the last page. * ```typescript * this.paginator.nextPage(); * ``` @@ -329,7 +329,7 @@ export class IgxPaginatorComponent implements IgxPaginatorToken { } } /** - * Goes to the previous page of the `IgxPaginatorComponent`, if the paginator is not already at the first page. + * Goes to the previous page of the paginator, if the paginator is not already at the first page. * ```typescript * this.paginator.previousPage(); * ``` diff --git a/projects/igniteui-angular/progressbar/src/progressbar/progressbar.component.ts b/projects/igniteui-angular/progressbar/src/progressbar/progressbar.component.ts index 18aad18850c..afba90f95cd 100644 --- a/projects/igniteui-angular/progressbar/src/progressbar/progressbar.component.ts +++ b/projects/igniteui-angular/progressbar/src/progressbar/progressbar.component.ts @@ -270,7 +270,7 @@ export abstract class BaseProgressDirective { } /** - * Returns the `IgxLinearProgressBarComponent`/`IgxCircularProgressBarComponent` value in percentage. + * Returns the linear progress bar/circular progress bar value in percentage. * ```typescript * @ViewChild("MyProgressBar") * public progressBar: IgxLinearProgressBarComponent / IgxCircularProgressBarComponent @@ -286,7 +286,7 @@ export abstract class BaseProgressDirective { } /** - * Returns value that indicates the current `IgxLinearProgressBarComponent`/`IgxCircularProgressBarComponent` position. + * Returns value that indicates the current linear progress bar/circular progress bar position. * ```typescript * @ViewChild("MyProgressBar") * public progressBar: IgxLinearProgressBarComponent / IgxCircularProgressBarComponent; @@ -329,7 +329,7 @@ export abstract class BaseProgressDirective { } /** - * Set value that indicates the current `IgxLinearProgressBarComponent / IgxCircularProgressBarComponent` position. + * Set value that indicates the current linear progress bar / circular progress bar position. * ```html * * @@ -378,7 +378,7 @@ export class IgxLinearProgressBarComponent extends BaseProgressDirective impleme public cssClass = 'igx-linear-bar'; /** - * Set `IgxLinearProgressBarComponent` to have striped style. By default it is set to false. + * Set linear progress bar to have striped style. By default it is set to false. * ```html * * ``` @@ -434,7 +434,7 @@ export class IgxLinearProgressBarComponent extends BaseProgressDirective impleme /** * Set the position that defines where the text is aligned. - * Possible options - `IgxTextAlign.START` (default), `IgxTextAlign.CENTER`, `IgxTextAlign.END`. + * Possible options - text align.START` (default), text align.CENTER`, text align.END`. * ```typescript * public positionCenter: IgxTextAlign; * public ngOnInit() { @@ -468,7 +468,7 @@ export class IgxLinearProgressBarComponent extends BaseProgressDirective impleme public textTop = false; /** - * Set type of the `IgxLinearProgressBarComponent`. Possible options - `default`, `success`, `info`, `warning`, and `error`. + * Set type of the linear progress bar. Possible options - `default`, `success`, `info`, `warning`, and `error`. * ```html * * ``` @@ -601,7 +601,7 @@ export class IgxCircularProgressBarComponent extends BaseProgressDirective imple } /** - * Set type of the `IgxCircularProgressBarComponent`. Possible options - `default`, `success`, `info`, `warning`, and `error`. + * Set type of the circular progress bar. Possible options - `default`, `success`, `info`, `warning`, and `error`. * ```html * * ``` diff --git a/projects/igniteui-angular/query-builder/src/query-builder/query-builder-header.component.ts b/projects/igniteui-angular/query-builder/src/query-builder/query-builder-header.component.ts index 70fb8580b42..0de3c6f6faa 100644 --- a/projects/igniteui-angular/query-builder/src/query-builder/query-builder-header.component.ts +++ b/projects/igniteui-angular/query-builder/src/query-builder/query-builder-header.component.ts @@ -30,7 +30,7 @@ export class IgxQueryBuilderHeaderComponent { } /** - * Sets the title of the `IgxQueryBuilderHeaderComponent`. + * Sets the title of the query builder header. * * @example * ```html diff --git a/projects/igniteui-angular/query-builder/src/query-builder/query-builder.component.ts b/projects/igniteui-angular/query-builder/src/query-builder/query-builder.component.ts index 37e9aa1a898..c49e75e7c75 100644 --- a/projects/igniteui-angular/query-builder/src/query-builder/query-builder.component.ts +++ b/projects/igniteui-angular/query-builder/src/query-builder/query-builder.component.ts @@ -62,7 +62,7 @@ export class IgxQueryBuilderComponent implements OnDestroy { public showEntityChangeDialog = true; /** - * Gets the list of entities available for the IgxQueryBuilderComponent. + * Gets the list of entities available for the query builder. * * Each entity describes a logical group of fields that can be used in queries. * An entity can optionally have child entities, allowing nested sub-queries. @@ -74,7 +74,7 @@ export class IgxQueryBuilderComponent implements OnDestroy { } /** - * Sets the list of entities for the IgxQueryBuilderComponent. + * Sets the list of entities for the query builder. * If the `expressionTree` is defined, it will be recreated with the new entities. * * Each entity should be an {@link EntityType} object describing the fields and optionally child entities. diff --git a/projects/igniteui-angular/radio/src/radio/radio-group/radio-group.directive.ts b/projects/igniteui-angular/radio/src/radio/radio-group/radio-group.directive.ts index 8fb9c40cc14..aa145775b2a 100644 --- a/projects/igniteui-angular/radio/src/radio/radio-group/radio-group.directive.ts +++ b/projects/igniteui-angular/radio/src/radio/radio-group/radio-group.directive.ts @@ -185,7 +185,7 @@ export class IgxRadioGroupDirective implements ControlValueAccessor, OnDestroy, * An event that is emitted after the radio group `value` is changed. * * @remarks - * Provides references to the selected `IgxRadioComponent` and the `value` property as event arguments. + * Provides references to the selected radio and the `value` property as event arguments. * * @example * ```html @@ -439,7 +439,7 @@ export class IgxRadioGroupDirective implements ControlValueAccessor, OnDestroy, * * @remarks * Checks whether the provided value is consistent to the current radio button. - * If it is, the checked attribute will have value `true` and selected property will contain the selected `IgxRadioComponent`. + * If it is, the checked attribute will have value `true` and selected property will contain the selected radio. * * @example * ```typescript diff --git a/projects/igniteui-angular/select/src/select/select.component.ts b/projects/igniteui-angular/select/src/select/select.component.ts index ef1ea836949..9024fdad631 100644 --- a/projects/igniteui-angular/select/src/select/select.component.ts +++ b/projects/igniteui-angular/select/src/select/select.component.ts @@ -120,7 +120,7 @@ export class IgxSelectComponent extends IgxDropDownComponent implements IgxSelec @Input({ transform: booleanAttribute }) public disabled = false; /** - * Sets custom OverlaySettings `IgxSelectComponent`. + * Sets custom OverlaySettings select. * ```html * * ``` diff --git a/projects/igniteui-angular/slider/src/slider/slider.common.ts b/projects/igniteui-angular/slider/src/slider/slider.common.ts index 49fd25f3d81..5b06db2bb9a 100644 --- a/projects/igniteui-angular/slider/src/slider/slider.common.ts +++ b/projects/igniteui-angular/slider/src/slider/slider.common.ts @@ -1,7 +1,7 @@ import { Directive } from '@angular/core'; /** - * Template directive that allows you to set a custom template representing the lower label value of the {@link IgxSliderComponent} + * Template directive that allows you to set a custom template representing the lower label value of the {@link slider} * * ```html * @@ -9,7 +9,7 @@ import { Directive } from '@angular/core'; * * ``` * - * @context {@link IgxSliderComponent.context} + * @context {@link slider.context} */ @Directive({ selector: '[igxSliderThumbFrom]', @@ -18,7 +18,7 @@ import { Directive } from '@angular/core'; export class IgxThumbFromTemplateDirective {} /** - * Template directive that allows you to set a custom template representing the upper label value of the {@link IgxSliderComponent} + * Template directive that allows you to set a custom template representing the upper label value of the {@link slider} * * ```html * @@ -26,7 +26,7 @@ export class IgxThumbFromTemplateDirective {} * * ``` * - * @context {@link IgxSliderComponent.context} + * @context {@link slider.context} */ @Directive({ selector: '[igxSliderThumbTo]', @@ -35,9 +35,9 @@ export class IgxThumbFromTemplateDirective {} export class IgxThumbToTemplateDirective {} /** - * Template directive that allows you to set a custom template, represeting primary/secondary tick labels of the {@link IgxSliderComponent} + * Template directive that allows you to set a custom template, represeting primary/secondary tick labels of the {@link slider} * - * @context {@link IgxTicksComponent.context} + * @context {@link ticks.context} */ @Directive({ selector: '[igxSliderTickLabel]', diff --git a/projects/igniteui-angular/slider/src/slider/slider.component.ts b/projects/igniteui-angular/slider/src/slider/slider.component.ts index 9c742100f4a..a44ca1fab1f 100644 --- a/projects/igniteui-angular/slider/src/slider/slider.component.ts +++ b/projects/igniteui-angular/slider/src/slider/slider.component.ts @@ -130,8 +130,8 @@ export class IgxSliderComponent implements } /** - * Gets the type of the `IgxSliderComponent`. - * The slider can be IgxSliderType.SLIDER(default) or IgxSliderType.RANGE. + * Gets the type of the slider. + * The slider can be slider type.SLIDER(default) or slider type.RANGE. * ```typescript * @ViewChild("slider2") * public slider: IgxSliderComponent; @@ -145,8 +145,8 @@ export class IgxSliderComponent implements } /** - * Sets the type of the `IgxSliderComponent`. - * The slider can be IgxSliderType.SLIDER(default) or IgxSliderType.RANGE. + * Sets the type of the slider. + * The slider can be slider type.SLIDER(default) or slider type.RANGE. * ```typescript * sliderType: IgxSliderType = IgxSliderType.RANGE; * ``` @@ -194,7 +194,7 @@ export class IgxSliderComponent implements /** * Returns the template context corresponding - * to {@link IgxThumbFromTemplateDirective} and {@link IgxThumbToTemplateDirective} templates. + * to {@link thumb from template} and {@link thumb to template} templates. * * ```typescript * return { @@ -231,7 +231,7 @@ export class IgxSliderComponent implements } /** - * Returns the incremental/decremental dragging step of the {@link IgxSliderComponent}. + * Returns the incremental/decremental dragging step of the {@link slider}. * ```typescript * @ViewChild("slider2") * public slider: IgxSliderComponent; @@ -245,7 +245,7 @@ export class IgxSliderComponent implements } /** - * Returns if the {@link IgxSliderComponent} is disabled. + * Returns if the {@link slider} is disabled. * ```typescript * @ViewChild("slider2") * public slider: IgxSliderComponent; @@ -274,7 +274,7 @@ export class IgxSliderComponent implements } /** - * Returns if the {@link IgxSliderComponent} is set as continuous. + * Returns if the {@link slider} is set as continuous. * ```typescript * @ViewChild("slider2") * public slider: IgxSliderComponent; @@ -289,10 +289,10 @@ export class IgxSliderComponent implements } /** - * Sets the {@link IgxSliderComponent} as continuous. - * By default is considered that the {@link IgxSliderComponent} is discrete. - * Discrete {@link IgxSliderComponent} slider has step indicators over the track and visible thumb labels during interaction. - * Continuous {@link IgxSliderComponent} does not have ticks and does not show bubble labels for values. + * Sets the {@link slider} as continuous. + * By default is considered that the {@link slider} is discrete. + * Discrete {@link slider} slider has step indicators over the track and visible thumb labels during interaction. + * Continuous {@link slider} does not have ticks and does not show bubble labels for values. * ```html * * ``` @@ -305,7 +305,7 @@ export class IgxSliderComponent implements } /** - * Returns the minimal displayed track value of the `IgxSliderComponent`. + * Returns the minimal displayed track value of the slider. * ```typescript * @ViewChild("slider2") * public slider: IgxSliderComponent; @@ -323,7 +323,7 @@ export class IgxSliderComponent implements } /** - * Sets the minimal displayed track value for the `IgxSliderComponent`. + * Sets the minimal displayed track value for the slider. * The default minimal value is 0. * ```html * @@ -353,7 +353,7 @@ export class IgxSliderComponent implements } /** - * Returns the maximum displayed track value for the {@link IgxSliderComponent}. + * Returns the maximum displayed track value for the {@link slider}. * ```typescript * @ViewChild("slider") * public slider: IgxSliderComponent; @@ -369,7 +369,7 @@ export class IgxSliderComponent implements } /** - * Sets the maximal displayed track value for the `IgxSliderComponent`. + * Sets the maximal displayed track value for the slider. * The default maximum value is 100. * ```html * @@ -399,7 +399,7 @@ export class IgxSliderComponent implements } /** - * Returns the lower boundary of settable values of the `IgxSliderComponent`. + * Returns the lower boundary of settable values of the slider. * If not set, will return `minValue`. * ```typescript * @ViewChild("slider") @@ -418,7 +418,7 @@ export class IgxSliderComponent implements } /** - * Sets the lower boundary of settable values of the `IgxSliderComponent`. + * Sets the lower boundary of settable values of the slider. * If not set is the same as min value. * ```html * @@ -438,7 +438,7 @@ export class IgxSliderComponent implements } /** - * Returns the upper boundary of settable values of the `IgxSliderComponent`. + * Returns the upper boundary of settable values of the slider. * If not set, will return `maxValue` * ```typescript * @ViewChild("slider") @@ -457,7 +457,7 @@ export class IgxSliderComponent implements } /** - * Sets the upper boundary of the `IgxSliderComponent`. + * Sets the upper boundary of the slider. * If not set is the same as max value. * ```html * @@ -476,8 +476,8 @@ export class IgxSliderComponent implements } /** - * Returns the slider value. If the slider is of type {@link IgxSliderType.SLIDER} the returned value is number. - * If the slider type is {@link IgxSliderType.RANGE}. + * Returns the slider value. If the slider is of type {@link slider type.SLIDER} the returned value is number. + * If the slider type is {@link slider type.RANGE}. * The returned value represents an object of {@link lowerValue} and {@link upperValue}. * ```typescript * @ViewChild("slider2") @@ -500,9 +500,9 @@ export class IgxSliderComponent implements /** * Sets the slider value. - * If the slider is of type {@link IgxSliderType.SLIDER}. + * If the slider is of type {@link slider type.SLIDER}. * The argument is number. By default the {@link value} gets the {@link lowerBound}. - * If the slider type is {@link IgxSliderType.RANGE} the argument + * If the slider type is {@link slider type.RANGE} the argument * represents an object of {@link lowerValue} and {@link upperValue} properties. * By default the object is associated with the {@link lowerBound} and {@link upperBound} property values. * ```typescript @@ -768,7 +768,7 @@ export class IgxSliderComponent implements } /** - * Returns whether the `IgxSliderComponent` type is RANGE. + * Returns whether the slider type is RANGE. * ```typescript * @ViewChild("slider") * public slider: IgxSliderComponent; @@ -782,7 +782,7 @@ export class IgxSliderComponent implements } /** - * Returns the lower value of a RANGE `IgxSliderComponent`. + * Returns the lower value of a RANGE slider. * ```typescript * @ViewChild("slider") * public slider: IgxSliderComponent; @@ -800,7 +800,7 @@ export class IgxSliderComponent implements } /** - * Sets the lower value of a RANGE `IgxSliderComponent`. + * Sets the lower value of a RANGE slider. * ```typescript * @ViewChild("slider") * public slider: IgxSliderComponent; @@ -820,8 +820,8 @@ export class IgxSliderComponent implements } /** - * Returns the upper value of a RANGE `IgxSliderComponent`. - * Returns `value` of a SLIDER `IgxSliderComponent` + * Returns the upper value of a RANGE slider. + * Returns `value` of a SLIDER slider * ```typescript * @ViewChild("slider2") * public slider: IgxSliderComponent; @@ -839,7 +839,7 @@ export class IgxSliderComponent implements } /** - * Sets the upper value of a RANGE `IgxSliderComponent`. + * Sets the upper value of a RANGE slider. * ```typescript * @ViewChild("slider2") * public slider: IgxSliderComponent; diff --git a/projects/igniteui-angular/slider/src/slider/ticks/ticks.component.ts b/projects/igniteui-angular/slider/src/slider/ticks/ticks.component.ts index f95a509a261..611e25be5bb 100644 --- a/projects/igniteui-angular/slider/src/slider/ticks/ticks.component.ts +++ b/projects/igniteui-angular/slider/src/slider/ticks/ticks.component.ts @@ -84,7 +84,7 @@ export class IgxTicksComponent { /** * Returns the template context corresponding to - * {@link IgxTickLabelTemplateDirective} + * {@link tick label template} * * ```typescript * return { diff --git a/projects/igniteui-angular/snackbar/src/snackbar/snackbar.component.ts b/projects/igniteui-angular/snackbar/src/snackbar/snackbar.component.ts index 576a3be383b..06a542084a4 100644 --- a/projects/igniteui-angular/snackbar/src/snackbar/snackbar.component.ts +++ b/projects/igniteui-angular/snackbar/src/snackbar/snackbar.component.ts @@ -73,7 +73,7 @@ export class IgxSnackbarComponent extends IgxNotificationsDirective /** * An event that will be emitted when the action button is clicked. - * Provides reference to the `IgxSnackbarComponent` as an argument. + * Provides reference to the snackbar as an argument. * ```html * * ``` diff --git a/projects/igniteui-angular/splitter/src/splitter/splitter-pane/splitter-pane.component.ts b/projects/igniteui-angular/splitter/src/splitter/splitter-pane/splitter-pane.component.ts index 380065de59e..f77c5c95226 100644 --- a/projects/igniteui-angular/splitter/src/splitter/splitter-pane/splitter-pane.component.ts +++ b/projects/igniteui-angular/splitter/src/splitter/splitter-pane/splitter-pane.component.ts @@ -142,7 +142,7 @@ export class IgxSplitterPaneComponent { /** * @hidden @internal - * Gets/Sets the `maxHeight` properties of the current `IgxSplitterPaneComponent`. + * Gets/Sets the `maxHeight` properties of the current splitter pane. */ @HostBinding('style.max-height') public maxHeight = '100%'; @@ -194,7 +194,7 @@ export class IgxSplitterPaneComponent { /** * @hidden @internal - * Gets the `flex` property of the current `IgxSplitterPaneComponent`. + * Gets the `flex` property of the current splitter pane. */ @HostBinding('style.flex') public get flex() { diff --git a/projects/igniteui-angular/splitter/src/splitter/splitter.component.ts b/projects/igniteui-angular/splitter/src/splitter/splitter.component.ts index 374ec9cfeeb..201928598ac 100644 --- a/projects/igniteui-angular/splitter/src/splitter/splitter.component.ts +++ b/projects/igniteui-angular/splitter/src/splitter/splitter.component.ts @@ -137,7 +137,7 @@ export class IgxSplitterComponent implements AfterContentInit { /** * @hidden @internal - * A field that holds the initial size of the main `IgxSplitterPaneComponent` in each pair of panes divided by a splitter bar. + * A field that holds the initial size of the main splitter pane in each pair of panes divided by a splitter bar. */ private initialPaneSize!: number; diff --git a/projects/igniteui-angular/stepper/src/stepper/step/step.component.ts b/projects/igniteui-angular/stepper/src/stepper/step/step.component.ts index a2c09f9f43d..c9a1d4e7e8c 100644 --- a/projects/igniteui-angular/stepper/src/stepper/step/step.component.ts +++ b/projects/igniteui-angular/stepper/src/stepper/step/step.component.ts @@ -12,7 +12,7 @@ import { ɵIgxDirectionality, PlatformUtil } from 'igniteui-angular/core'; let NEXT_ID = 0; /** - * The IgxStepComponent is used within the `igx-stepper` element and it holds the content of each step. + * The step is used within the `igx-stepper` element and it holds the content of each step. * It also supports custom indicators, title and subtitle. * * @igxModule IgxStepperModule diff --git a/projects/igniteui-angular/stepper/src/stepper/stepper.component.ts b/projects/igniteui-angular/stepper/src/stepper/stepper.component.ts index 3763ed54010..4539f3929dd 100644 --- a/projects/igniteui-angular/stepper/src/stepper/stepper.component.ts +++ b/projects/igniteui-angular/stepper/src/stepper/stepper.component.ts @@ -24,7 +24,7 @@ import { ToggleAnimationSettings } from 'igniteui-angular/expansion-panel'; // TODO: common interface between IgxCarouselComponentBase and ToggleAnimationPlayer? /** - * IgxStepper provides a wizard-like workflow by dividing content into logical steps. + * Stepper provides a wizard-like workflow by dividing content into logical steps. * * @igxModule IgxStepperModule * diff --git a/projects/igniteui-angular/time-picker/src/time-picker/time-picker.directives.ts b/projects/igniteui-angular/time-picker/src/time-picker/time-picker.directives.ts index a20bde24f79..8f6eb6010bf 100644 --- a/projects/igniteui-angular/time-picker/src/time-picker/time-picker.directives.ts +++ b/projects/igniteui-angular/time-picker/src/time-picker/time-picker.directives.ts @@ -1,5 +1,5 @@ /** - * This file contains all the directives used by the @link IgxTimePickerComponent. + * This file contains all the directives used by the @link time picker. * You should generally not use them directly. * * @preferred diff --git a/projects/igniteui-angular/tree/src/tree/common.ts b/projects/igniteui-angular/tree/src/tree/common.ts index d30fed3c1cf..f6e18b6687c 100644 --- a/projects/igniteui-angular/tree/src/tree/common.ts +++ b/projects/igniteui-angular/tree/src/tree/common.ts @@ -4,7 +4,7 @@ import { ToggleAnimationSettings } from 'igniteui-angular/expansion-panel'; // Component interfaces -/** Comparer function that can be used when searching through IgxTreeNode[] */ +/** Comparer function that can be used when searching through tree node[] */ export type IgxTreeSearchResolver = (data: any, node: IgxTreeNode) => boolean; export interface IgxTree { diff --git a/projects/igniteui-angular/tree/src/tree/tree.component.ts b/projects/igniteui-angular/tree/src/tree/tree.component.ts index d3f13fd9cdc..c8a9a32b3c8 100644 --- a/projects/igniteui-angular/tree/src/tree/tree.component.ts +++ b/projects/igniteui-angular/tree/src/tree/tree.component.ts @@ -38,7 +38,7 @@ export class IgxTreeExpandIndicatorDirective { } /** - * IgxTreeComponent allows a developer to show a set of nodes in a hierarchical fashion. + * Tree allows a developer to show a set of nodes in a hierarchical fashion. * * @igxModule IgxTreeModule * @igxKeywords tree @@ -93,7 +93,7 @@ export class IgxTreeComponent implements IgxTree, OnInit, AfterViewInit, OnDestr * * @remarks * By default the tree selection mode is 'None' - * @param selectionMode: IgxTreeSelectionType + * @param selectionMode: tree selection type */ @Input() public get selection() { @@ -366,7 +366,7 @@ export class IgxTreeComponent implements IgxTree, OnInit, AfterViewInit, OnDestr * ]; * this.tree.deselectAll(arr); * ``` - * @param nodes: IgxTreeNodeComponent[] + * @param nodes: tree node[] */ public deselectAll(nodes?: IgxTreeNodeComponent[]) { this.selectionService.deselectNodesWithNoEvent(nodes);