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.

Sign up for GitHub

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

Jump to bottom

[Doc] Add doc for <BulkUpdateButton> #9077

Merged
merged 2 commits into from
Jul 10, 2023
Merged

[Doc] Add doc for <BulkUpdateButton> #9077

merged 2 commits into from
Jul 10, 2023

Conversation

slax57
Copy link
Contributor

@slax57 slax57 commented Jul 5, 2023 •
edited by fzaninotto
Loading

Closes #8790

@slax57 slax57 added the RFR Ready For Review label Jul 5, 2023
djhi
djhi requested changes Jul 7, 2023
View reviewed changes
adguernier
adguernier reviewed Jul 7, 2023
View reviewed changes
docs/Buttons.md Outdated

| Prop | Required | Type | Default | Description |
| -------------------- | -------- | --------------------------------------- | ------------------ | ------------------------------------------------------------------------------------------------------------------- |
| `data` | Required | `object` | - | An object with the fields that need to be updated on the selected records |
Copy link
Contributor

Choose a reason for hiding this comment

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

Should not we provide an example of the shape of the data object ?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

You have one example in the snippet just above the table. Am I missing something?

djhi
djhi reviewed Jul 10, 2023
View reviewed changes
Copy link
Collaborator

@djhi djhi left a comment

Choose a reason for hiding this comment

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

We should probably extract this in a dedicated documentation page and reference it there eventually

@slax57
Copy link
Contributor Author

slax57 commented Jul 10, 2023

We should probably extract this in a dedicated documentation page and reference it there eventually

Eventually yes, along with the other buttons referenced in Buttons.md. But for now I think simply documenting this (existing) button next to and in the same style as its siblings (BulkDeleteButton and BulkExportButton) is good enough.
Wdyt?

@djhi djhi merged commit b931b95 into master Jul 10, 2023
@djhi djhi deleted the BulkUpdateButton-doc branch July 10, 2023 12:36
@djhi djhi added this to the 4.12.1 milestone Jul 10, 2023
@fzaninotto fzaninotto mentioned this pull request Aug 1, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@djhi djhi djhi requested changes

@adguernier adguernier adguernier left review comments

Assignees
No one assigned
Labels
RFR Ready For Review
Projects
None yet
Milestone
4.12.1
Development

Successfully merging this pull request may close these issues.

BulkUpdateButton: Missing documentation
3 participants
@slax57 @djhi @adguernier