[docs] Add missing API docs #2167

ZeeshanTamboli · 2021-07-18T07:00:47Z

Part of #2146 to add doc of onCellFocusOut prop.

Also added some other props from GridOptions which were missing.

Preview:
XGrid: https://deploy-preview-2167--material-ui-x.netlify.app/api/data-grid/x-grid/
DataGrid: https://deploy-preview-2167--material-ui-x.netlify.app/api/data-grid/data-grid/

oliviertassinari

Thanks for the fixes. It's easy to have this docs outdated, the sooner we upgrade the docs infra to v5, so we can use the docs generator of the main repository, the better.

oliviertassinari · 2021-07-18T09:03:01Z

packages/grid/_modules_/grid/models/gridOptions.tsx

@@ -143,8 +143,8 @@ export interface GridOptions {
  editRowsModel?: GridEditRowsModel;
  /**
   * Filtering can be processed on the server or client-side.
-   * Set it to 'client' if you would like to handle filtering on the client-side.


This still seem relevant, why remove it?

The default is client, so I added @default. I removed it from here as I thought we need not explicitly set it to client because it is default.

In the core, these comments are used in boolean props. There, the default value goes to @default and the comment only mentions what the non-default value does.

I don't have any preference here, as long as we keep consistency: remove from all other feature mode props or keep this line.

In this case, we can move slower: only add the default mention, it's already an improvement.

I already have added the @default tag.

docs/pages/api-docs/data-grid/x-grid.md

oliviertassinari · 2021-07-18T09:04:42Z

docs/pages/api-docs/data-grid/data-grid.md

@@ -84,6 +89,7 @@ import { DataGrid } from '@material-ui/data-grid';
 | <span class="prop-name">onRowLeave</span> | <span class="prop-type">(param: GridRowParams, event: React.MouseEvent) => void</span> |   | Callback fired when a mouse leave event comes from a row container element. |
 | <span class="prop-name">onSelectionModelChange</span> | <span class="prop-type">(param: GridSelectionModelChangeParams) => void</span> |   | Callback fired when the selection state of one or multiple rows changes. |
 | <span class="prop-name">onSortModelChange</span> | <span class="prop-type">(param: GridSortModelParams) => void</span> |   | Callback fired when the sort model changes before a column is sorted. |
+| <span class="prop-name">onStateChange</span> | <span class="prop-type">(params: any) => void</span> |   | Callback fired when the state of the grid is updated. |


Private API

If it's private we should consider removing this prop. It's not used internally.

I see it being used here https://github.com/mui-org/material-ui-x/blob/e6bed6b36d362810e49af90e4c6271d3c41ba93c/packages/grid/_modules_/grid/hooks/features/core/useGridApi.ts#L38
Am I incorrect?

I was talking about the prop. We don't use it internally. XGrid's users could still get state updates by subscribing to GRID_STATE_CHANGE.

@m4theushw We have mentioned it in some of the issues. I think that we should consider it experimental at this point (not documented). It's unclear what problem it solves.

So based on this conversation there are 2 things:

Remove the doc and the prop both.

Only remove the doc.

What do we do?

In any case, I removed this API from docs.

docs/pages/api-docs/data-grid/data-grid.md

m4theushw · 2021-07-19T20:08:01Z

docs/pages/api-docs/data-grid/data-grid.md

@@ -84,6 +89,7 @@ import { DataGrid } from '@material-ui/data-grid';
 | <span class="prop-name">onRowLeave</span> | <span class="prop-type">(param: GridRowParams, event: React.MouseEvent) => void</span> |   | Callback fired when a mouse leave event comes from a row container element. |
 | <span class="prop-name">onSelectionModelChange</span> | <span class="prop-type">(param: GridSelectionModelChangeParams) => void</span> |   | Callback fired when the selection state of one or multiple rows changes. |
 | <span class="prop-name">onSortModelChange</span> | <span class="prop-type">(param: GridSortModelParams) => void</span> |   | Callback fired when the sort model changes before a column is sorted. |
+| <span class="prop-name">onStateChange</span> | <span class="prop-type">(params: any) => void</span> |   | Callback fired when the state of the grid is updated. |


If it's private we should consider removing this prop. It's not used internally.

m4theushw · 2021-07-19T20:15:00Z

packages/grid/_modules_/grid/models/gridOptions.tsx

@@ -143,8 +143,8 @@ export interface GridOptions {
  editRowsModel?: GridEditRowsModel;
  /**
   * Filtering can be processed on the server or client-side.
-   * Set it to 'client' if you would like to handle filtering on the client-side.


In the core, these comments are used in boolean props. There, the default value goes to @default and the comment only mentions what the non-default value does.

I don't have any preference here, as long as we keep consistency: remove from all other feature mode props or keep this line.

ZeeshanTamboli · 2021-07-22T13:05:28Z

I have also updated the onSelectionModelChange API doc in commit 63432bd

ZeeshanTamboli · 2021-07-22T13:13:16Z

I am a bit confused here that the https://material-ui.com/api/data-grid/data-grid/ is still showing (param: GridSortModelParams) => void for onSortModelChange.

While on master HEAD it has been updated: https://github.com/mui-org/material-ui-x/blob/master/docs/pages/api-docs/data-grid/data-grid.md.

Did we release the docs?

m4theushw

Good work. 👍

m4theushw · 2021-07-22T22:50:23Z

Did we release the docs?

We had a problem during the deploy. Now it's updated.

ZeeshanTamboli added 3 commits July 18, 2021 11:54

add some missing grid options in docs

e8d79de

add missing onCell handlers in docs

ca27c27

add onStateChange doc

e0bf08e

ZeeshanTamboli added docs Improvements or additions to the documentation component: data grid This is the name of the generic UI component, not the React module! labels Jul 18, 2021

ZeeshanTamboli requested a review from a team July 18, 2021 07:22

oliviertassinari reviewed Jul 18, 2021

View reviewed changes

oliviertassinari requested a review from a team July 18, 2021 09:11

m4theushw reviewed Jul 19, 2021

View reviewed changes

ZeeshanTamboli added 4 commits July 20, 2021 06:16

add single quotes

46aceef

escape pipe in markdown

6242432

merge master branch and resolve conflicts

78502dd

update prop arguments of onSelectionModelChange API in docs

63432bd

ZeeshanTamboli requested review from oliviertassinari and m4theushw July 22, 2021 13:18

flaviendelangle mentioned this pull request Jul 22, 2021

[typescript] Improve type coverage of colDef #2188

Merged

m4theushw approved these changes Jul 22, 2021

View reviewed changes

oliviertassinari removed their request for review July 22, 2021 22:37

m4theushw merged commit a1d05f2 into mui:master Jul 22, 2021

ZeeshanTamboli deleted the add-missing-docs branch July 23, 2021 03:09

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[docs] Add missing API docs #2167

[docs] Add missing API docs #2167

ZeeshanTamboli commented Jul 18, 2021 •

edited

Loading

oliviertassinari left a comment

oliviertassinari Jul 18, 2021

ZeeshanTamboli Jul 18, 2021 •

edited

Loading

m4theushw Jul 19, 2021

oliviertassinari Jul 20, 2021

ZeeshanTamboli Jul 22, 2021

oliviertassinari Jul 18, 2021

m4theushw Jul 19, 2021 •

edited

Loading

ZeeshanTamboli Jul 20, 2021 •

edited

Loading

m4theushw Jul 20, 2021

oliviertassinari Jul 20, 2021 •

edited

Loading

ZeeshanTamboli Jul 22, 2021

ZeeshanTamboli Jul 22, 2021

m4theushw Jul 19, 2021 •

edited

Loading

m4theushw Jul 19, 2021

ZeeshanTamboli commented Jul 22, 2021

ZeeshanTamboli commented Jul 22, 2021

m4theushw left a comment

m4theushw commented Jul 22, 2021

[docs] Add missing API docs #2167

[docs] Add missing API docs #2167

Conversation

ZeeshanTamboli commented Jul 18, 2021 • edited Loading

oliviertassinari left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ZeeshanTamboli Jul 18, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

m4theushw Jul 19, 2021 • edited Loading

Choose a reason for hiding this comment

ZeeshanTamboli Jul 20, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

oliviertassinari Jul 20, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

m4theushw Jul 19, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ZeeshanTamboli commented Jul 22, 2021

ZeeshanTamboli commented Jul 22, 2021

m4theushw left a comment

Choose a reason for hiding this comment

m4theushw commented Jul 22, 2021

ZeeshanTamboli commented Jul 18, 2021 •

edited

Loading

ZeeshanTamboli Jul 18, 2021 •

edited

Loading

m4theushw Jul 19, 2021 •

edited

Loading

ZeeshanTamboli Jul 20, 2021 •

edited

Loading

oliviertassinari Jul 20, 2021 •

edited

Loading

m4theushw Jul 19, 2021 •

edited

Loading