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

feat: Added header height props #5367

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

TyCoding
Copy link

@TyCoding TyCoding commented Jan 13, 2025

Description

暴露Layout组件Header中的height props,方便用户自定义Header高度

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

    • Added configurable header height preference
    • Enhanced layout adaptability to allow dynamic header height setting
  • Improvements

    • Enabled user-specific header height customization in the application layout

Copy link

changeset-bot bot commented Jan 13, 2025

⚠️ No Changeset found

Latest commit: c543a81

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 Jan 13, 2025

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 eslint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

packages/@core/preferences/src/types.ts

Oops! Something went wrong! :(

ESLint: 9.17.0

Error [ERR_MODULE_NOT_FOUND]: Cannot find module '/node_modules/@vben/eslint-config/dist/index.mjs' imported from /eslint.config.mjs
at finalizeResolution (node:internal/modules/esm/resolve:257:11)
at moduleResolve (node:internal/modules/esm/resolve:914:10)
at defaultResolve (node:internal/modules/esm/resolve:1038:11)
at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:557:12)
at ModuleLoader.resolve (node:internal/modules/esm/loader:525:25)
at ModuleLoader.getModuleJob (node:internal/modules/esm/loader:246:38)
at ModuleJob._link (node:internal/modules/esm/module_job:126:49)

Walkthrough

The pull request introduces a new height property to the HeaderPreferences interface in the preferences types and updates the VbenAdminLayout component to support dynamic header height configuration. This change allows for more flexible header sizing based on user preferences, enabling customization of the layout's header height through a new prop.

Changes

File Change Summary
packages/@core/preferences/src/types.ts Added height: number to HeaderPreferences interface
packages/effects/layouts/src/basic/layout.vue Added :header-height="preferences.header.height" prop to VbenAdminLayout

Sequence Diagram

sequenceDiagram
    participant User as User Preferences
    participant Preferences as HeaderPreferences
    participant Layout as VbenAdminLayout
    
    User->>Preferences: Set header height
    Preferences-->>Layout: height value
    Layout->>Layout: Apply dynamic header height
Loading

Poem

🐰 A rabbit's ode to header height so fine,
Pixels dancing on a layout's design,
Preferences whisper, "Stretch me tall!"
Flexibility answers every call,
Customization leaps with pure delight! 🏠✨

Finishing Touches

  • 📝 Generate Docstrings (Beta)

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>, 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 @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 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 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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: 1

🧹 Nitpick comments (1)
packages/@core/preferences/src/types.ts (1)

106-107: Consider standardizing the JSDoc comment language

The JSDoc comment for the height property is in Chinese while most other properties use English comments. Consider maintaining consistency in documentation language.

-  /** header高度 */
+  /** Header height */
   height: number;
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 42e3220 and c543a81.

📒 Files selected for processing (2)
  • packages/@core/preferences/src/types.ts (1 hunks)
  • packages/effects/layouts/src/basic/layout.vue (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: post-update (windows-latest)
  • GitHub Check: post-update (ubuntu-latest)
🔇 Additional comments (2)
packages/@core/preferences/src/types.ts (1)

106-107: Verify default height value handling

The height property is added without specifying how default values should be handled. Consider documenting the expected default behavior or constraints.

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

181-181: LGTM! Clean implementation of header height customization

The header height property is correctly bound to the VbenAdminLayout component, maintaining consistency with other header-related properties.

@enter="handleMenuMouseEnter"
@select="handleMixedMenuSelect"
@default-select="handleDefaultSelect"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codebase verification

Confirmed: Unrelated change to header height feature

The @default-select event handler is part of the menu navigation system and has no functional relationship with the header height feature. This change should be addressed in a separate PR focused on menu-related modifications.

🔗 Analysis chain

Unrelated change detected

The @default-select event handler appears to be re-added without any functional changes. This seems unrelated to the header height feature.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check if this event handler existed before
git log -S '@default-select' --pickaxe-regex

Length of output: 0


Script:

#!/bin/bash
# Search for all occurrences of default-select
rg -l '@default-select|@emit.*default-select|\$emit.*default-select' --type vue

# Find handleDefaultSelect implementation
ast-grep --pattern 'handleDefaultSelect($$$) {
  $$$
}'

Length of output: 167


Script:

#!/bin/bash
# Search for all occurrences of default-select and handler
rg -l 'default-select|handleDefaultSelect'

# Find the implementation with more context
ast-grep --pattern 'methods: {
  $$$
  handleDefaultSelect($$$) {
    $$$
  }
  $$$
}'

Length of output: 237


Script:

#!/bin/bash
# Get context for both files
rg 'default-select|handleDefaultSelect' -C 5 packages/effects/layouts/src/basic/layout.vue packages/effects/layouts/src/basic/menu/use-extra-menu.ts

# Look for header-related code near these occurrences
rg 'header|height' -C 5 packages/effects/layouts/src/basic/layout.vue

Length of output: 7194

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant