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] Describe how to export custom rendered cells #2194

Merged
merged 3 commits into from Jul 26, 2021

Conversation

m4theushw
Copy link
Member

@m4theushw m4theushw commented Jul 22, 2021

@m4theushw m4theushw added component: data grid This is the name of the generic UI component, not the React module! docs Improvements or additions to the documentation labels Jul 22, 2021
@m4theushw m4theushw merged commit 0a394bc into mui:master Jul 26, 2021
@m4theushw m4theushw deleted the docs-export-custom-cells branch July 26, 2021 17:34

{{"demo": "pages/components/data-grid/export/ExportSelectorGrid.js", "bg": "inline"}}

Alternatively, you can export data using the imperative API available in XGrid:
Copy link
Member

Choose a reason for hiding this comment

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

A detail. I wonder if we shouldn't prefix these sections with the apiRef header and the pro icon. I wonder because we might be able to:

  • avoid frustration for developers using the DataGrid, reading this section only to later realize it's a paid feature.
  • create some convention, for instance, we could later use it to identify where we should like the section about how to use the apiRef.

Copy link
Member Author

Choose a reason for hiding this comment

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

If we add the apiRef header in each export output (CSV, Excel, print) we can't have specific links to them, unless we name the sections as "CSV - apiRef". Another alternative would be to have only one "apiRef" at the bottom of the page with the consolidated methods from all outputs, but we don't have a interface that groups them.

Copy link
Member

Choose a reason for hiding this comment

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

we can't have specific links to them

The docs uses a increment #api-ref, #api-ref-2, etc. It works but it's not very resilient to changes.

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 this pull request may close these issues.

[docs] Explain that valueFormatter can be used in the CSV export
5 participants