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

SearchKit - In-place edit without refreshing results #27105

Merged
merged 2 commits into from Sep 5, 2023

Conversation

colemanw
Copy link
Member

@colemanw colemanw commented Aug 20, 2023

Overview

This speeds up the process of in-place-editing on a SearchKit display.

Before

Modifying a field results in several seconds' wait (if you have enough columns).

After

Instead of waiting for the table to reload, you can continue editing other fields immediately and saving happens in the background.
Added the little green status indicator in the top-right corner to show save progress.

Technical Details

This required a bit of reinventing-the-wheel because display values are usually formatted server-side. I had to add a function to do client-side formatting, and the result is... comparable. Dates don't come out exactly the same way due to differences between Civi's js and php implementations of date formatting. Selects, radios, textfields, multi-selects, booleans and money fields all work ok. EntityRefs are still todo, because I noticed another issue with those.

@civibot
Copy link

civibot bot commented Aug 20, 2023

Thank you for contributing to CiviCRM! ❤️ We will need to test and review the PR. 👷

Introduction for new contributors
  • If this is your first PR, an admin will greenlight automated testing with the command ok to test or add to whitelist.
  • A series of tests will automatically run. You can see the results at the bottom of this page (if there are any problems, it will include a link to see what went wrong).
  • A demo site will be built where anyone can try out a version of CiviCRM that includes your changes.
  • If this process needs to be repeated, an admin will issue the command test this please to rerun tests and build a new demo site.
  • Before this PR can be merged, it needs to be reviewed. Please keep in mind that reviewers are volunteers, and their response time can vary from a few hours to a few weeks depending on their availability and their knowledge of this particular part of CiviCRM.
  • A great way to speed up this process is to "trade reviews" with someone - find an open PR that you feel able to review, and leave a comment like "I'm reviewing this now, could you please review mine?" (include a link to yours). You don't have to wait for a response to get started (and you don't have to stop at one!) the more you review, the faster this process goes for everyone 😄
  • To ensure that you are credited properly in the final release notes, please add yourself to contributor-key.yml
  • For more information about contributing, see CONTRIBUTING.md.
Quick links for reviewers

@colemanw
Copy link
Member Author

@MegaphoneJon aside from entityRef fields this is ready for review.

@MegaphoneJon
Copy link
Contributor

I reviewed it and pushed it to a client for further review, but I haven't heard back. I'll check in with him tomorrow.

Before: .done() method only works with jQuery object
After: .then() method works with both
@MegaphoneJon
Copy link
Contributor

My client hasn't had a chance to review this - but my r-run didn't find any issues.

@colemanw colemanw added the merge ready PR will be merged after a few days if there are no objections label Sep 1, 2023
@eileenmcnaughton
Copy link
Contributor

Merging based on @MegaphoneJon r-run

@eileenmcnaughton eileenmcnaughton merged commit b7bc7f7 into civicrm:master Sep 5, 2023
3 checks passed
@eileenmcnaughton eileenmcnaughton deleted the inPlaceEdit branch September 5, 2023 01:05
colemanw added a commit to colemanw/civicrm-core that referenced this pull request Sep 6, 2023
Followup to civicrm#27105 this uses native angular service instead of jQuery-based function
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
master merge ready PR will be merged after a few days if there are no objections
Projects
None yet
3 participants