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

fix: form required style adjustment #4668

Merged
merged 1 commit into from
Oct 17, 2024
Merged

fix: form required style adjustment #4668

merged 1 commit into from
Oct 17, 2024

Conversation

anncwb
Copy link
Collaborator

@anncwb anncwb commented Oct 17, 2024

Description

fixed #4661

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 FormField and FormLabel components for improved layout and flexibility.
    • Conditional rendering added to the authentication header to display logo and app name only when provided.
  • Bug Fixes

    • Improved event handling and value binding in the FormField component.
  • Refactor

    • Updated structure and logic for rendering components across the UI kit for better responsiveness.

@anncwb anncwb added the bug Something isn't working label Oct 17, 2024
Copy link

changeset-bot bot commented Oct 17, 2024

⚠️ No Changeset found

Latest commit: c776e47

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 Oct 17, 2024

Walkthrough

The pull request introduces modifications to three Vue components: form-field.vue, form-label.vue, and authentication.vue. Changes include enhancements to template structures, computed properties, and event handling, particularly in the form-field.vue component where class bindings and value extraction logic have been refined. The form-label.vue component now allows additional class properties, improving flexibility. In authentication.vue, conditional rendering logic has been added to optimize the display of the logo and app name based on their availability.

Changes

File Path Change Summary
packages/@core/ui-kit/form-ui/src/form-render/form-field.vue Updated class binding for FormLabel, refined computedProps, improved fieldBindEvent for event handling, and retained autofocus functionality.
packages/@core/ui-kit/form-ui/src/form-render/form-label.vue Added import for cn utility, updated Props interface to include optional class, and modified template structure for conditional rendering.
packages/effects/layouts/src/authentication/authentication.vue Enhanced conditional rendering for logo and appName, ensuring elements are displayed only when relevant data is provided.

Assessment against linked issues

Objective Addressed Explanation
Correct the position of the required asterisk when layout is vertical (#4661)

Possibly related PRs

Suggested reviewers

  • vince292007

🐇 In the fields where we play,
Asterisks now find their way.
Labels dance with style anew,
Conditional checks, just for you.
With every form, a better sight,
Hop along, our code takes flight! 🌟


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 (1)
packages/effects/layouts/src/authentication/authentication.vue (1)

64-71: Improved conditional rendering for logo and app name

The changes effectively address the layout issues by introducing conditional rendering for the logo and app name section. This enhancement prevents unnecessary DOM elements when both logo and app name are absent, improving the component's efficiency.

Consider adding an aria-label to the logo image for better accessibility:

- <img v-if="logo" :alt="appName" :src="logo" class="mr-2" width="42" />
+ <img v-if="logo" :alt="appName" :src="logo" class="mr-2" width="42" :aria-label="`${appName} logo`" />
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between c432e0a and c776e47.

📒 Files selected for processing (3)
  • packages/@core/ui-kit/form-ui/src/form-render/form-field.vue (1 hunks)
  • packages/@core/ui-kit/form-ui/src/form-render/form-label.vue (1 hunks)
  • packages/effects/layouts/src/authentication/authentication.vue (1 hunks)
🧰 Additional context used
🔇 Additional comments (5)
packages/@core/ui-kit/form-ui/src/form-render/form-label.vue (4)

3-3: LGTM: Import of cn utility function.

The addition of the cn import is appropriate for the class name concatenation used in the template.


6-6: Excellent addition of the class prop.

The new optional class property enhances the component's flexibility, allowing for custom styling from parent components. This change improves the reusability of the FormLabel component and aligns well with the PR's objective of adjusting form styles.


11-11: Good: Improved props declaration for template usage.

The change from defineProps<Props>() to const props = defineProps<Props>() is appropriate. It allows for the use of props within the template, which is necessary for the subsequent template modifications. This change enhances the component's internal structure without altering its behavior.


15-17: Excellent: Template improvements address the PR objective.

The template changes effectively solve the issue of required field indicator positioning:

  1. The use of the cn function in the class attribute (line 15) allows for flexible styling, combining default and custom classes.
  2. Moving the required asterisk before the slot content (lines 16-17) ensures consistent positioning of the indicator, addressing the main objective of this PR.

These modifications improve the component's structure and functionality while maintaining the conditional rendering of both the required asterisk and the help tooltip. Great job on addressing the issue described in #4661!

packages/@core/ui-kit/form-ui/src/form-render/form-field.vue (1)

281-281: LGTM: Improved label alignment for horizontal layouts

The addition of the 'justify-end' class when !isVertical is true improves the alignment of labels in horizontal layouts. This change addresses the inconsistency mentioned in issue #4661 by ensuring that labels (and consequently, required field indicators) are properly aligned to the right in horizontal layouts.

This modification:

  1. Doesn't affect vertical layouts, preserving their current behavior.
  2. Improves consistency between horizontal and vertical layouts.
  3. Aligns with the PR objectives to fix the positioning of required field indicators.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Bug: Form的layout值为vertical时,表单的必填星号位置错误
1 participant