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

[DataGrid] Add api pages for data-grid and x-grid #289

Merged
merged 8 commits into from
Sep 16, 2020

Conversation

dtassone
Copy link
Member

No description provided.

@dtassone dtassone changed the title add api pages for datagrid and xgrid [DataGrid] add api pages for datagrid and xgrid Sep 16, 2020
@dtassone dtassone added the docs Improvements or additions to the documentation label Sep 16, 2020
@dtassone dtassone self-assigned this Sep 16, 2020
@oliviertassinari oliviertassinari changed the title [DataGrid] add api pages for datagrid and xgrid [DataGrid] Add api pages for datagrid and xgrid Sep 16, 2020
Copy link
Member

@oliviertassinari oliviertassinari left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great start!

We would need two new pages to have them rendered:

  • /docs/pages/api-docs/data-grid.js
  • /docs/pages/api-docs/x-grid.js

Also, the convention is to add a hyphen when we use an uppercase so:

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

See the link generated automatically:

Capture d’écran 2020-09-16 à 13 27 07


| Rule name | Global class | Description |
|:-----|:-------------|:------------|
| <span class="prop-name">root</span> | <span class="prop-name">.MuiDataGrid-root</span> | Styles applied to the root element.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does the classes prop work? It seems it doesn't.

Suggested change
| <span class="prop-name">root</span> | <span class="prop-name">.MuiDataGrid-root</span> | Styles applied to the root element.
| <span class="prop-name"></span> | <span class="prop-name">.MuiDataGrid-root</span> | Styles applied to the root element.

| Rule name | Global class | Description |
|:-----|:-------------|:------------|
| <span class="prop-name">root</span> | <span class="prop-name">.MuiDataGrid-root</span> | Styles applied to the root element.
| <span class="prop-name">root</span> | <span class="prop-name">.MuiDataGrid-mainGridContainer</span> | Styles applied to the main container element.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

root is not implemented here and for all the other keys.

Suggested change
| <span class="prop-name">root</span> | <span class="prop-name">.MuiDataGrid-mainGridContainer</span> | Styles applied to the main container element.
| <span class="prop-name"></span> | <span class="prop-name">.MuiDataGrid-mainGridContainer</span> | Styles applied to the main container element.

Actually, we could implement them with the context.

docs/pages/api-docs/xgrid.md Outdated Show resolved Hide resolved
docs/pages/api-docs/xgrid.md Outdated Show resolved Hide resolved
docs/pages/api-docs/datagrid.md Outdated Show resolved Hide resolved
docs/pages/api-docs/datagrid.md Outdated Show resolved Hide resolved
docs/pages/api-docs/datagrid.md Outdated Show resolved Hide resolved
docs/pages/api-docs/xgrid.md Outdated Show resolved Hide resolved
docs/pages/api-docs/datagrid.md Outdated Show resolved Hide resolved
@oliviertassinari oliviertassinari changed the title [DataGrid] Add api pages for datagrid and xgrid [DataGrid] Add api pages for data-grid and x-grid Sep 16, 2020
docs/pages/api-docs/data-grid.md Show resolved Hide resolved
docs/pages/api-docs/x-grid.md Show resolved Hide resolved
docs/src/pages.js Show resolved Hide resolved
@dtassone dtassone merged commit 185d13e into mui:master Sep 16, 2020
@oliviertassinari
Copy link
Member

I have taken note to fix the link underline in the header in the next batch of small changes for the docs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants