fix: type Component is not assignable to RouteMeta

[likui628]

Description

closes #4134

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 the routing configuration by allowing the icon property to accept either a Vue component or a string, enabling more complex icon representations.
  • Improved flexibility of icon representation in menus and breadcrumbs by updating the icon property to accept both a component and a string.
• Bug Fixes
  • Streamlined logic in breadcrumb generation to focus on meta and path properties, simplifying the display of breadcrumbs.

[changeset-bot]

⚠️ No Changeset found

Latest commit: bc299ad

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

[coderabbitai]

Walkthrough

The recent update enhances the icon property across several interfaces, allowing it to accept both Vue components and strings. This change significantly improves the flexibility of icon usage in routing and menu configurations, enabling developers to create more complex and visually rich user interfaces in Vue applications.

Changes

Files	Change Summary
packages/@core/base/typings/src/vue-router.d.ts, packages/@core/base/typings/src/menu-record.ts, packages/@core/ui-kit/menu-ui/src/interface/index.ts, packages/@core/ui-kit/shadcn-ui/src/components/breadcrumb/types.ts	Updated icon property type in multiple interfaces from string to `Component
packages/@core/ui-kit/menu-ui/src/sub-menu.vue	Removed commented-out function menuIcon, simplifying component logic related to icon handling.
packages/effects/layouts/src/widgets/breadcrumb.vue	Simplified breadcrumb generation logic by removing child route handling, focusing solely on meta and path.

Assessment against linked issues

Objective	Addressed	Explanation
Support component type for icon in routing metadata (#4134)	✅
Support component type for icon in menu records (#4134)	✅

Poem

In a world of routes, so bright and grand,
A rabbit hops forth with a new, clever plan.
Icons can now dance, both component and string,
Making menus more lively, oh what joy they bring!
So let us rejoice in this change so wise,
For flexibility blooms, like spring in the skies! 🐇✨

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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.

[coderabbitai]

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 843ec1e and 3ece515.

Files selected for processing (1)

• packages/@core/base/typings/src/vue-router.d.ts (1 hunks)

Additional comments not posted (1)

packages/@core/base/typings/src/vue-router.d.ts (1)

71-71: Enhance icon property flexibility in RouteMeta.

The change to the icon property type from string to Component | string enhances flexibility, allowing both Vue components and strings as icons. This aligns with the PR's goal of improving the routing configuration's expressiveness.

[anncwb]

CI 没过

[coderabbitai]

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 3ece515 and bc299ad.

Files selected for processing (5)

• packages/@core/base/typings/src/menu-record.ts (2 hunks)
• packages/@core/ui-kit/menu-ui/src/interface/index.ts (4 hunks)
• packages/@core/ui-kit/menu-ui/src/sub-menu.vue (1 hunks)
• packages/@core/ui-kit/shadcn-ui/src/components/breadcrumb/types.ts (1 hunks)
• packages/effects/layouts/src/widgets/breadcrumb.vue (2 hunks)

Files skipped from review due to trivial changes (1)

• packages/@core/ui-kit/menu-ui/src/sub-menu.vue

Additional comments not posted (5)

packages/@core/ui-kit/shadcn-ui/src/components/breadcrumb/types.ts (1)

1-4: LGTM! The type change for icon enhances flexibility.

The modification of the icon property to accept both Component and string types allows for greater versatility in breadcrumb icon usage.

packages/@core/base/typings/src/menu-record.ts (1)

3-4: LGTM! The type change for icon enhances flexibility.

The modification of the icon property to accept both Component and string types allows for richer icon representations in the menu system. The import statement for Component is correctly added.

Also applies to: 49-49

packages/effects/layouts/src/widgets/breadcrumb.vue (1)

33-33: Verify the impact of breadcrumb logic changes on nested routes.

The removal of child route handling simplifies the logic but could affect scenarios with nested routes. Ensure that this change does not negatively impact the user experience.

packages/@core/ui-kit/menu-ui/src/interface/index.ts (2)

64-64: Enhanced flexibility for icon property in SubMenuProps.

The icon property now accepts a Component or a string, allowing for more dynamic and visually rich menu items. This aligns with the PR objectives to support component types for icons.

---

83-83: Enhanced flexibility for icon property in MenuItemProps.

The icon property now accepts a Component or a string, allowing for more dynamic and visually rich menu items. This change is consistent with the PR objectives to support component types for icons.