[docs] Improve GridApi descriptions
#1767
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
packages/grid/_modules_/grid/models/api/gridVirtualizationApi.ts
Outdated
Show resolved
Hide resolved
packages/grid/_modules_/grid/models/api/gridPreferencesPanelApi.ts
Outdated
Show resolved
Hide resolved
m4theushw
commented
May 25, 2021
| */ | ||
| getEditCellValueParams: (rowId: GridRowId, field: string) => GridEditCellValueParams; | ||
| /** | ||
| * Commit the cell value changes to update the cell value. | ||
| * @param update | ||
| * @ignore - do not document | ||
| */ | ||
| commitCellChange: (params: GridEditCellPropsParams) => void; |
There was a problem hiding this comment.
I don't see a rationale to expose this method in the API. Although used in this demo, the same thing can be done with apiRef.current.setCellValue.
There was a problem hiding this comment.
@m4theushw From what I understand of the initial terminology: "commit" value means that the value is stored and will be taken part of the ctrl + z, ctrl + alt + z history feature. "set" value means that the value is only locally updated without updating the underlying rows. I would personally do the opposite, kill setCellValue.
There was a problem hiding this comment.
If there would be a history feature then makes sense to have the "commit". I added the ignore to setCellValue for now.
Co-authored-by: Olivier Tassinari <[email protected]>
dtassone
approved these changes
May 26, 2021
7 tasks
oliviertassinari
changed the title
GridApi descriptionsGridApi descriptions
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.
Breaking changes
[XGrid] The
getEditCellValueParamsmethod was removed from theapiRef([docs] ImproveGridApidescriptions #1767) @m4theushwThe method was almost a straightforward alias of
getEditCellPropsParams.Fixes #1705
Also adds missing prefixes, like #1705 (comment).