feat: add support for custom slot header-index, sorted by index

[jinmao88]

框架默认插槽user-dropdown的index:30，notification的index:25
closes #4034

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 header component functionality with dynamic slot handling based on user preferences.
  • Introduced computed properties for flexible rendering of header slots.

• Bug Fixes

  • Commented out static slot declarations to refine the visibility of the header component's template.

• Documentation

  • Added a new README.md file detailing the layout specifications and customization options for the header section.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 1a6b2f5

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 updates enhance the Vue.js application's header management by introducing dynamic slot handling. The components now utilize computed properties to construct and render slot names based on user preferences, allowing for greater adaptability. This change improves the overall functionality while maintaining the existing logic of the application, making it easier to manage header elements.

Changes

Files	Change Summary
.../src/layouts/basic.vue	Commented out the header-1 slot declaration, modifying its visibility without affecting functionality.
.../src/basic/header/header.vue, .../src/basic/layout.vue	Introduced new computed properties rightSlots, leftSlots, and headerSlots for dynamic slot rendering, replacing static declarations with flexible v-for loops.
.../src/basic/README.md	Added documentation outlining layout specifications for header slots, including customization options and ordering rules.

Assessment against linked issues

Objective	Addressed	Explanation
Suggestion to add multiple slots in the header (#[4034])	✅
Improvement in flexibility for custom buttons in the header (#[4034])	✅

Poem

In a web of code, a rabbit prances,
With slots that dance and flex in glances.
Dynamic headers, oh what a treat,
Render with joy, oh so neat!
Preferences bloom like flowers in spring,
A hop of change, let’s all sing! 🐇✨

---

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 36e33ea and 0f8c4ab.

Files selected for processing (3)

• apps/web-antd/src/layouts/basic.vue (1 hunks)
• packages/effects/layouts/src/basic/header/header.vue (3 hunks)
• packages/effects/layouts/src/basic/layout.vue (3 hunks)

Files skipped from review due to trivial changes (1)

• apps/web-antd/src/layouts/basic.vue

Additional comments not posted (6)

packages/effects/layouts/src/basic/header/header.vue (3)

2-2: LGTM!

The import statement for useSlots is correct and necessary for accessing slot definitions dynamically.

---

28-43: LGTM! Consider adding a comment for clarity.

The computed property headerSlots correctly constructs and sorts the slot list based on the index. This enhances the flexibility of slot rendering. For better readability, consider adding a comment explaining the logic.

+ // Dynamically generate and sort header slots based on the index.
const headerSlots = computed(() => {
  ...
});

---

63-65: LGTM!

The template updates correctly use the v-for directive with headerSlots to render slots dynamically. This improves the flexibility and maintainability of the template.

packages/effects/layouts/src/basic/layout.vue (3)

2-2: LGTM!

The import statement for useSlots is correct and necessary for accessing slot definitions dynamically.

---

151-159: LGTM! Consider adding a comment for clarity.

The computed property headerSlots correctly constructs the slot list based on the prefix "header-". This enhances the flexibility of slot rendering. For better readability, consider adding a comment explaining the logic.

+ // Dynamically generate header slots based on the prefix "header-".
const headerSlots = computed(() => {
  ...
});

---

252-254: LGTM!

The template updates correctly use the v-for directive with headerSlots to render slots dynamically. This improves the flexibility and maintainability of the template.

[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 0f8c4ab and 607407b.

Files selected for processing (2)

• packages/effects/layouts/src/basic/header/header.vue (3 hunks)
• packages/effects/layouts/src/basic/layout.vue (3 hunks)

Files skipped from review as they are similar to previous changes (2)

• packages/effects/layouts/src/basic/header/header.vue
• packages/effects/layouts/src/basic/layout.vue

[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 607407b and fa2cce3.

Files selected for processing (1)

• packages/effects/layouts/src/basic/layout.vue (3 hunks)

Additional comments not posted (3)

packages/effects/layouts/src/basic/layout.vue (3)

4-4: Import statement is correct.

The useSlots function is correctly imported from 'vue'.

---

149-152: Computed property implementation is correct.

The headerSlots computed property correctly filters slot names that start with 'header-'.

---

245-247: Template changes are correct.

The v-for loop correctly renders slots based on headerSlots.

[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 fa2cce3 and 1a6b2f5.

Files selected for processing (2)

• packages/effects/layouts/src/basic/README.md (1 hunks)
• packages/effects/layouts/src/basic/header/header.vue (2 hunks)

Files skipped from review as they are similar to previous changes (1)

• packages/effects/layouts/src/basic/header/header.vue

Additional comments not posted (1)

packages/effects/layouts/src/basic/README.md (1)

1-7: Documentation is clear and concise.

The README file provides clear instructions on the custom slot naming conventions and sorting order for the header. Ensure that the implementation aligns with this documentation.