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

Documentation: Datatable: onRowEditChange Description is incorrect #5388

Closed
gcko opened this issue Nov 24, 2023 · 0 comments · Fixed by #5389
Closed

Documentation: Datatable: onRowEditChange Description is incorrect #5388

gcko opened this issue Nov 24, 2023 · 0 comments · Fixed by #5389
Assignees
Labels
Typescript Issue or pull request is *only* related to TypeScript definition
Milestone

Comments

@gcko
Copy link
Contributor

gcko commented Nov 24, 2023

Describe the bug

The description for onRowEditChange is a duplicate of the description for onRowEditCancel and does not correctly describe onRowEditChange

/**
* Callback to invoke when the cancel icon is clicked on row editing mode.
* @param {DataTableRowEditEvent} event - Custom row edit event.
*/
onRowEditCancel?(event: DataTableRowEditEvent): void;
/**
* Callback to invoke when the cancel icon is clicked on row editing mode.
* @param {DataTableRowEditEvent} event - Custom row edit event.
*/
onRowEditChange?(event: DataTableRowEditEvent): void;

Reproducer

onEditChange(e, false);

PrimeReact version

10.1.1

React version

18.x

Language

TypeScript

Build / Runtime

Next.js

Browser(s)

No response

Steps to reproduce the behavior

  1. Navigate to the this link
  2. Note that the description for onRowEditCancel is incorrect

Expected behavior

The description should say something like the following:

Callback to invoke when any change (edit start, edit cancel, edit save) is made to a row. This event fires after any preceding event.

Related PR

#5389

@gcko gcko added the Status: Needs Triage Issue will be reviewed by Core Team and a relevant label will be added as soon as possible label Nov 24, 2023
@melloware melloware added Typescript Issue or pull request is *only* related to TypeScript definition and removed Status: Needs Triage Issue will be reviewed by Core Team and a relevant label will be added as soon as possible labels Nov 24, 2023
@melloware melloware added this to the 10.2.0 milestone Nov 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Typescript Issue or pull request is *only* related to TypeScript definition
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants