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

add doc structure and example #44

Merged
merged 42 commits into from
Jul 7, 2020
Merged

add doc structure and example #44

merged 42 commits into from
Jul 7, 2020

Conversation

dtassone
Copy link
Member

@dtassone dtassone commented Jul 1, 2020

No description provided.

packages/grid/x-grid/src/grid.tsx Outdated Show resolved Hide resolved
packages/storybook/src/docs/api.stories.mdx Outdated Show resolved Hide resolved
packages/storybook/src/docs/demos/columns.demo.tsx Outdated Show resolved Hide resolved
packages/storybook/src/docs/demos/columns.demo.tsx Outdated Show resolved Hide resolved
packages/storybook/src/docs/demos/columns.demo.tsx Outdated Show resolved Hide resolved
@oliviertassinari
Copy link
Member

oliviertassinari commented Jul 2, 2020

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?

@oliviertassinari
Copy link
Member

oliviertassinari commented Jul 2, 2020

I'm adding @mbrookes, I think that he can help with the wording of the documentation.

@oliviertassinari
Copy link
Member

oliviertassinari commented Jul 2, 2020

No configuration was found in your project. Please refer to https://circleci.com/docs/2.0/ to get started with your configuration.

We will need to rebase to get the CI running (that will tell to run prettier to format the markdown)

packages/storybook/src/docs/columns.stories.mdx Outdated Show resolved Hide resolved
packages/storybook/src/docs/columns.stories.mdx Outdated Show resolved Hide resolved
packages/storybook/src/docs/columns.stories.mdx Outdated Show resolved Hide resolved
```
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.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
- `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?

Copy link
Member Author

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...

packages/storybook/src/docs/columns.stories.mdx Outdated Show resolved Hide resolved
packages/storybook/src/docs/quick-start.stories.mdx Outdated Show resolved Hide resolved
packages/storybook/src/docs/quick-start.stories.mdx Outdated Show resolved Hide resolved
packages/storybook/src/docs/quick-start.stories.mdx Outdated Show resolved Hide resolved
packages/storybook/src/docs/quick-start.stories.mdx Outdated Show resolved Hide resolved
packages/storybook/src/docs/sorting.stories.mdx Outdated Show resolved Hide resolved
dtassone and others added 12 commits July 6, 2020 13:42
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>
@oliviertassinari
Copy link
Member

oliviertassinari commented Jul 6, 2020

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

@dtassone
Copy link
Member Author

dtassone commented Jul 7, 2020

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?

We will do it at a later stage if necessary.

@dtassone dtassone closed this Jul 7, 2020
@dtassone dtassone reopened this Jul 7, 2020
@dtassone dtassone merged commit 071759e into master Jul 7, 2020
@dtassone dtassone deleted the mdxDoc branch July 7, 2020 11:31
@oliviertassinari oliviertassinari 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 Jan 17, 2023
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.

3 participants