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

chore: remove useless fixedHeader prop for Page #5069

Merged
merged 1 commit into from
Dec 7, 2024

Conversation

mynetfan
Copy link
Collaborator

@mynetfan mynetfan commented Dec 7, 2024

Description

移除Page组件中已经无用的fixedHeader属性

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

Release Notes

  • Documentation

    • Updated the Page component documentation to reflect the removal of the fixedHeader property.
  • New Features

    • Enhanced layout flexibility in the Page component by removing the fixedHeader property, streamlining the component's props and style calculations.
  • Improvements

    • Adjusted template structure in the Page component for better layout management.
    • Improved form handling in the basic form example with responsive tab management.
  • Bug Fixes

    • Removed the fixed-header attribute from the modal examples to ensure consistent layout behavior.

@mynetfan mynetfan requested review from anncwb, vince292007 and a team as code owners December 7, 2024 15:04
Copy link

changeset-bot bot commented Dec 7, 2024

⚠️ No Changeset found

Latest commit: 6536921

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 Dec 7, 2024

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 pull request involves the removal of the fixedHeader property from the Page component across several files. This change is reflected in the documentation, where the property is no longer listed, and in the component code, where related logic and style computations have been simplified. The updates also include adjustments to the template structure in various example files, ensuring that the layout remains functional without the fixedHeader attribute.

Changes

File Path Change Summary
docs/src/components/layout-ui/page.md Removed fixedHeader property from documentation; other props remain unchanged.
packages/effects/common-ui/src/components/page/page.vue Removed fixedHeader from Props interface; eliminated related logic in headerStyle and updated contentStyle.
playground/src/views/examples/form/basic.vue Removed fixed-header attribute from <Page> component; streamlined form handling and layout management.
playground/src/views/examples/modal/index.vue Removed fixed-header attribute from <Page> component; preserved overall structure and functionality.

Possibly related PRs

Suggested reviewers

  • anncwb
  • vince292007

Poem

In the land of code where rabbits hop,
The fixedHeader property took a drop.
With templates sleek and props refined,
We dance through layouts, all aligned.
Hooray for changes, let’s give a cheer,
For a simpler Page, let’s all draw near! 🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between daf83e3 and 6536921.

📒 Files selected for processing (4)
  • docs/src/components/layout-ui/page.md (0 hunks)
  • packages/effects/common-ui/src/components/page/page.vue (5 hunks)
  • playground/src/views/examples/form/basic.vue (0 hunks)
  • playground/src/views/examples/modal/index.vue (0 hunks)
💤 Files with no reviewable changes (3)
  • playground/src/views/examples/modal/index.vue
  • docs/src/components/layout-ui/page.md
  • playground/src/views/examples/form/basic.vue
🔇 Additional comments (4)
packages/effects/common-ui/src/components/page/page.vue (4)

4-4: Import path needs to be updated to match the actual constant location

The constant CSS_VARIABLE_LAYOUT_CONTENT_HEIGHT is imported from @vben-core/shared/constants but should be imported from @core/base/shared/src/constants/globals.ts.


Line range hint 7-17: LGTM! Clean Props interface

The removal of the fixedHeader prop aligns with the PR objective, and the remaining props are well-documented.


74-91: LGTM! Improved template structure

The changes enhance the layout by:

  • Adding proper border styling to replace the fixed header functionality
  • Using flex-auto for better content distribution
  • Maintaining clean slot organization

Line range hint 31-40: Verify the content height calculation

The height calculation has been simplified to use CSS_VARIABLE_LAYOUT_CONTENT_HEIGHT. Please ensure this works correctly with different content sizes and screen heights.

✅ Verification successful

Height calculation is correctly implemented and consistent with the layout system

The verification shows that:

  • The CSS variable CSS_VARIABLE_LAYOUT_CONTENT_HEIGHT is properly defined in the shared constants
  • The height calculation is consistent with the layout system's usage pattern
  • The variable is used in conjunction with the layout composable (use-layout-style.ts) which manages the layout dimensions
  • The removal of footerHeight from the calculation is valid as the content height is now managed through the CSS variable system
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for other usages of CSS_VARIABLE_LAYOUT_CONTENT_HEIGHT to verify consistency
rg "CSS_VARIABLE_LAYOUT_CONTENT_HEIGHT" --type vue --type ts -A 2

# Search for any height-related calculations that might be affected
rg "calc\(.*height" --type vue -A 2

Length of output: 159


Script:

#!/bin/bash
# Search for other usages of CSS_VARIABLE_LAYOUT_CONTENT_HEIGHT without file type restrictions
rg "CSS_VARIABLE_LAYOUT_CONTENT_HEIGHT" -A 2

# Search for any height-related calculations in vue files (using file extension)
rg "calc\(.*height" "*.vue" -A 2

# Find all vue files that might contain height calculations
fd ".vue$" --exec grep -l "height"

# Look for layout-related constants or variables
rg "CSS_VARIABLE_LAYOUT" -A 2

Length of output: 7629


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

🧹 Outside diff range and nitpick comments (3)
packages/effects/common-ui/src/components/page/page.vue (3)

74-76: Consider improving template indentation.

The class concatenation could be formatted more clearly:

-          'bg-card border-border relative flex items-end border-b px-6 py-4',
-          headerClass,
+         'bg-card border-border relative flex items-end border-b px-6 py-4',
+         headerClass,

36-39: Remove commented code.

The commented overflow-y style should be removed if it's no longer needed.

-      // 'overflow-y': shouldAutoHeight.value?'auto':'unset',

Line range hint 51-54: Consider documenting the setTimeout usage.

The 30ms delay in shouldAutoHeight assignment might need explanation for future maintainers.

+  // Allow time for the DOM to stabilize before enabling auto-height
   setTimeout(() => {
     shouldAutoHeight.value = true;
   }, 30);
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between bac0275 and daf83e3.

📒 Files selected for processing (4)
  • docs/src/components/layout-ui/page.md (0 hunks)
  • packages/effects/common-ui/src/components/page/page.vue (5 hunks)
  • playground/src/views/examples/form/basic.vue (0 hunks)
  • playground/src/views/examples/modal/index.vue (0 hunks)
💤 Files with no reviewable changes (3)
  • playground/src/views/examples/modal/index.vue
  • docs/src/components/layout-ui/page.md
  • playground/src/views/examples/form/basic.vue
🔇 Additional comments (2)
packages/effects/common-ui/src/components/page/page.vue (2)

79-91: LGTM! Improved layout structure with flex container.

The addition of flex-auto wrapper improves content distribution and maintains proper layout after removing fixedHeader.


Line range hint 7-17: Verify removal of fixedHeader references.

The Props interface changes look good. Let's verify no other references remain:

✅ Verification successful

No remaining references to fixedHeader found in the codebase

The search across all files, specifically Vue and TypeScript files, returned no results, indicating that all references to fixedHeader have been successfully removed from the codebase. This confirms that the Props interface changes are complete and consistent with the rest of the codebase.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check for any remaining fixedHeader references in the codebase
rg -i "fixedHeader" --type vue --type ts

Length of output: 68


Script:

#!/bin/bash
# Search for fixedHeader references in all files
rg -i "fixedHeader"

Length of output: 19


Script:

#!/bin/bash
# Find all Vue files and search for fixedHeader
fd -e vue -x rg -i "fixedHeader" {}

Length of output: 37


Script:

#!/bin/bash
# Find all TypeScript files and search for fixedHeader
fd -e ts -x rg -i "fixedHeader" {}

Length of output: 36

packages/effects/common-ui/src/components/page/page.vue Outdated Show resolved Hide resolved
@mynetfan mynetfan force-pushed the chore/page-fixed-header branch from daf83e3 to 6536921 Compare December 7, 2024 15:18
@mynetfan mynetfan merged commit 3737666 into vbenjs:main Dec 7, 2024
14 checks passed
@mynetfan mynetfan deleted the chore/page-fixed-header branch December 7, 2024 15:26
@anncwb anncwb added the chore label Dec 11, 2024
@coderabbitai coderabbitai bot mentioned this pull request Dec 11, 2024
16 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants