Skip to content
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.

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

[docs] Add description for all the data grid events #1527

Closed
1 task done
oliviertassinari opened this issue Apr 30, 2021 · 0 comments · Fixed by #1572
Closed
1 task done

[docs] Add description for all the data grid events #1527

oliviertassinari opened this issue Apr 30, 2021 · 0 comments · Fixed by #1572
Assignees
Labels
component: data grid This is the name of the generic UI component, not the React module! docs Improvements or additions to the documentation

Comments

@oliviertassinari
Copy link
Member

oliviertassinari commented Apr 30, 2021

  • I have searched the issues of this repository and believe that this is not a duplicate.

Summary 💡

Add description for all the events. It's currently far from clear when each event is supposed to fire.

Examples 🌈

https://developer.mozilla.org/en-US/docs/Web/API/Element#events

Screenshot 2021-04-30 at 15 32 46

I assume we could start with:

diff --git a/packages/grid/_modules_/grid/constants/eventsConstants.ts b/packages/grid/_modules_/grid/constants/eventsConstants.ts
index 74b08928..6d757731 100644
--- a/packages/grid/_modules_/grid/constants/eventsConstants.ts
+++ b/packages/grid/_modules_/grid/constants/eventsConstants.ts
@@ -27,7 +27,12 @@ export const GRID_CELL_VALUE_CHANGE = 'cellValueChange';

 export const GRID_CELL_EDIT_ENTER = 'cellEditEnter';
 export const GRID_CELL_EDIT_EXIT = 'cellEditExit';
+
+/**
+ * Fired when a keydown event has triggerd a focus navigation on the grid.
+ */
 export const GRID_CELL_NAVIGATION_KEYDOWN = 'cellNavigationKeyDown';
+
 export const GRID_CELL_FOCUS = 'cellCellFocus';
 export const GRID_CELL_DRAG_START = 'cellDragStart';
 export const GRID_CELL_DRAG_ENTER = 'cellDragEnter';

to get the description in TypeScript, and then #1213 for rendering the information on the documentation. This also a bit related to #1383.

Motivation 🔦

Remove confusion, and avoid the need to search deep in the codebase. #1515 (comment)

@oliviertassinari oliviertassinari added the docs Improvements or additions to the documentation label Apr 30, 2021
@oliviertassinari oliviertassinari added the component: data grid This is the name of the generic UI component, not the React module! label Apr 30, 2021
@oliviertassinari oliviertassinari changed the title [docs] Add description for all the events [docs] Add description for all the data grid events Apr 30, 2021
@m4theushw m4theushw self-assigned this May 6, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: data grid This is the name of the generic UI component, not the React module! docs Improvements or additions to the documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants