Skip to content

Commit 9f8dd79

Browse files
authored
docs(grids): fixing typos on API comments (#14375)
1 parent 8e6ddd0 commit 9f8dd79

File tree

4 files changed

+80
-80
lines changed

4 files changed

+80
-80
lines changed

projects/igniteui-angular/src/lib/grids/common/events.ts

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ import { IBaseSearchInfo } from '../../directives/text-highlight/text-highlight.
1010

1111
/** The event arguments when data from a grid is being copied. */
1212
export interface IGridClipboardEvent {
13-
/** `data` can be of any type and referes to the data that is being copied/stored to the clipboard */
13+
/** `data` can be of any type and refers to the data that is being copied/stored to the clipboard */
1414
data: any[];
1515
/**
16-
* `cancel` returns whether an external event has interepted the copying
17-
* If the value becomes "true", it returns/exits from the method, instanciating the interface
16+
* `cancel` returns whether an external event has intercepted the copying
17+
* If the value becomes "true", it returns/exits from the method, instantiating the interface
1818
*/
1919
cancel: boolean;
2020
}
@@ -64,7 +64,7 @@ export interface IGridEditDoneEventArgs extends IBaseEventArgs {
6464
rowData: any;
6565
/**
6666
* Represents the previous (before editing) value of the edited cell.
67-
* It's used when the event has been stoped/exited.
67+
* It's used when the event has been stopped/exited.
6868
*/
6969
oldValue: any;
7070
/**
@@ -90,7 +90,7 @@ export interface IGridEditDoneEventArgs extends IBaseEventArgs {
9090
owner?: GridType;
9191
/**
9292
* Optional
93-
* Indicates if the editing cosists of adding a new row
93+
* Indicates if the editing consists of adding a new row
9494
*/
9595
isAddRow?: boolean;
9696
/**
@@ -148,7 +148,7 @@ export interface IPinColumnEventArgs extends IBaseEventArgs {
148148
insertAtIndex: number;
149149
/**
150150
* Returns the actual pin state of the column.
151-
* If pinning/unpinning is succesfull, value of `isPinned` will change accordingly when read in the "-ing" and "-ed" event.
151+
* If pinning/unpinning is successful, value of `isPinned` will change accordingly when read in the "-ing" and "-ed" event.
152152
*/
153153
isPinned: boolean;
154154
}
@@ -157,7 +157,7 @@ export interface IPinColumnEventArgs extends IBaseEventArgs {
157157
* The event arguments before a column's pin state is changed.
158158
* `insertAtIndex`specifies at which index in the pinned/unpinned area the column is inserted.
159159
* Can be changed in the `columnPin` event.
160-
* `isPinned` returns the actual pin state of the column. When pinning/unpinning is succesfull,
160+
* `isPinned` returns the actual pin state of the column. When pinning/unpinning is successful,
161161
* the value of `isPinned` will change accordingly when read in the "-ing" and "-ed" event.
162162
*/
163163
export interface IPinColumnCancellableEventArgs extends IPinColumnEventArgs, CancelableEventArgs {
@@ -187,7 +187,7 @@ export interface IRowDataEventArgs extends IBaseEventArgs {
187187

188188
/** The event arguments when a column is being resized */
189189
export interface IColumnResizeEventArgs extends IBaseEventArgs {
190-
/** Represents the informantion of the column that is being resized */
190+
/** Represents the information of the column that is being resized */
191191
column: ColumnType;
192192
/** Represents the old width of the column before the resizing */
193193
prevWidth: string;
@@ -233,7 +233,7 @@ export interface IRowSelectionEventArgs extends CancelableEventArgs, IBaseEventA
233233
}
234234

235235
/**
236-
* The event arguments when the selection state of a column is being chaged
236+
* The event arguments when the selection state of a column is being changed
237237
* The event is cancelable
238238
*/
239239
export interface IColumnSelectionEventArgs extends CancelableEventArgs, IBaseEventArgs {
@@ -285,8 +285,8 @@ export interface IGridToolbarExportEventArgs extends IBaseEventArgs {
285285
*/
286286
options: IgxExporterOptionsBase;
287287
/**
288-
* `cancel` returns whether the event has been interepted and stopped
289-
* If the value becomes "true", it returns/exits from the method, instanciating the interface
288+
* `cancel` returns whether the event has been intercepted and stopped
289+
* If the value becomes "true", it returns/exits from the method, instantiating the interface
290290
*/
291291
cancel: boolean;
292292
}
@@ -295,7 +295,7 @@ export interface IGridToolbarExportEventArgs extends IBaseEventArgs {
295295
export interface IColumnMovingStartEventArgs extends IBaseEventArgs {
296296
/**
297297
* Represents the column that is being moved.
298-
* The `ColumnType` contains the informatoin (the grid it belongs to, css data, settings, etc.) of the column in its properties
298+
* The `ColumnType` contains the information (the grid it belongs to, css data, settings, etc.) of the column in its properties
299299
*/
300300
source: ColumnType;
301301
}
@@ -304,12 +304,12 @@ export interface IColumnMovingStartEventArgs extends IBaseEventArgs {
304304
export interface IColumnMovingEventArgs extends IBaseEventArgs {
305305
/**
306306
* Represents the column that is being moved.
307-
* The `ColumnType` contains the informatoin (the grid it belongs to, css data, settings, etc.) of the column in its properties
307+
* The `ColumnType` contains the information (the grid it belongs to, css data, settings, etc.) of the column in its properties
308308
*/
309309
source: ColumnType;
310310
/**
311-
* `cancel` returns whether the event has been interepted and stopped
312-
* If the value becomes "true", it returns/exits from the method, instanciating the interface
311+
* `cancel` returns whether the event has been intercepted and stopped
312+
* If the value becomes "true", it returns/exits from the method, instantiating the interface
313313
*/
314314
cancel: boolean;
315315
}
@@ -318,17 +318,17 @@ export interface IColumnMovingEventArgs extends IBaseEventArgs {
318318
export interface IColumnMovingEndEventArgs extends IBaseEventArgs {
319319
/**
320320
* The source of the event represents the column that is being moved.
321-
* The `ColumnType` contains the informatoin (the grid it belongs to, css data, settings, etc.) of the column in its properties
321+
* The `ColumnType` contains the information (the grid it belongs to, css data, settings, etc.) of the column in its properties
322322
*/
323323
source: ColumnType;
324324
/**
325325
* The target of the event represents the column, the source is being moved to.
326-
* The `ColumnType` contains the informatoin (the grid it belongs to, css data, settings, etc.) of the column in its properties
326+
* The `ColumnType` contains the information (the grid it belongs to, css data, settings, etc.) of the column in its properties
327327
*/
328328
target: ColumnType;
329329
/**
330-
* `cancel` returns whether the event has been interepted and stopped
331-
* If the value becomes "true", it returns/exits from the method, instanciating the interface
330+
* `cancel` returns whether the event has been intercepted and stopped
331+
* If the value becomes "true", it returns/exits from the method, instantiating the interface
332332
*/
333333
cancel: boolean;
334334
}
@@ -342,12 +342,12 @@ export interface IGridKeydownEventArgs extends IBaseEventArgs {
342342
targetType: GridKeydownTargetType;
343343
/** Represents the information and details of the object itself */
344344
target: any;
345-
/** Represents the original event, that occured. */
345+
/** Represents the original event, that occurred. */
346346
event: Event;
347347
/**
348348
* The event is cancelable
349-
* `cancel` returns whether the event has been interepted and stopped
350-
* If the value becomes "true", it returns/exits from the method, instanciating the interface
349+
* `cancel` returns whether the event has been intercepted and stopped
350+
* If the value becomes "true", it returns/exits from the method, instantiating the interface
351351
*/
352352
cancel: boolean;
353353
}
@@ -357,7 +357,7 @@ export interface ICellPosition {
357357
/** It returns the position (index) of the row, the cell is in */
358358
rowIndex: number;
359359
/**
360-
* It returns the position (index) of the colunm, the cell is in
360+
* It returns the position (index) of the column, the cell is in
361361
* Counts only the visible (non hidden) columns
362362
*/
363363
visibleColumnIndex: number;
@@ -388,7 +388,7 @@ export interface IRowDragStartEventArgs extends CancelableEventArgs, IBaseEventA
388388
dragElement: HTMLElement;
389389
}
390390

391-
/** Рepresents event arguments related to the row's expansion state being changed in a grid */
391+
/** Represents event arguments related to the row's expansion state being changed in a grid */
392392
export interface IRowToggleEventArgs extends IBaseEventArgs {
393393
/**
394394
* Represents the ID of the row that emitted the event (which state is changed)
@@ -403,13 +403,13 @@ export interface IRowToggleEventArgs extends IBaseEventArgs {
403403
expanded: boolean;
404404
/**
405405
* Optional
406-
* Represents the original event, that has triggered the expantion/collapse
406+
* Represents the original event, that has triggered the expansion/collapse
407407
*/
408408
event?: Event;
409409
/**
410410
* The event is cancelable
411-
* `cancel` returns whether the event has been interepted and stopped
412-
* If the value becomes "true", it returns/exits from the method, instanciating the interface
411+
* `cancel` returns whether the event has been intercepted and stopped
412+
* If the value becomes "true", it returns/exits from the method, instantiating the interface
413413
*/
414414
cancel: boolean;
415415
}
@@ -456,7 +456,7 @@ export interface IColumnToggledEventArgs extends IBaseEventArgs {
456456
checked: boolean;
457457
}
458458

459-
/** Emmited when the active node is changed */
459+
/** Emitted when the active node is changed */
460460
export interface IActiveNodeChangeEventArgs extends IBaseEventArgs {
461461
/** Represents the row index of the active node */
462462
row: number;
@@ -488,7 +488,7 @@ export interface ISortingEventArgs extends IBaseEventArgs, CancelableEventArgs {
488488
sortingExpressions?: ISortingExpression | Array<ISortingExpression>;
489489
/**
490490
* Optional
491-
* Represents the gouping expressions applied to the grid.
491+
* Represents the grouping expressions applied to the grid.
492492
* It can be a single grouping expression or an array of them
493493
* The expression contains information like the sorting expression and criteria by which the elements will be grouped
494494
*/
@@ -512,7 +512,7 @@ export interface IColumnVisibilityChangedEventArgs extends IBaseEventArgs {
512512
/** Represents the column the event originated from */
513513
column: any;
514514
/**
515-
* The new hidden state that the column will have, if operation is succesfull.
515+
* The new hidden state that the column will have, if operation is successful.
516516
* Will be `true` when hiding and `false` when showing.
517517
*/
518518
newValue: boolean;

0 commit comments

Comments
 (0)