Skip to content

refactor: remove jQuery & DOM logic from ApplyThemes.vue #583

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 2 commits 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 ApplyThemes.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 theme selection and application to use a more responsive and reliable approach.
    • Enhanced theme import and export actions for a smoother user experience.
    • Dialogs now reset to the previously saved theme state when closed.

Copy link

netlify bot commented Jun 7, 2025

Deploy Preview for circuitverse ready!

Name Link
🔨 Latest commit f7d14f7
🔍 Latest deploy log https://app.netlify.com/projects/circuitverse/deploys/684d91ecc9c81d0008067e8f
😎 Deploy Preview https://deploy-preview-583--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: 44 (🔴 down 3 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 changes refactor the theme selection and application logic in a Vue component by removing jQuery and direct DOM manipulation. Instead, the code now uses Vue's reactive state, computed properties, and refs for managing theme selection, application, importing, and exporting, resulting in a more declarative and component-driven approach.

Changes

File(s) Change Summary
src/components/DialogBox/Themes/ApplyThemes.vue Refactored to remove jQuery and direct DOM manipulation; replaced with Vue reactive state, computed properties, and refs for theme management, import, and export logic.

Assessment against linked issues

Objective Addressed Explanation
Remove remaining jQuery and migrate DOM manipulations to Vue's reactive system (#433)

Suggested reviewers

  • Arnabdaz

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_55_15_833Z-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 @tachyons @vedant-jain03 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: 1

🔭 Outside diff range comments (1)
src/components/DialogBox/Themes/ApplyThemes.vue (1)

73-73: 💡 Verification agent

🧩 Analysis chain

Verify the radio button checked logic.

The condition theme == 'Default Theme' will always check the Default Theme radio button, potentially causing multiple radio buttons to appear checked simultaneously.

Should this be checking if no theme is selected instead? Consider:

-:checked="theme == selectedTheme || theme == 'Default Theme'"
+:checked="theme == selectedTheme || (!selectedTheme && theme == 'Default Theme')"

Run this script to check if there's a default theme fallback logic:


🏁 Script executed:

#!/bin/bash
# Check for default theme handling in the codebase
rg -A 3 -B 3 "default.*theme|Default Theme" --type vue --type ts

Length of output: 94


🏁 Script executed:

#!/bin/bash
# Locate the ApplyThemes.vue file
file=$(fd ApplyThemes.vue)

echo "Found file: $file"

# Show the props block to see default values
rg -n -C3 "props" "$file"

# Show selectedTheme declaration and default if any
rg -n -C3 "selectedTheme" "$file"

Length of output: 1241


#!/bin/bash
# Find ApplyThemes.vue files
files=$(fd -e vue ApplyThemes.vue)

for file in $files; do
  echo "====== File: $file ======"
  echo "-- Props / defineProps block --"
  rg -n -C3 "props\s*:" "$file" || true
  rg -n -C3 "defineProps" "$file" || true

  echo "-- selectedTheme occurrences --"
  rg -n "selectedTheme" "$file" || true

  echo "-- Default Theme defaults --"
  rg -n "default.*['\"]Default Theme['\"]" "$file" || true

  echo "-- Template snippet --"
  sed -n '60,90p' "$file"
  echo
done

#!/bin/bash
# Find all instances of ApplyThemes.vue
fd -e vue ApplyThemes.vue | while IFS= read -r file; do
  echo "====== File: $file ======"
  echo "-- Props or defineProps block --"
  rg -n -C3 "defineProps" "$file" || rg -n -C3 "props\s*:" "$file"
  
  echo
  echo "-- selectedTheme references --"
  rg -n -C3 "selectedTheme" "$file"
  
  echo
  echo "-- Default Theme string occurrences --"
  rg -n -C3 "'Default Theme'" "$file"
  
  echo
  echo "-- Template context around line 73 --"
  sed -n '60,90p' "$file"
  echo
done

Fix the Default Theme radio selection logic
The current check

:checked="theme == selectedTheme || theme == 'Default Theme'"

will always mark the “Default Theme” radio as checked, even when another theme is selected. Update it to only fall back to Default when no theme is chosen:

- :checked="theme === selectedTheme || theme === 'Default Theme'"
+ :checked="selectedTheme
+    ? theme === selectedTheme
+    : theme === 'Default Theme'"

Or more succinctly:

- :checked="theme === selectedTheme || theme === 'Default Theme'"
+ :checked="theme === (selectedTheme || 'Default Theme')"

This ensures only one radio remains checked at a time.

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

170-170: Simplify the type annotation for better readability.

The current type annotation is unnecessarily complex. Since you're initializing with undefined, Vue can infer the type.

-const customThemes = ref<((keyof typeof customThemesList)[]) | undefined>(undefined)
+const customThemes = ref<(keyof typeof customThemesList)[]>()
📜 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 68eecb6.

📒 Files selected for processing (1)
  • src/components/DialogBox/Themes/ApplyThemes.vue (10 hunks)
🔇 Additional comments (2)
src/components/DialogBox/Themes/ApplyThemes.vue (2)

29-29: Great refactoring to use Vue's reactive patterns!

The use of computed properties for dynamic class binding and template refs for DOM element access properly follows Vue best practices and eliminates the need for jQuery.

Also applies to: 111-122


292-301: Well-implemented file handling with proper Vue patterns!

The new handleFileChange method and the refactored import/export functions correctly use template refs and follow Vue best practices. The file type validation and error handling are properly implemented.

Also applies to: 304-306, 310-319

Comment on lines +193 to +195
const selectedThemeText = computed(() => {
return selectedTheme.value
})
Copy link
Contributor

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Remove redundant computed property.

The selectedThemeText computed property doesn't perform any computation and just returns selectedTheme.value. This adds unnecessary complexity.

Remove the computed property:

-// Computed property to get selected theme text
-const selectedThemeText = computed(() => {
-    return selectedTheme.value
-})

And update line 236 to use selectedTheme.value directly:

-        if (selectedThemeText.value) {
+        if (selectedTheme.value) {
             localStorage.removeItem('Custom Theme')
-            localStorage.setItem('theme', selectedThemeText.value)
+            localStorage.setItem('theme', selectedTheme.value)

Also applies to: 236-238

🤖 Prompt for AI Agents
In src/components/DialogBox/Themes/ApplyThemes.vue around lines 193 to 195, the
computed property selectedThemeText is redundant as it only returns
selectedTheme.value without any transformation. Remove the selectedThemeText
computed property entirely and update all references to it, specifically lines
236 to 238, to use selectedTheme.value directly instead.

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
2 participants