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

[DataGrid] Remove legacy editing API #6016

Merged
merged 6 commits into from
Oct 7, 2022
Merged

Conversation

m4theushw
Copy link
Member

@m4theushw m4theushw commented Sep 2, 2022

Closes #5606

Preview: https://deploy-preview-6016--material-ui-x.netlify.app/x/react-data-grid/

Breaking change

  • [DataGrid] Remove legacy editing API

    The editing API that is enabled by default was replaced with a new API that contains better support for server-side persistence, validation and customization. This new editing feature was already available in v5 under the newEditingApi experimental flag. In v6, this flag can be removed.

     <DataGrid
    -  experimentalFeatures={{ newEditingApi: true }}
     />

    For users that didn't migrate to the new editing API in v5, additional work may be needed because the new API is not equivalent to the legacy API. Although, some migration steps are available to help in this task.

    • The editCellPropsChange event was removed. If you still need it please file a new issue so we can propose an alternative.
    • The cellEditCommit event was removed and the processRowUpdate prop can be used in place. More information, check the docs section about the topic.
    • The editRowsModel and onEditRowsModelChange props were removed. The cellModesModel or rowModesModel props can be used to achieve the same goal.
    • The following API methods were removed:
      • Use apiRef.current.stopCellEditMode to replace apiRef.current.commitCellChange
      • Use apiRef.current.startCellEditMode to replace apiRef.current.setCellMode(id, field, 'edit')
      • Use apiRef.current.stopRowEditMode to replace apiRef.current.commitRowChange
      • Use apiRef.current.startRowMode to replace apiRef.current.setRowMode(id, 'edit')
      • Use the cellModesModel or rowModesModel props to replace apiRef.current.setEditRowsModel

@m4theushw m4theushw added breaking change component: data grid This is the name of the generic UI component, not the React module! labels Sep 2, 2022
@mui-bot
Copy link

mui-bot commented Sep 2, 2022

These are the results for the performance tests:

Test case Unit Min Max Median Mean σ
Filter 100k rows ms 497.1 800.8 687 650.78 116.418
Sort 100k rows ms 567.6 1,065.3 875.3 856.04 160.754
Select 100k rows ms 211.8 287.4 273.8 264.38 27.987
Deselect 100k rows ms 124.8 214.3 200.6 180.44 34.366

Generated by 🚫 dangerJS against df0ce38

@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Sep 8, 2022
@github-actions
Copy link

github-actions bot commented Sep 8, 2022

This pull request has conflicts, please resolve those before we can evaluate the pull request.

@DanailH DanailH changed the base branch from master to next September 12, 2022 13:00
@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Sep 20, 2022
@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Sep 22, 2022
@github-actions
Copy link

This pull request has conflicts, please resolve those before we can evaluate the pull request.

@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Oct 4, 2022
@m4theushw m4theushw marked this pull request as ready for review October 5, 2022 00:21
@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Oct 5, 2022
@github-actions
Copy link

github-actions bot commented Oct 5, 2022

This pull request has conflicts, please resolve those before we can evaluate the pull request.

@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Oct 5, 2022
@github-actions
Copy link

github-actions bot commented Oct 6, 2022

This pull request has conflicts, please resolve those before we can evaluate the pull request.

@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Oct 6, 2022
@DanailH
Copy link
Member

DanailH commented Oct 6, 2022

@m4theushw I guess this solves that issue #5606

The question is does it also save the rest that is listed under the "Editing" section here #3287

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking change component: data grid This is the name of the generic UI component, not the React module!
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[data grid] Remove the editing experimental features and make them enabled by default
4 participants