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: inconsistent performance between breadcrumbs and tabs #4105

Merged
merged 1 commit into from
Aug 10, 2024

Conversation

anncwb
Copy link
Collaborator

@anncwb anncwb commented Aug 10, 2024

Description

inconsistent performance between breadcrumbs and tabs, fixed #4091

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

    • Introduced a new performance label in the release categorization for clearer identification of performance improvements.
    • Enhanced icon rendering logic in the breadcrumb component for better control and fallback behavior.
  • Improvements

    • Streamlined release drafter configuration for improved clarity and specificity in release labeling.
    • Updated analytics registration method to reflect a new approach for handling site identification.
  • Bug Fixes

    • Adjusted tabbar functionality to ensure accurate handling of route changes, preventing metadata conflicts.

@anncwb anncwb requested review from vince292007 and a team as code owners August 10, 2024 02:24
Copy link

changeset-bot bot commented Aug 10, 2024

⚠️ No Changeset found

Latest commit: b58ec01

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.

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

@anncwb anncwb added the bug Something isn't working label Aug 10, 2024
Copy link
Contributor

coderabbitai bot commented Aug 10, 2024

Walkthrough

The recent changes enhance the clarity and functionality of the codebase by refining release categorization, improving icon rendering logic, and optimizing route handling in the tab bar. Noteworthy modifications include streamlined icon checks in breadcrumb components and an updated method for tab additions to prevent metadata conflicts. These adjustments not only clarify existing functionalities but also lay the groundwork for more robust performance and usability within the application.

Changes

Files Change Summary
.github/release-drafter.yml Updated release label titles and added a new "perf" label. Adjusted major/minor labels for better clarity and included "patch" and "feature" in the patch category.
docs/.vitepress/theme/plugins/hm.ts Removed the SITE_ID argument from registerAnalytics, indicating a change in analytics handling.
packages/@core/ui-kit/shadcn-ui/src/components/breadcrumb/*.vue Simplified icon rendering logic in breadcrumb-background.vue and breadcrumb.vue to rely solely on showIcon, enhancing flexibility with a fallback binding.
packages/effects/layouts/src/basic/tabbar/use-tabbar.ts Updated useTabbar function to utilize router.getRoutes() for better accuracy in route handling, avoiding metadata conflicts from parent routes.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Tabbar
    participant Router

    User->>Tabbar: Navigate to Workspace
    Tabbar->>Router: Get current route
    Router-->>Tabbar: Return current route
    Tabbar->>Tabbar: Update tabbar store with route
    Tabbar->>User: Display updated tab
Loading

Assessment against linked issues

Objective Addressed Explanation
Consistent icon display across menu, tabbar, breadcrumb (#[4091])
Accurate route handling in tabbar (#[4091])

🐇 In the code, a change did bloom,
With icons now set to light the room.
A tabbar that knows just where to go,
In breadcrumbs, icons put on a show!
Hop, skip, and jump, our code is a treat,
With clarity brought, our journey's complete! 🌟


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

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

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

Outside diff range, codebase verification and nitpick comments (1)
docs/.vitepress/theme/plugins/hm.ts (1)

Line range hint 12-25:
Consider making SITE_ID configurable.

The SITE_ID is hardcoded within the registerAnalytics function. This could limit flexibility if different environments require different SITE_IDs. Consider passing it as an argument or using environment variables to set it dynamically.

- function registerAnalytics() {
+ function registerAnalytics(siteId = SITE_ID) {
    window._hmt = window._hmt || [];
    const script = document.createElement('script');
    script.innerHTML = `var _hmt = _hmt || [];
        (function() {
          var hm = document.createElement("script");
-         hm.src = "https://hm.baidu.com/hm.js?${SITE_ID}";
+         hm.src = "https://hm.baidu.com/hm.js?" + siteId;
          var s = document.getElementsByTagName("script")[0];
          s.parentNode.insertBefore(hm, s);
        })()`;
    document.querySelector('head')?.append(script);
  }
Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between ed14282 and b58ec01.

Files selected for processing (5)
  • .github/release-drafter.yml (2 hunks)
  • docs/.vitepress/theme/plugins/hm.ts (1 hunks)
  • packages/@core/ui-kit/shadcn-ui/src/components/breadcrumb/breadcrumb-background.vue (1 hunks)
  • packages/@core/ui-kit/shadcn-ui/src/components/breadcrumb/breadcrumb.vue (3 hunks)
  • packages/effects/layouts/src/basic/tabbar/use-tabbar.ts (2 hunks)
Additional comments not posted (6)
.github/release-drafter.yml (1)

20-20: Release drafter configuration improvements are approved.

The changes to the release drafter configuration enhance clarity and organization, aligning labels more closely with their intended purposes. The addition of the "perf" label and adjustments to version-resolver categories are beneficial.

Also applies to: 25-25, 42-43, 46-47

packages/@core/ui-kit/shadcn-ui/src/components/breadcrumb/breadcrumb-background.vue (1)

36-37: Icon rendering logic improvements are approved.

The changes streamline the rendering logic for the VbenIcon component and enhance robustness by using the :fallback binding. This improves performance and ensures consistent icon display.

packages/@core/ui-kit/shadcn-ui/src/components/breadcrumb/breadcrumb.vue (3)

54-55: LGTM! Simplified icon rendering logic.

The changes to conditionally render VbenIcon based on showIcon and introduce a fallback mechanism enhance the consistency and flexibility of icon display.


81-83: Consistent icon rendering logic applied.

The use of showIcon and fallback in the BreadcrumbLink section maintains consistency in icon rendering logic.


93-95: Unified icon rendering logic in BreadcrumbPage.

Applying the showIcon conditional rendering and fallback mechanism ensures consistency across the breadcrumb component.

packages/effects/layouts/src/basic/tabbar/use-tabbar.ts (1)

103-110: Improved route handling logic for tab management.

The changes prevent unintended metadata merging by explicitly finding the current route, enhancing the accuracy of tab additions.

@anncwb anncwb merged commit 8725a01 into main Aug 10, 2024
17 checks passed
@anncwb anncwb deleted the fixture/issue-#4091 branch August 10, 2024 02:30
@github-actions github-actions bot locked and limited conversation to collaborators Sep 10, 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.

Bug: menu tabbar breadcrum 三者icon显示逻辑不一致
1 participant