Skip to content

refactor: remove jQuery & DOM logic from CustomShortcut.vue #582

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

blazethunderstorm
Copy link

@blazethunderstorm blazethunderstorm commented Jun 7, 2025

Fixes #433

Describe the changes you have made in this PR -

removed jQuery & DOM logic from CustomShortcut.vue

Screenshots of the changes (If any) -

Note: Please check Allow edits from maintainers. if you would like us to assist in the PR.

Summary by CodeRabbit

  • Refactor
    • Improved the responsiveness and reliability of the shortcut editing dialog by updating how style and focus are managed, resulting in a smoother and more consistent user experience. No visible changes to functionality.

Copy link

netlify bot commented Jun 7, 2025

Deploy Preview for circuitverse ready!

Name Link
🔨 Latest commit 8882f86
🔍 Latest deploy log https://app.netlify.com/projects/circuitverse/deploys/6844912ee911a90008462eaa
😎 Deploy Preview https://deploy-preview-582--circuitverse.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 30 (🔴 down 16 from production)
Accessibility: 72 (no change from production)
Best Practices: 92 (no change from production)
SEO: 80 (no change from production)
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link
Contributor

coderabbitai bot commented Jun 7, 2025

Walkthrough

The update refactors the style and focus management of the "edit" element in CustomShortcut.vue from direct DOM manipulation to Vue's reactive system. All style changes and focus handling now use Vue refs and bindings, eliminating direct access to the DOM via document.getElementById.

Changes

Files Change Summary
src/components/DialogBox/CustomShortcut.vue Refactored all direct DOM manipulations for the "edit" element to use Vue refs and reactive bindings.

Assessment against linked issues

Objective (Issue #) Addressed Explanation
Refactor remaining DOM manipulations to Vue reactives (#433)

Assessment against linked issues: Out-of-scope changes

No out-of-scope changes were found.

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

npm error Exit handler never called!
npm error This is an error with npm itself. Please report this error at:
npm error https://github.com/npm/cli/issues
npm error A complete log of this run can be found in: /.npm/_logs/2025-06-07T19_23_51_537Z-debug-0.log


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • 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 explain this code block.
    • @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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • 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/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@blazethunderstorm
Copy link
Author

@niladrix719 @Arnabdaz pls review the pr , thanks

Copy link
Contributor

@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.

Actionable comments posted: 0

🧹 Nitpick comments (1)
src/components/DialogBox/CustomShortcut.vue (1)

163-168: Improve focus handling with optional chaining.

The refactor correctly replaces direct DOM access with Vue refs. However, the focus call could be made more robust.

Apply this diff for safer focus handling:

-    // Focus the edit element using Vue ref
-    if (editRef.value) {
-        editRef.value.focus()
-    }
+    // Focus the edit element using Vue ref
+    editRef.value?.focus()

This uses optional chaining which is more concise and handles potential null values elegantly.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f64c366 and 8882f86.

📒 Files selected for processing (1)
  • src/components/DialogBox/CustomShortcut.vue (6 hunks)
🔇 Additional comments (7)
src/components/DialogBox/CustomShortcut.vue (7)

22-32: Excellent refactor to Vue's reactive system!

The template binding correctly replaces direct DOM manipulation with Vue's reactive :style directive. This is a clean implementation that follows Vue 3 best practices.


135-140: Well-structured reactive refs declaration.

The reactive refs are properly typed and initialized with appropriate default values. This provides a clean foundation for the style management refactor.


181-181: LGTM: Animation reset properly implemented.

The reactive state update correctly replaces the previous direct style manipulation.


187-187: LGTM: Error animation properly implemented.

The shake animation trigger is correctly implemented using reactive state.


195-195: LGTM: Display state management correctly refactored.

The display state change is properly handled through reactive refs.


198-198: LGTM: Consistent animation handling.

Another instance of proper animation handling through reactive state.


252-260: LGTM: Dialog close logic correctly refactored.

Both closeDialog() and closeAllDialog() functions now properly use reactive state instead of direct DOM queries. The logic flow remains intact while using Vue's reactive system.

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.

Removal of JQuery to Vue's reactives
1 participant