[docs] Migrate sorting #233
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| @@ -170,22 +164,22 @@ export const useSorting = ( | |||
| order.push(row.id); | |||
| return order; | |||
| }, [] as RowId[]); | |||
| }, [originalOrder, apiRef]); | |||
There was a problem hiding this comment.
Better not include the ref in the list of the dependencies. It's not needed and simpler without.
oliviertassinari
force-pushed
the
docs-data-grid-v7
branch
from
26a4ad9
to
c9ea4ed
Compare
oliviertassinari
force-pushed
the
docs-data-grid-v7
branch
from
c9ea4ed
to
cde884d
Compare
mbrookes
requested changes
Aug 29, 2020
|
|
||
| ### Key assignment conventions | ||
|
|
||
| The above key assignments are defined in the context of Windows and Linux. |
There was a problem hiding this comment.
Suggested change
| The above key assignments are defined in the context of Windows and Linux. | |
| The above key assignments are for Windows and Linux. |
| @@ -50,10 +50,22 @@ Finally, you need to handle the `onPageChange` callback to load the rows for the | |||
|
|
|||
| ## apiRef | |||
|
|
|||
| We exposed a set of methods that will let you achieve all the above features using the imperative apiRef. | |||
| The Grid exposes a set of methods that will let you achieve all the above features using the imperative apiRef. | |||
There was a problem hiding this comment.
Suggested change
| The Grid exposes a set of methods that will let you achieve all the above features using the imperative apiRef. | |
| The Grid exposes a set of methods that enables all of these features using the imperative apiRef. |
|
|
||
| > ⚠️ Only use this API when you have no alternatives. Always start from the declarative APIs the Grid exposes. | ||
| > ⚠️ Only use this API when you have no alternatives. Always start from the declarative API the Grid exposes. |
There was a problem hiding this comment.
Suggested change
| > ⚠️ Only use this API when you have no alternatives. Always start from the declarative API the Grid exposes. | |
| > ⚠️ Only use this API when you have no alternative. Always start from the declarative API that the Grid exposes. |
| - `setPageSize` | ||
| - `setPage` | ||
| - `onPageChange` | ||
| - `onPageSizeChange` | ||
|
|
||
| Below is an example on how you can reset the page using the imperative `setPage` method. |
There was a problem hiding this comment.
Suggested change
| Below is an example on how you can reset the page using the imperative `setPage` method. | |
| This example shows how you can reset the page using the imperative `setPage` method. |
|
|
||
| Below is an example on how you can reset the page using the imperative `setPage` method. | ||
|
|
||
| {{"demo": "pages/components/data-grid/pagination/ApiRefPaginationGrid.js"}} | ||
|
|
||
| ## Paginate > 100 rows ✨ |
There was a problem hiding this comment.
Suggested change
| ## Paginate > 100 rows ✨ | |
| ## Paginate > 100 rows ✨ |
"✨" = "new feature". If this is meant to indicate a premium feature, it needs a more appropriate icon. (See suggestions elsewhere).
There was a problem hiding this comment.
mean to indicate premium, happy to use a different one, for now, the objective is to have at least one.
|
|
||
| ### Disable sorting | ||
|
|
||
| By default, columns are all sortable and it can be revoked using the sortable prop of the `ColDef` interface as below. |
There was a problem hiding this comment.
Suggested change
| By default, columns are all sortable and it can be revoked using the sortable prop of the `ColDef` interface as below. | |
| By default, all columns are sortable. This can be revoked using the sortable prop of the `ColDef` interface: |
|
|
||
| ### Server-side sorting | ||
|
|
||
| By default, sorting works on the client-side. |
There was a problem hiding this comment.
Suggested change
| By default, sorting works on the client-side. | |
| By default, sorting works client-side. |
|
|
||
| By default, sorting works on the client-side. | ||
| To switch it to server-side, set `sortingMode="server"`. | ||
| Then, you need to handle the `onSortModelChange` callback, sort the rows on the server-side and update the `rows` prop with the new sorted rows. |
There was a problem hiding this comment.
Suggested change
| Then, you need to handle the `onSortModelChange` callback, sort the rows on the server-side and update the `rows` prop with the new sorted rows. | |
| Then you need to handle the `onSortModelChange` callback, sort the rows on the server-side, and update the `rows` prop with the newly sorted rows. |
|
|
||
| ### apiRef | ||
|
|
||
| The Grid exposes a set of methods that will let you achieve all the above features using the imperative apiRef. |
There was a problem hiding this comment.
Suggested change
| The Grid exposes a set of methods that will let you achieve all the above features using the imperative apiRef. | |
| The Grid exposes a set of methods that supports all of the above features using the imperative apiRef. |
|
|
||
| The Grid exposes a set of methods that will let you achieve all the above features using the imperative apiRef. | ||
|
|
||
| > ⚠️ Only use this API when you have no alternatives. Always start from the declarative API the Grid exposes. |
There was a problem hiding this comment.
Suggested change
| > ⚠️ Only use this API when you have no alternatives. Always start from the declarative API the Grid exposes. | |
| > ⚠️ Only use this API when you have no alternative. Always start from the declarative API that the Grid exposes. |
|
@mbrookes Great, I will handle the review. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.