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:(input): label element displays incorrectly #3055

Conversation

devswi
Copy link

@devswi devswi commented May 23, 2024

📝 Description

  1. With labelPlacement set to outside and isMultiline set to true, the label element displays incorrectly.

outside placement

  1. The input element is not centered with the endContent element.

CleanShot 2024-05-23 at 11 25 58@2x

⛳️ Current behavior (updates)

Please describe the current behavior that you are modifying

🚀 New behavior

Please describe the behavior or changes this PR adds

💣 Is this a breaking change (Yes/No):

📝 Additional Information

Summary by CodeRabbit

  • New Features

    • Renamed the isOutsideLeft prop to isLabelOutside for improved labeling consistency.
    • Added a new isMultiline prop for multiline input support.
  • Enhancements

    • Updated label placement logic to consider multiline inputs and start content.
  • Style

    • Refined input component styles for improved layout and appearance.

@devswi devswi requested a review from jrgarciadev as a code owner May 23, 2024 05:18
Copy link

changeset-bot bot commented May 23, 2024

⚠️ No Changeset found

Latest commit: 9b3f8a8

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

vercel bot commented May 23, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
nextui-storybook-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 24, 2024 5:57am

Copy link

vercel bot commented May 23, 2024

@devswi is attempting to deploy a commit to the NextUI Inc Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Contributor

coderabbitai bot commented May 23, 2024

Walkthrough

The recent changes aim to enhance the consistency and functionality of the Input component across different packages. Key modifications include renaming the isOutsideLeft prop to isLabelOutside for clarity. Moreover, the logic for determining label placement has been improved, and styling adjustments have been implemented to enhance the appearance of the component, especially for multiline inputs.

Changes

File Path Change Summary
.../components/input/src/input.tsx Renamed isOutsideLeft prop to isLabelOutside in the InputProps interface for consistency and added support for multiline inputs.
.../components/input/src/use-input.ts Updated label placement logic to consider multiline inputs alongside start content in useInput function.
.../core/theme/src/components/input.ts Adjusted styling classes for the label and innerWrapper to refine layout and appearance in the input component.

Tip

New Features and Improvements

Review Settings

Introduced new personality profiles for code reviews. Users can now select between "Chill" and "Assertive" review tones to tailor feedback styles according to their preferences. The "Assertive" profile posts more comments and nitpicks the code more aggressively, while the "Chill" profile is more relaxed and posts fewer comments.

AST-based Instructions

CodeRabbit offers customizing reviews based on the Abstract Syntax Tree (AST) pattern matching. Read more about AST-based instructions in the documentation.

Community-driven AST-based Rules

We are kicking off a community-driven initiative to create and share AST-based rules. Users can now contribute their AST-based rules to detect security vulnerabilities, code smells, and anti-patterns. Please see the ast-grep-essentials repository for more information.

New Static Analysis Tools

We are continually expanding our support for static analysis tools. We have added support for biome, hadolint, and ast-grep. Update the settings in your .coderabbit.yaml file or head over to the settings page to enable or disable the tools you want to use.

Tone Settings

Users can now customize CodeRabbit to review code in the style of their favorite characters or personalities. Here are some of our favorite examples:

  • Mr. T: "You must talk like Mr. T in all your code reviews. I pity the fool who doesn't!"
  • Pirate: "Arr, matey! Ye must talk like a pirate in all yer code reviews. Yarrr!"
  • Snarky: "You must be snarky in all your code reviews. Snark, snark, snark!"

Revamped Settings Page

We have redesigned the settings page for a more intuitive layout, enabling users to find and adjust settings quickly. This change was long overdue; it not only improves the user experience but also allows our development team to add more settings in the future with ease. Going forward, the changes to .coderabbit.yaml will be reflected in the settings page, and vice versa.

Miscellaneous

  • Turn off free summarization: You can switch off free summarization of PRs opened by users not on a paid plan using the enable_free_tier setting.
  • Knowledge-base scope: You can now set the scope of the knowledge base to either the repository (local) or the organization (global) level using the knowledge_base setting. In addition, you can specify Jira project keys and Linear team keys to limit the knowledge base scope for those integrations.
  • High-level summary placement: You can now customize the location of the high-level summary in the PR description using the high_level_summary_placeholder setting (default @coderabbitai summary).
  • Revamped request changes workflow: You can now configure CodeRabbit to auto-approve or request changes on PRs based on the review feedback using the request_changes_workflow setting.

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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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: 2

Review Details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits Files that changed from the base of the PR and between 540aa21 and e2ba455.
Files selected for processing (3)
  • packages/components/input/src/input.tsx (3 hunks)
  • packages/components/input/src/use-input.ts (1 hunks)
  • packages/core/theme/src/components/input.ts (3 hunks)
Files skipped from review due to trivial changes (1)
  • packages/core/theme/src/components/input.ts
Additional comments not posted (1)
packages/components/input/src/use-input.ts (1)

241-241: Clarify the logic for determining isLabelOutside.

This change adds isMultiline to the condition for setting isLabelOutside. Ensure that this change is reflected wherever isLabelOutside is used to maintain consistency.

Verification successful

The logic for determining isLabelOutside has been updated to include isMultiline in the condition. This change is reflected consistently in the relevant parts of the codebase.

  • use-input.ts: The condition for isLabelOutside now includes isMultiline.
  • input.tsx: The usage of isLabelOutside aligns with the updated logic.
Scripts Executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Description: Verify the logic for `isLabelOutside`.

# Test: Search for usage of `isLabelOutside` in the project to ensure it aligns with the new logic.
rg --type typescript $'isLabelOutside' --files-with-matches

Length of output: 93



Script:

#!/bin/bash
# Description: Verify the logic for `isLabelOutside`.

# Test: Search for usage of `isLabelOutside` in the project to ensure it aligns with the new logic.
rg --type ts 'isLabelOutside'

Length of output: 575



Script:

#!/bin/bash
# Extract relevant lines from `use-input.ts` and `input.tsx` to verify the logic for `isLabelOutside`.

# Extract lines from `use-input.ts`
rg --type ts --context 5 'isLabelOutside' packages/components/input/src/use-input.ts

# Extract lines from `input.tsx`
rg --type ts --context 5 'isLabelOutside' packages/components/input/src/input.tsx

Length of output: 1625

packages/components/input/src/input.tsx Outdated Show resolved Hide resolved
packages/components/input/src/input.tsx Outdated Show resolved Hide resolved
@devswi devswi changed the title fix:(input): label placement incorrect when is multiline is true fix:(input): label element displays incorrectly May 23, 2024
@wingkwong wingkwong self-assigned this May 23, 2024
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

Review Details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits Files that changed from the base of the PR and between e2ba455 and 7fe769d.
Files selected for processing (1)
  • .changeset/perfect-rocks-call.md (1 hunks)
Files skipped from review due to trivial changes (1)
  • .changeset/perfect-rocks-call.md

Copy link
Member

@wingkwong wingkwong left a comment

Choose a reason for hiding this comment

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

The label placement for outside is incorrect in your PR. (isMultiline = False)

canary branch
image

your PR
image

@wingkwong wingkwong assigned devswi and unassigned wingkwong May 23, 2024
@devswi devswi marked this pull request as draft May 24, 2024 01:51
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: 3

Outside diff range and nitpick comments (5)
packages/components/input/src/input.tsx (2)

Line range hint 38-38: Add endContent to the dependency array of the useMemo hook.

-  }, [isClearable, getClearButtonProps]);
+  }, [isClearable, getClearButtonProps, endContent]);

This change ensures that the memoized value correctly updates when endContent changes.


Line range hint 78-78: Refine the dependency array of the useMemo hook for mainWrapper.

-  }, [
-    labelPlacement,
-    helperWrapper,
-    shouldLabelBeOutside,
-    labelContent,
-    innerWrapper,
-    errorMessage,
-    description,
-    getMainWrapperProps,
-    getInputWrapperProps,
-    getErrorMessageProps,
-    getDescriptionProps,
-  ]);
+  }, [
+    shouldLabelBeOutside,
+    isMultiline,
+    isOutsideLeft,
+    labelContent,
+    innerWrapper,
+    helperWrapper,
+    getMainWrapperProps,
+    getInputWrapperProps,
+  ]);

This adjustment removes unnecessary dependencies and adds missing ones to ensure the hook re-evaluates correctly when relevant data changes.

packages/components/input/src/use-input.ts (3)

Line range hint 151-151: Add domRef.current?.focus to the dependency array of the useCallback hook for handleClear.

-  }, [setInputValue, onClear]);
+  }, [setInputValue, onClear, domRef.current?.focus]);

This change ensures that the callback is updated if the focus method on the DOM reference changes, which is important for maintaining correct behavior in dynamic DOM environments.


Line range hint 246-246: Refine the dependency array of the useMemo hook for slots.

-  }, [
-    objectToDeps(variantProps),
-    isInvalid,
-    labelPlacement,
-    isClearable,
-    hasStartContent,
-    disableAnimation,
-  ]);
+  }, [
+    variantProps,
+    isInvalid,
+    labelPlacement,
+    isClearable,
+    disableAnimation,
+  ]);

This adjustment removes unnecessary dependencies and ensures that the hook re-evaluates correctly when relevant data changes.


Line range hint 328-328: Ensure domRef is included in the dependency array for the getInputWrapperProps hook.

-  }, [slots, isHovered, isFocusVisible, isFocused, inputValue, classNames?.inputWrapper]);
+  }, [slots, isHovered, isFocusVisible, isFocused, inputValue, classNames?.inputWrapper, domRef]);

This change ensures that the hook re-evaluates correctly when the domRef changes, which is crucial for maintaining correct behavior.

Review Details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits Files that changed from the base of the PR and between 7fe769d and 9b3f8a8.
Files selected for processing (3)
  • packages/components/input/src/input.tsx (2 hunks)
  • packages/components/input/src/use-input.ts (1 hunks)
  • packages/core/theme/src/components/input.ts (2 hunks)
Files skipped from review as they are similar to previous changes (1)
  • packages/core/theme/src/components/input.ts
Additional Context Used
Biome (25)
packages/components/input/src/input.tsx (5)

4-5: Some named imports are only used as types.


38-38: This hook does not specify all of its dependencies: endContent


78-78: This hook does not specify all of its dependencies: isMultiline


78-78: This hook does not specify all of its dependencies: isOutsideLeft


78-78: This hook specifies more dependencies than necessary: labelPlacement, errorMessage, description, getErrorMessageProps, getDescriptionProps

packages/components/input/src/use-input.ts (20)

145-145: Forbidden non-null assertion.


3-9: Some named imports are only used as types.


10-11: All these imports are only used as types.


17-18: Some named imports are only used as types.


151-151: This hook does not specify all of its dependencies: domRef.current?.focus


246-246: This hook does not specify all of its dependencies: variantProps


246-246: This hook specifies more dependencies than necessary: objectToDeps(variantProps), hasStartContent


265-265: This hook does not specify all of its dependencies: baseDomRef


328-328: This hook does not specify all of its dependencies: domRef


328-328: This hook specifies more dependencies than necessary: inputValue, originalProps.isRequired


371-371: This hook does not specify all of its dependencies: domRef.current


371-371: This hook does not specify all of its dependencies: hoverProps


371-371: This hook specifies more dependencies than necessary: inputValue


371-371: This hook does not specify all of its dependencies: isFilled


371-371: This hook does not specify all of its dependencies: domRef.current.focus


371-371: This hook does not specify all of its dependencies: inputWrapperRef


397-397: This hook does not specify all of its dependencies: domRef.current


397-397: This hook does not specify all of its dependencies: domRef.current.focus


397-397: This hook does not specify all of its dependencies: innerWrapperRef


442-442: This hook does not specify all of its dependencies: descriptionProps

packages/components/input/src/input.tsx Show resolved Hide resolved
packages/components/input/src/input.tsx Show resolved Hide resolved
packages/components/input/src/use-input.ts Show resolved Hide resolved
@devswi
Copy link
Author

devswi commented May 24, 2024

The label placement for outside is incorrect in your PR. (isMultiline = False)

canary branch image

your PR image

@wingkwong Sorry for the late reply, it was my fault for not fully testing before making the PR. I fixed the error and now the input component looks fine.

CleanShot 2024-05-24 at 14 00 07@2x

@wingkwong wingkwong self-requested a review May 24, 2024 07:30
@wingkwong wingkwong assigned wingkwong and unassigned devswi May 24, 2024
@devswi devswi closed this Jun 3, 2024
@devswi devswi deleted the bugfix/input-label-placement-incorrect-when-isMultiline-is-true branch June 4, 2024 08:11
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.

None yet

2 participants