Skip to content

Remove jQuery delayedChange and use custom method #183

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

Merged
merged 1 commit into from
Feb 8, 2024

Conversation

matt-riemer
Copy link
Member

@matt-riemer matt-riemer commented Feb 8, 2024

Summary by CodeRabbit

  • New Features
    • Enhanced user interaction with data tables by introducing delayed actions for keyup and paste events in input elements, improving the responsiveness and efficiency of data filtering.
  • Refactor
    • Streamlined data table interaction code by removing outdated dependencies and redundant reset functionalities, focusing on a more intuitive user experience.

Copy link

coderabbitai bot commented Feb 8, 2024

Walkthrough

The update removes a dependency on jquery.delayedChange and introduces custom delay handling for keyup and paste events in data tables. This enhancement aims to improve user interaction by delaying search/filter actions until the user has finished typing or pasting, reducing unnecessary processing. Additionally, it simplifies the reset functionality by focusing solely on input and data table resets, removing outdated code related to delayed changes.

Changes

File Path Change Summary
app/assets/javascripts/effective_datatables.js Removed jquery.delayedChange requirement, kept jquery.fileDownload and jquery.dataTables.
app/assets/javascripts/effective_datatables/... Added keyup and paste event handlers with delay; defined delayChange for delayed callbacks.
app/assets/javascripts/effective_datatables/reset.js.coffee Removed resetting delayed changes; focused on resetting inputs and data table.

🐰✨
A hop, a skip, a code deploy,
We've made our tables much more coy.
No more haste, with grace they'll toy,
A rabbit's touch, a coder's joy.
🌟🐾

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit-tests for this file.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit tests for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between cabde6e and 7ff020b.
Files ignored due to path filters (1)
  • app/assets/javascripts/vendor/jquery.delayedChange.js is excluded by: !**/vendor/**
Files selected for processing (3)
  • app/assets/javascripts/effective_datatables.js (1 hunks)
  • app/assets/javascripts/effective_datatables/initialize.js.coffee (2 hunks)
  • app/assets/javascripts/effective_datatables/reset.js.coffee (1 hunks)
Files skipped from review due to trivial changes (1)
  • app/assets/javascripts/effective_datatables.js
Additional comments: 3
app/assets/javascripts/effective_datatables/reset.js.coffee (1)
  • 11-16: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [1-23]

The reset functionality is correctly updated to focus on resetting inputs and the data table without relying on delayedChange.oldVal. This change simplifies the reset process and aligns with the objective of reducing dependency on external jQuery plugins.

app/assets/javascripts/effective_datatables/initialize.js.coffee (2)
  • 161-162: The custom event handlers for keyup and paste events are correctly implemented to introduce a delay before processing user inputs. This approach effectively replaces the functionality of the jquery.delayedChange plugin and aligns with the objective of enhancing efficiency.
  • 205-213: The delayChange function is well-defined to handle delayed callbacks for keyup events. This function is central to the new custom method for managing delayed input events, providing a more integrated and potentially more efficient user experience.

@matt-riemer matt-riemer merged commit fa1be2f into master Feb 8, 2024
@matt-riemer matt-riemer deleted the fix-delayed-change-edge-case branch February 8, 2024 19:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant