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: labelPosition support 'auto' #835

Merged

Conversation

gene9831
Copy link
Collaborator

@gene9831 gene9831 commented Sep 30, 2024

English | 简体中文

PR

PR Checklist

Please check if your PR fulfills the following requirements:

  • The commit message follows our Commit Message Guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)
  • Built its own designer, fully self-validated

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • Other... Please describe:

Background and solution

labelPosition decide props panel label position. For example
{9C426332-6680-460F-9922-19F939761F32}

What is the current behavior?

Issue Number: N/A

What is the new behavior?

labelPosition options:

  • auto(new added). Action like left when label is short. Action like top when label is long. It's default value when labelPosition not configured.
    label-auto
  • left
    label-left
  • top
    label-top
  • bottom
    label-bottom
  • none
    label-none

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

Summary by CodeRabbit

  • New Features

    • Enhanced label positioning logic for improved layout flexibility based on widget types.
    • Introduced a new CSS class for better spacing between elements.
  • Bug Fixes

    • Adjusted input field and action icon display to align with updated label positioning.

@github-actions github-actions bot added enhancement New feature or request refactor-main refactor/develop branch feature labels Sep 30, 2024
Copy link
Contributor

coderabbitai bot commented Sep 30, 2024

Walkthrough

The changes involve updates to the ConfigItem.vue component, specifically in the template and script sections. The label positioning logic has been modified to include additional conditions for determining the label's position based on the widget type. A new CSS class has been added to enhance layout spacing, and adjustments have been made to the computed properties to improve responsiveness to different widget configurations.

Changes

File Change Summary
packages/common/component/ConfigItem.vue Updated label positioning logic to include 'CheckBoxConfigurator'; changed default label position to 'auto'; added CSS class gap for layout spacing; adjusted .item-input structure; modified labelPosition computed property.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant ConfigItem
    participant Widget

    User->>ConfigItem: Interacts with component
    ConfigItem->>Widget: Determines label position
    Widget-->>ConfigItem: Returns widget type
    ConfigItem->>ConfigItem: Updates layout based on widget type
    ConfigItem-->>User: Renders updated component
Loading

Poem

🐇 In the meadow where changes bloom,
Labels dance with newfound room.
With gaps that spread like morning light,
Configs now feel just right!
A hop, a skip, a joyful cheer,
For layouts bright, we hold so dear! 🌼


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

🧹 Outside diff range and nitpick comments (2)
packages/common/component/ConfigItem.vue (2)

251-259: LGTM! Consider enhancing readability with early returns.

The changes to the labelPosition computed property successfully implement the new 'auto' label positioning feature as described in the PR objectives. The logic looks correct and aligns with the requirements.

To improve readability, consider using early returns for special cases:

 const labelPosition = computed(() => {
   if (props.property.labelPosition) {
     return props.property.labelPosition
   }

   if (['CheckBoxConfigurator', 'SwitchConfigurator'].includes(props.property.widget?.component)) {
     return 'left'
   }

   if (props.property.widget?.component === 'CodeConfigurator') {
     return 'top'
   }

-  return 'auto'
+  // Default to 'auto' for all other cases
+  return 'auto'
 })

This structure makes it clearer that 'auto' is the default case for all other scenarios.


Line range hint 620-666: LGTM! Consider unifying width calculations for consistency.

The CSS changes successfully implement the layout adjustments needed for the new label positioning options. The use of flex layouts and specific width calculations provides the desired responsiveness and alignment.

For better consistency and maintainability, consider unifying the width calculations for the 'auto' and 'left' classes:

 &.auto {
   flex-wrap: wrap;
   align-items: center;
   .item-label {
     min-width: 30%;
   }
   .item-input {
-    width: calc(70% - 8px);
+    width: 70%;
     flex-grow: 1;
   }
 }
 &.left {
   flex-wrap: wrap;
   align-items: center;
   .item-label {
     width: 30%;
   }
   .item-input {
-    width: calc(70% - 8px);
+    width: 70%;
   }
 }

This change makes the width calculations consistent between 'auto' and 'left' classes, and the gap property added to .item-warp will handle the spacing between elements.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 158310b and db48d3a.

📒 Files selected for processing (1)
  • packages/common/component/ConfigItem.vue (3 hunks)
🔇 Additional comments (1)
packages/common/component/ConfigItem.vue (1)

Line range hint 1-724: Overall, the implementation looks great and achieves the PR objectives.

The changes to the ConfigItem.vue component successfully implement the new 'auto' label positioning feature. The modifications to both the JavaScript logic and CSS styles work together to provide the desired functionality. The code is well-structured and aligns with the requirements outlined in the PR objectives.

A few minor suggestions were provided to enhance readability and consistency, but these are not critical and can be addressed at the developer's discretion.

@hexqi hexqi merged commit e626918 into opentiny:refactor/develop Sep 30, 2024
6 checks passed
yy-wow pushed a commit to yy-wow/tiny-engine that referenced this pull request Oct 10, 2024
@gene9831 gene9831 deleted the refactor/settings-label-position branch October 12, 2024 01:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request refactor-main refactor/develop branch feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants