Skip to content

add doc structure and example#44

Merged
dtassone merged 42 commits into
masterfrom
mdxDoc
Jul 7, 2020
Merged

add doc structure and example#44
dtassone merged 42 commits into
masterfrom
mdxDoc

Conversation

@dtassone

@dtassone dtassone commented Jul 1, 2020

Copy link
Copy Markdown
Contributor

No description provided.

Comment thread packages/grid/x-grid/src/grid.tsx Outdated
Comment thread packages/storybook/src/docs/api.stories.mdx Outdated
Comment thread packages/storybook/src/docs/demos/columns.demo.tsx Outdated
Comment thread packages/storybook/src/docs/demos/columns.demo.tsx Outdated
Comment thread packages/storybook/src/docs/demos/columns.demo.tsx Outdated
Comment thread packages/storybook/src/docs/quick-start.stories.mdx
@oliviertassinari

oliviertassinari commented Jul 2, 2020

Copy link
Copy Markdown
Member

Comment thread packages/storybook/src/docs/columns.stories.mdx Outdated
@oliviertassinari

oliviertassinari commented Jul 2, 2020

Copy link
Copy Markdown
Member

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

Comment thread packages/storybook/src/docs/demos/columns.demo.tsx Outdated
@oliviertassinari

oliviertassinari commented Jul 2, 2020

Copy link
Copy Markdown
Member

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)

Comment thread packages/storybook/src/docs/columns.stories.mdx Outdated
Comment thread packages/storybook/src/docs/columns.stories.mdx Outdated
Comment thread packages/storybook/src/docs/columns.stories.mdx Outdated
Comment thread packages/storybook/src/docs/columns.stories.mdx Outdated
```
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
Copy Markdown
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
Copy Markdown
Contributor 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...

Comment thread packages/storybook/src/docs/columns.stories.mdx Outdated
Comment thread packages/storybook/src/docs/quick-start.stories.mdx Outdated
Comment thread packages/storybook/src/docs/quick-start.stories.mdx Outdated
Comment thread packages/storybook/src/docs/quick-start.stories.mdx Outdated
Comment thread packages/storybook/src/docs/quick-start.stories.mdx Outdated
Comment thread packages/storybook/src/docs/sorting.stories.mdx Outdated
Comment thread packages/demo-app/src/app/app-bar.tsx Outdated
@oliviertassinari

oliviertassinari commented Jul 6, 2020

Copy link
Copy Markdown
Member

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

Comment thread packages/grid/x-grid-modules/src/components/row-cells.tsx
Comment thread packages/grid/x-grid/package.json
@dtassone

dtassone commented Jul 7, 2020

Copy link
Copy Markdown
Contributor Author

@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. scope: data grid Changes related to the data grid. labels Jan 17, 2023
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. scope: data grid Changes related to the data grid.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants