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

fix: external link jump #4319

Merged
merged 5 commits into from
Sep 6, 2024
Merged

fix: external link jump #4319

merged 5 commits into from
Sep 6, 2024

Conversation

pzzyf
Copy link
Contributor

@pzzyf pzzyf commented Sep 4, 2024

Description

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update
  • Please, don't make changes to pnpm-lock.yaml unless you introduce a new test example.

Checklist

ℹ️ Check all checkboxes - this will indicate that you have done everything in accordance with the rules in CONTRIBUTING.

  • If you introduce new functionality, document it. You can run documentation with pnpm run docs:dev command.
  • Run the tests with pnpm test.
  • Changes in changelog are generated from PR name. Please, make sure that it explains your changes in an understandable manner. Please, prefix changeset messages with feat:, fix:, perf:, docs:, or chore:.
  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

Summary by CodeRabbit

  • New Features
    • Enhanced navigation logic to handle external URLs, allowing them to open directly in the browser while managing internal routing through the app's router.
  • Chores
    • Added a new dependency to improve shared functionalities across the application.

Copy link

changeset-bot bot commented Sep 4, 2024

⚠️ No Changeset found

Latest commit: 0f494ad

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Contributor

coderabbitai bot commented Sep 4, 2024

Important

Review skipped

Review was skipped due to path filters

Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The change introduces a new dependency in the package.json for @vben-core/shared and modifies the handleEnter function in search-panel.vue to differentiate between internal and external links. The function now checks if a path is a valid HTTP URL, opening it in a new tab if true, while using the router's push method for internal navigation.

Changes

Files Change Summary
packages/effects/layouts/package.json Added new dependency "@vben-core/shared": "workspace:*" to the project.
packages/effects/layouts/src/widgets/global-search/search-panel.vue Modified handleEnter function to handle external links differently from internal routing.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant SearchPanel
    participant Router

    User->>SearchPanel: Enter search
    SearchPanel->>SearchPanel: Check if path is valid HTTP URL
    alt External Link
        SearchPanel->>User: Open external URL in new tab (window.open)
    else Internal Link
        SearchPanel->>Router: router.push(to.path, { replace: true })
    end
Loading

Poem

🐰 In the meadow, I hop with glee,
A change in the code, oh joy for me!
Links now dance in a clearer way,
Internal or external, bright as day.
With a twitch of my nose, I cheer and play! 🌼


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 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 @coderabbitai in 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 @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 and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 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 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.

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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 3332b20 and 05f7d0b.

Files selected for processing (1)
  • packages/effects/layouts/src/widgets/global-search/search-panel.vue (1 hunks)
Additional comments not posted (1)
packages/effects/layouts/src/widgets/global-search/search-panel.vue (1)

102-106: LGTM!

The changes to the handleEnter function enhance the navigation logic by handling external links differently from internal routing. External URLs are opened directly in the browser using window.location.href, while internal paths are managed through the router with the replace: true option. This ensures a smooth navigation experience for the user.

The code changes are approved.

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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 05f7d0b and 7948054.

Files selected for processing (2)
  • packages/effects/layouts/package.json (1 hunks)
  • packages/effects/layouts/src/widgets/global-search/search-panel.vue (2 hunks)
Additional comments not posted (2)
packages/effects/layouts/package.json (1)

27-27: Verify the usage and impact of the added dependency @vben-core/shared.

The new dependency @vben-core/shared has been added to the package.json file. While this change can enhance code reuse and modularity, it's crucial to ensure that the added dependency is actually used and does not introduce any unnecessary bloat or complexity.

Please provide more context on how this dependency is being utilized within the @vben/layouts package and confirm that it does not have any unintended side effects.

Additionally, consider running the following script to verify the usage of the @vben-core/shared package:

Verification successful

The dependency @vben-core/shared is actively used across the codebase.

The @vben-core/shared package is imported in multiple files, indicating its significant role in providing shared utilities or components. This justifies its addition as a dependency in the package.json file.

  • Files utilizing @vben-core/shared include:
    • packages/utils/src/helpers/generate-routes-frontend.ts
    • packages/stores/src/modules/tabbar.ts
    • packages/utils/src/helpers/generate-menus.ts
    • packages/utils/src/helpers/generate-routes-backend.ts
    • packages/@core/composables/src/use-content-style.ts
    • packages/@core/preferences/src/use-preferences.ts
    • packages/@core/ui-kit/popup-ui/src/modal/use-modal.ts
    • And several others.
Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the usage of the `@vben-core/shared` package.

# Test: Search for import statements of `@vben-core/shared`. Expect: At least one occurrence.
rg --type typescript -g '!node_modules' -g '!dist' $'from \'@vben-core/shared\''

Length of output: 120


Script:

#!/bin/bash
# Description: Verify the usage of the `@vben-core/shared` package.

# Test: Search for import statements of `@vben-core/shared` in .ts files. Expect: At least one occurrence.
rg --glob '*.ts' -g '!node_modules' -g '!dist' $'from \'@vben-core/shared\''

Length of output: 1484

packages/effects/layouts/src/widgets/global-search/search-panel.vue (1)

103-107: LGTM!

The changes to the handleEnter function look good. The function now handles external links differently from internal routing by opening them in a new browser tab, which is an improvement to the navigation logic.

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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 7948054 and 37f7c39.

Files selected for processing (1)
  • packages/effects/layouts/package.json (1 hunks)
Additional comments not posted (1)
packages/effects/layouts/package.json (1)

27-27: LGTM!

The added dependency @vben-core/shared looks good.

@vince292007 vince292007 merged commit 31d5f03 into vbenjs:main Sep 6, 2024
12 checks passed
@vince292007 vince292007 added the bug Something isn't working label Sep 6, 2024
@pzzyf pzzyf deleted the fix/link branch September 6, 2024 03:08
kkfive pushed a commit to kkfive/vue-vben-admin that referenced this pull request Sep 14, 2024
* fix: external link jump

* fix: external link jump

* chore: update deps

---------

Co-authored-by: Li Kui <[email protected]>
@github-actions github-actions bot locked and limited conversation to collaborators Oct 7, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants