Skip to content

docs: improve grid JSDoc, add missing fires annotations (#10206) (CP: 24.9) #10207

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 22, 2025
Merged

docs: improve grid JSDoc, add missing fires annotations (#10206) (CP: 24.9) #10207

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion packages/grid/src/vaadin-grid-selection-column-base-mixin.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ export declare class GridSelectionColumnBaseMixinClass<TItem> {
selectAll: boolean;

/**
* When true, the active gets automatically selected.
* When true, the active item gets automatically selected.
* @attr {boolean} auto-select
*/
autoSelect: boolean;
Expand Down
2 changes: 1 addition & 1 deletion packages/grid/src/vaadin-grid-selection-column-base-mixin.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ export const GridSelectionColumnBaseMixin = (superClass) =>
},

/**
* When true, the active gets automatically selected.
* When true, the active item gets automatically selected.
* @attr {boolean} auto-select
* @type {boolean}
*/
Expand Down
2 changes: 2 additions & 0 deletions packages/grid/src/vaadin-grid-selection-column.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@ export * from './vaadin-grid-selection-column-mixin.js';
* selection for all the items at once.
*
* __The default content can also be overridden__
*
* @fires {CustomEvent} select-all-changed - Fired when the `selectAll` property changes.
*/
declare class GridSelectionColumn<TItem = GridDefaultItem> extends HTMLElement {}

Expand Down
3 changes: 2 additions & 1 deletion packages/grid/src/vaadin-grid-selection-column.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,9 @@ import { GridSelectionColumnMixin } from './vaadin-grid-selection-column-mixin.j
*
* __The default content can also be overridden__
*
* @customElement
* @fires {CustomEvent} select-all-changed - Fired when the `selectAll` property changes.
*
* @customElement
* @extends GridColumn
* @mixes GridSelectionColumnMixin
*/
Expand Down
2 changes: 2 additions & 0 deletions packages/grid/src/vaadin-grid-sort-column.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ export * from './vaadin-grid-sort-column-mixin.js';
* <vaadin-grid-column>
* ...
* ```
*
* @fires {CustomEvent} direction-changed - Fired when the `direction` property changes.
*/
declare class GridSortColumn<TItem = GridDefaultItem> extends HTMLElement {}

Expand Down
1 change: 1 addition & 0 deletions packages/grid/src/vaadin-grid.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -256,6 +256,7 @@ registerStyles('vaadin-grid', gridStyles, { moduleId: 'vaadin-grid-styles' });
* @fires {CustomEvent} loading-changed - Fired when the `loading` property changes.
* @fires {CustomEvent} selected-items-changed - Fired when the `selectedItems` property changes.
* @fires {CustomEvent} size-changed - Fired when the `size` property changes.
* @fires {CustomEvent} item-toggle - Fired when the user selects or deselects an item through the selection column.
*
* @customElement
* @extends HTMLElement
Expand Down