Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand All @@ -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
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -234,7 +234,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 {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,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;
Expand Down
Original file line number Diff line number Diff line change
@@ -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.
*
Expand Down
12 changes: 6 additions & 6 deletions projects/igniteui-angular/card/src/card/card.component.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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({
Expand Down Expand Up @@ -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',
Expand Down Expand Up @@ -80,7 +80,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({
Expand Down Expand Up @@ -117,7 +117,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
Expand All @@ -131,7 +131,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
Expand Down Expand Up @@ -266,7 +266,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',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -299,7 +299,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 components as event arguments.
* ```html
* <igx-carousel (slideChanged)="slideChanged($event)"></igx-carousel>
* ```
Expand All @@ -310,7 +310,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 components as event arguments.
* ```html
* <igx-carousel (slideAdded)="slideAdded($event)"></igx-carousel>
* ```
Expand All @@ -321,7 +321,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 components as event arguments.
* ```html
* <igx-carousel (slideRemoved)="slideRemoved($event)"></igx-carousel>
* ```
Expand All @@ -332,7 +332,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
* <igx-carousel (carouselPaused)="carouselPaused($event)"></igx-carousel>
* ```
Expand All @@ -343,7 +343,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
* <igx-carousel (carouselPlaying)="carouselPlaying($event)"></igx-carousel>
* ```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 a carousel.
*
* ```
* <igx-slide [input bindings] >
Expand Down
58 changes: 29 additions & 29 deletions projects/igniteui-angular/chips/src/chips/chip.component.ts
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,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
Expand Down Expand Up @@ -201,7 +201,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
Expand All @@ -225,7 +225,7 @@ export class IgxChipComponent implements OnInit, OnDestroy {
public removeIcon: TemplateRef<any>;

/**
* Defines if the `IgxChipComponent` can be selected on click or through navigation,
* Defines if the chip can be selected on click or through navigation,
* By default it is set to false.
*
* @example
Expand Down Expand Up @@ -256,7 +256,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.
*
Expand All @@ -270,7 +270,7 @@ export class IgxChipComponent implements OnInit, OnDestroy {
public disabled = false;

/**
* Sets the `IgxChipComponent` selected state.
* Sets the chip selected state.
*
* @example
* ```html
Expand All @@ -289,7 +289,7 @@ export class IgxChipComponent implements OnInit, OnDestroy {
}

/**
* Returns if the `IgxChipComponent` is selected.
* Returns if the chip is selected.
*
* @example
* ```typescript
Expand All @@ -312,7 +312,7 @@ export class IgxChipComponent implements OnInit, OnDestroy {
public selectedChange = new EventEmitter<boolean>();

/**
* Sets the `IgxChipComponent` background color.
* Sets the chip background color.
* The `color` property supports string, rgb, hex.
*
* @example
Expand All @@ -326,7 +326,7 @@ export class IgxChipComponent implements OnInit, OnDestroy {
}

/**
* Returns the background color of the `IgxChipComponent`.
* Returns the background color of the chip.
*
* @example
* ```typescript
Expand Down Expand Up @@ -358,8 +358,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
Expand All @@ -370,8 +370,8 @@ export class IgxChipComponent implements OnInit, OnDestroy {
public moveStart = new EventEmitter<IBaseChipEventArgs>();

/**
* Emits an event when the `IgxChipComponent` moving ends.
* Returns the moved `IgxChipComponent`.
* Emits an event when the chip moving ends.
* Returns the moved chip.
*
* @example
* ```html
Expand All @@ -382,8 +382,8 @@ export class IgxChipComponent implements OnInit, OnDestroy {
public moveEnd = new EventEmitter<IBaseChipEventArgs>();

/**
* Emits an event when the `IgxChipComponent` is removed.
* Returns the removed `IgxChipComponent`.
* Emits an event when the chip is removed.
* Returns the removed chip.
*
* @example
* ```html
Expand All @@ -394,8 +394,8 @@ export class IgxChipComponent implements OnInit, OnDestroy {
public remove = new EventEmitter<IBaseChipEventArgs>();

/**
* Emits an event when the `IgxChipComponent` is clicked.
* Returns the clicked `IgxChipComponent`, whether the event should be canceled.
* Emits an event when the chip is clicked.
* Returns the clicked chip, whether the event should be canceled.
*
* @example
* ```html
Expand All @@ -406,7 +406,7 @@ export class IgxChipComponent implements OnInit, OnDestroy {
public chipClick = new EventEmitter<IChipClickEventArgs>();

/**
* Emits event when the `IgxChipComponent` is selected/deselected.
* Emits event when the chip is selected/deselected.
* Returns the selected chip reference, whether the event should be canceled, what is the next selection state and
* when the event is triggered by interaction `originalEvent` is provided, otherwise `originalEvent` is `null`.
*
Expand All @@ -419,7 +419,7 @@ export class IgxChipComponent implements OnInit, OnDestroy {
public selectedChanging = new EventEmitter<IChipSelectEventArgs>();

/**
* Emits event when the `IgxChipComponent` is selected/deselected and any related animations and transitions also end.
* Emits event when the chip is selected/deselected and any related animations and transitions also end.
*
* @example
* ```html
Expand All @@ -430,8 +430,8 @@ export class IgxChipComponent implements OnInit, OnDestroy {
public selectedChanged = new EventEmitter<IBaseChipEventArgs>();

/**
* Emits an event when the `IgxChipComponent` keyboard navigation is being used.
* Returns the focused/selected `IgxChipComponent`, whether the event should be canceled,
* Emits an event when the chip keyboard navigation is being used.
* Returns the focused/selected chip, whether the event should be canceled,
* if the `alt`, `shift` or `control` key is pressed and the pressed key name.
*
* @example
Expand All @@ -443,8 +443,8 @@ export class IgxChipComponent implements OnInit, OnDestroy {
public keyDown = new EventEmitter<IChipKeyDownEventArgs>();

/**
* Emits an event when the `IgxChipComponent` has entered the `IgxChipsAreaComponent`.
* Returns the target `IgxChipComponent`, the drag `IgxChipComponent`, as well as
* Emits an event when the chip has entered the chips area.
* Returns the target chip, the drag chip, as well as
* the original drop event arguments.
*
* @example
Expand All @@ -456,8 +456,8 @@ export class IgxChipComponent implements OnInit, OnDestroy {
public dragEnter = new EventEmitter<IChipEnterDragAreaEventArgs>();

/**
* Emits an event when the `IgxChipComponent` has left the `IgxChipsAreaComponent`.
* Returns the target `IgxChipComponent`, the drag `IgxChipComponent`, as well as
* Emits an event when the chip has left the chips area.
* Returns the target chip, the drag chip, as well as
* the original drop event arguments.
*
* @example
Expand All @@ -469,8 +469,8 @@ export class IgxChipComponent implements OnInit, OnDestroy {
public dragLeave = new EventEmitter<IChipEnterDragAreaEventArgs>();

/**
* Emits an event when the `IgxChipComponent` is over the `IgxChipsAreaComponent`.
* Returns the target `IgxChipComponent`, the drag `IgxChipComponent`, as well as
* Emits an event when the chip is over the chips area.
* Returns the target chip, the drag chip, as well as
* the original drop event arguments.
*
* @example
Expand All @@ -482,8 +482,8 @@ export class IgxChipComponent implements OnInit, OnDestroy {
public dragOver = new EventEmitter<IChipEnterDragAreaEventArgs>();

/**
* Emits an event when the `IgxChipComponent` has been dropped in the `IgxChipsAreaComponent`.
* Returns the target `IgxChipComponent`, the drag `IgxChipComponent`, as well as
* Emits an event when the chip has been dropped in the chips area.
* Returns the target chip, the drag chip, as well as
* the original drop event arguments.
*
* @example
Expand Down Expand Up @@ -523,7 +523,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
Expand Down
Loading
Loading