-
-
Notifications
You must be signed in to change notification settings - Fork 1.4k
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
add doc structure and example #44
Conversation
A thought, considering we will only document the components at http://material-ui.com/components/data-grid/, shouldn't we rebase this pull request to https://github.com/mui-org/material-ui? |
I'm adding @mbrookes, I think that he can help with the wording of the documentation. |
We will need to rebase to get the CI running (that will tell to run prettier to format the markdown) |
``` | ||
In the code above we define a column with some of the basic attributes. | ||
- `field` is a mandatory field and is used to identify the corresponding value on rows. It's similar to an id, but has to be a string. | ||
- `headerName` is the title visible in the grid column header. If not set, `field` will be used in the header. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- `headerName` is the title visible in the grid column header. If not set, `field` will be used in the header. | |
- `headerName` is the title visible in the grid column header. If not set, `field` will be used in the header. |
If it's a title, should it be headerTitle
instead?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe or just Title
(remind me of tooltip title) ?
I put the same prop as AgGrid to be backward compatible, and easily try MUI grid where agGrid is already implemented 🤔
Not sure how realisable that will stand...
Co-authored-by: Olivier Tassinari <olivier.tassinari@gmail.com>
Rewording Co-authored-by: Matt <github@nospam.33m.co>
Co-authored-by: Matt <github@nospam.33m.co>
Co-authored-by: Matt <github@nospam.33m.co>
Co-authored-by: Matt <github@nospam.33m.co>
Co-authored-by: Matt <github@nospam.33m.co>
Co-authored-by: Matt <github@nospam.33m.co>
Co-authored-by: Matt <github@nospam.33m.co>
Co-authored-by: Matt <github@nospam.33m.co>
Co-authored-by: Matt <github@nospam.33m.co>
Co-authored-by: Matt <github@nospam.33m.co>
A thought, to make debugging the code sandbox issue easier, it could be simpler to jump right now in https://codesandbox.io/docs/ci. It could allow you to test the changes with a faster feedback loop |
We will do it at a later stage if necessary. |
No description provided.