Refactor: Replace jQuery with Vue reactivity in OpenOffline.vue
Fixes #433
cc : @Arnabdaz @JoshVarga
Note: Please check Allow edits from maintainers. if you would like us to assist in the PR.
Summary by CodeRabbit
- Refactor
- Enhanced the offline projects dialog for a smoother closing experience.
- Now displays accurate status messages and button options based on project availability.
- Ensured the project list refreshes automatically when the dialog opens, providing users with up-to-date information.
Walkthrough
This pull request refactors the close functionality in the OpenOffline.vue component by introducing a dedicated closeDialog function. It updates conditional checks for empty project lists by replacing JSON-based checks with Object.keys methods. The lifecycle hooks (onMounted and onUpdated) have been replaced with a watchEffect to refresh the project list whenever the dialog is opened. Additionally, the deleteOfflineProject function is simplified by directly using projectId, and both openProjectOffline and OpenImportProjectDialog now call closeDialog to centralize close behavior.
Changes
| File(s) | Change Summary |
|---|---|
src/components/DialogBox/OpenOffline.vue |
- Added a dedicated closeDialog function and updated openProjectOffline & OpenImportProjectDialog to invoke it.- Updated empty checks from JSON.stringify to Object.keys methods.- Replaced onMounted/onUpdated with watchEffect for project list updates.- Simplified deleteOfflineProject by using projectId directly. |
Sequence Diagram(s)
sequenceDiagram
participant User as User
participant Component as OpenOffline.vue
participant State as SimulatorState
User->>Component: Click "Open Project" / "Import Project" button
Component->>Component: Execute openProjectOffline() / OpenImportProjectDialog()
Component->>Component: Invoke closeDialog()
Component->>State: Set dialogBox.open_project_dialog = false
Note over Component: watchEffect refreshes projectList when dialog opens
Possibly related PRs
- CircuitVerse/cv-frontend-vue#337: Addresses similar modifications in the
OpenOffline.vuecomponent, specifically in theopenProjectOfflineandOpenImportProjectDialogfunctions, ensuring consistent dialog close behavior.
Suggested labels
GSOC'24
Poem
I'm a hopping rabbit, leaping with glee,
Refactoring code by the light of the tree.
The dialog now closes in a swift, neat twist,
While project lists update, like a digital tryst.
With twitchy nose and a joyful heart so free,
I celebrate these changes, happy as can be!
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?
🪧 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.Generate unit testing code for this file.Open a follow-up GitHub issue for this discussion.
- Files and specific lines of code (under the "Files changed" tab): Tag
@coderabbitaiin a new review comment at the desired location with your query. Examples:@coderabbitai generate unit testing code for this file.@coderabbitai modularize this function.
- PR comments: Tag
@coderabbitaiin 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 generate unit testing code.@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.
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 pauseto pause the reviews on a PR.@coderabbitai resumeto resume the paused reviews.@coderabbitai reviewto trigger an incremental review. This is useful when automatic reviews are disabled for the repository.@coderabbitai full reviewto do a full review from scratch and review all the files again.@coderabbitai summaryto regenerate the summary of the PR.@coderabbitai generate docstringsto generate docstrings for this PR. (Beta)@coderabbitai resolveresolve all the CodeRabbit review comments.@coderabbitai configurationto show the current CodeRabbit configuration for the repository.@coderabbitai helpto get help.
Other keywords and placeholders
- Add
@coderabbitai ignoreanywhere in the PR description to prevent this PR from being reviewed. - Add
@coderabbitai summaryto generate the high-level summary at a specific location in the PR description. - Add
@coderabbitaianywhere in the PR title to generate the title automatically.
CodeRabbit Configuration File (.coderabbit.yaml)
- You can programmatically configure CodeRabbit by adding a
.coderabbit.yamlfile 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.
Deploy Preview for circuitverse ready!
| Name | Link |
|---|---|
| Latest commit | f9cf2a7672700f1193f29c4b469cc029259f66b9 |
| Latest deploy log | https://app.netlify.com/sites/circuitverse/deploys/67b7138b6da788000827404b |
| Deploy Preview | https://deploy-preview-487--circuitverse.netlify.app |
| Preview on mobile | Toggle QR Code...Use your smartphone camera to open QR code link. |
To edit notification comments on pull requests, go to your Netlify site configuration.
@JoshVarga @Arnabdaz PTAL