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] Migrate Selection pages #248

Merged
merged 3 commits into from
Sep 6, 2020

Conversation

oliviertassinari
Copy link
Member

@oliviertassinari oliviertassinari commented Sep 5, 2020

@oliviertassinari oliviertassinari added the docs Improvements or additions to the documentation label Sep 5, 2020
@oliviertassinari oliviertassinari force-pushed the docs-data-grid-v9 branch 2 times, most recently from decbd26 to 2572b9f Compare September 5, 2020 23:50
docs/src/pages/components/data-grid/rows/rows.md Outdated Show resolved Hide resolved
docs/src/pages/components/data-grid/rows/rows.md Outdated Show resolved Hide resolved
docs/src/pages/components/data-grid/rows/rows.md Outdated Show resolved Hide resolved
packages/grid/x-grid-modules/src/models/gridOptions.tsx Outdated Show resolved Hide resolved
packages/grid/x-grid-modules/src/models/gridOptions.tsx Outdated Show resolved Hide resolved
packages/grid/x-grid-modules/src/models/gridOptions.tsx Outdated Show resolved Hide resolved
packages/grid/x-grid-modules/src/models/gridOptions.tsx Outdated Show resolved Hide resolved
packages/grid/x-grid-modules/src/models/gridOptions.tsx Outdated Show resolved Hide resolved
oliviertassinari and others added 2 commits September 6, 2020 19:25
Co-authored-by: Matt <github@nospam.33m.co>
@oliviertassinari oliviertassinari changed the title [docs] Migrate more pages [docs] Migrate Selection pages Sep 6, 2020
@oliviertassinari oliviertassinari merged commit f4066ac into mui:master Sep 6, 2020
@oliviertassinari oliviertassinari deleted the docs-data-grid-v9 branch September 6, 2020 17:38
- `onSortModelChange`: Callback fired when the columns sorting changed before the grid has sorted its rows.
- `getSortModel`: Get the sort model currently applied to the grid.
- `setSortModel`: Set the sort model and trigger the sorting of rows.
- `onSortModelChange`: Callback fired when the column sorting changed before the grid has sorted its rows.
Copy link
Member

Choose a reason for hiding this comment

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

"before the grid has sorted its rows"

Is this referring to row sort order, or column sort order within rows?

Copy link
Member Author

@oliviertassinari oliviertassinari Sep 6, 2020

Choose a reason for hiding this comment

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

What's the difference?

I think that we should remove the reference to this. There is one state, it controls how the header communicate to the users the sort order and how the rows are sorted. This state is displayed to the user in a best effort way. Sorting the rows can take a bit of time.

Suggested change
- `onSortModelChange`: Callback fired when the column sorting changed before the grid has sorted its rows.
- `onSortModelChange`: Callback fired when the column sorting changes.

Copy link
Member

Choose a reason for hiding this comment

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

What's the difference?

One is rows, the other is columns, so quite a significant difference!

Copy link
Member Author

@oliviertassinari oliviertassinari Sep 6, 2020

Choose a reason for hiding this comment

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

I'm confused, both should always be in the same state (more or less the time it takes to propagate, raf, xhr, etc), no?

Copy link
Member

Choose a reason for hiding this comment

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

The description is ambiguous, but if the prop is being removed, it doesn't matter.

Copy link
Member Author

@oliviertassinari oliviertassinari Sep 7, 2020

Choose a reason for hiding this comment

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

I don't think that we should remove this apiRef, it's equivalent to the prop, that are required for controlling the "sort by" state.

* @param param With all properties from [[RowParams]].
*/
onRowHover?: (param: RowParams) => void;
/**
* Callback fired when one row get selected.
* Callback fired when one row is selected.
Copy link
Member

Choose a reason for hiding this comment

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

One, and only one row?

Copy link
Member Author

Choose a reason for hiding this comment

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

I propose we remove this prop in #247

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.

2 participants