fix: page prop type check

[mynetfan]

Description

修复Page组件的Props声明

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 fixedHeader property in the page component, allowing users to enable a sticky header for improved navigation.

• Bug Fixes

  • Ensured the default value for fixedHeader is set to false, preventing unintended sticky headers.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 62cc90d

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]

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/effects/common-ui/src/components/page/page.vue

Oops! Something went wrong! :(

ESLint: 9.16.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 changes in this pull request involve the modification of the Props interface in the page.vue component. The fixedHeader property, which was previously commented out, is now active, allowing it to be passed as a prop. This enables the functionality of a fixed header in the layout, with a default value of false. The computed property headerStyle uses the fixedHeader prop to adjust CSS styles, specifically for positioning and z-index, while maintaining the existing control flow and logic of the component.

Changes

File Path	Change Summary
packages/effects/common-ui/src/components/page/page.vue	Added fixedHeader?: boolean to the Props interface, uncommented it, and updated headerStyle to utilize this prop for styling.

Possibly related PRs

• feat: improve page component #5013: This PR introduces the fixed-header attribute to the Page component, which directly relates to the changes made in the main PR that also modifies the Props interface to include the fixedHeader property.
• fix: Page header class in fixed mode #5023: This PR enhances the header styling in the Page component when fixedHeader is true, which is directly connected to the changes made in the main PR regarding the fixedHeader property and its usage in the component.

Suggested labels

bug

Suggested reviewers

• anncwb
• vince292007

Poem

In the land of code where rabbits play,
A fixed header hops in, brightening the day.
With props now set, it stands tall and true,
Adjusting its style, just for you!
So let’s celebrate this change with glee,
A sticky header for all to see! 🐇✨

---

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

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)

packages/effects/common-ui/src/components/page/page.vue (1)

23-23: Update or remove the outdated comment

The comment /** 头部固定（暂未实现） */ (header fixed - not implemented) is now outdated since the feature is being implemented.

-  /** 头部固定（暂未实现） */
+  /** 控制头部是否固定 */
   fixedHeader?: boolean;

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 0fc0f13 and 62cc90d.

📒 Files selected for processing (1)

• packages/effects/common-ui/src/components/page/page.vue (1 hunks)

🔇 Additional comments (2)

packages/effects/common-ui/src/components/page/page.vue (2)

Line range hint 44-53: LGTM! Clean implementation of the fixed header functionality

The computed headerStyle properly implements the fixed header functionality:

• Conditionally applies sticky positioning
• Correctly integrates with the header mode preference
• Maintains proper z-index layering

---

Line range hint 65-85: Verify content height calculations with fixed header

When fixedHeader is true, the header is removed from normal flow (position: sticky), which might affect the calcContentHeight function's calculations. Please verify that autoContentHeight still works correctly when fixedHeader is enabled.