Skip to content

Commit 5f8e5b5

Browse files
authored
docs: improve grid JSDoc, add missing fires annotations (#10206)
1 parent 747f82c commit 5f8e5b5

6 files changed

+9
-3
lines changed

packages/grid/src/vaadin-grid-selection-column-base-mixin.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export declare class GridSelectionColumnBaseMixinClass<TItem> {
2828
selectAll: boolean;
2929

3030
/**
31-
* When true, the active gets automatically selected.
31+
* When true, the active item gets automatically selected.
3232
* @attr {boolean} auto-select
3333
*/
3434
autoSelect: boolean;

packages/grid/src/vaadin-grid-selection-column-base-mixin.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ export const GridSelectionColumnBaseMixin = (superClass) =>
6363
},
6464

6565
/**
66-
* When true, the active gets automatically selected.
66+
* When true, the active item gets automatically selected.
6767
* @attr {boolean} auto-select
6868
* @type {boolean}
6969
*/

packages/grid/src/vaadin-grid-selection-column.d.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,8 @@ export * from './vaadin-grid-selection-column-mixin.js';
3434
* selection for all the items at once.
3535
*
3636
* __The default content can also be overridden__
37+
*
38+
* @fires {CustomEvent} select-all-changed - Fired when the `selectAll` property changes.
3739
*/
3840
declare class GridSelectionColumn<TItem = GridDefaultItem> extends HTMLElement {}
3941

packages/grid/src/vaadin-grid-selection-column.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,9 @@ import { GridSelectionColumnMixin } from './vaadin-grid-selection-column-mixin.j
3030
*
3131
* __The default content can also be overridden__
3232
*
33-
* @customElement
3433
* @fires {CustomEvent} select-all-changed - Fired when the `selectAll` property changes.
34+
*
35+
* @customElement
3536
* @extends GridColumn
3637
* @mixes GridSelectionColumnMixin
3738
*/

packages/grid/src/vaadin-grid-sort-column.d.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ export * from './vaadin-grid-sort-column-mixin.js';
2121
* <vaadin-grid-column>
2222
* ...
2323
* ```
24+
*
25+
* @fires {CustomEvent} direction-changed - Fired when the `direction` property changes.
2426
*/
2527
declare class GridSortColumn<TItem = GridDefaultItem> extends HTMLElement {}
2628

packages/grid/src/vaadin-grid.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -257,6 +257,7 @@ import { GridMixin } from './vaadin-grid-mixin.js';
257257
* @fires {CustomEvent} loading-changed - Fired when the `loading` property changes.
258258
* @fires {CustomEvent} selected-items-changed - Fired when the `selectedItems` property changes.
259259
* @fires {CustomEvent} size-changed - Fired when the `size` property changes.
260+
* @fires {CustomEvent} item-toggle - Fired when the user selects or deselects an item through the selection column.
260261
*
261262
* @customElement
262263
* @extends HTMLElement

0 commit comments

Comments
 (0)