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 iconNameLeft loading #230

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

FelixLgr
Copy link
Collaborator

@FelixLgr FelixLgr commented Dec 16, 2024

Quand l'input est en chargement (loader sur la droite) l'icon de gauche était invisible

Summary by CodeRabbit

  • New Features

    • Streamlined icon rendering logic for improved performance.
    • Enhanced state management to prevent cursor jumps in input fields.
  • Bug Fixes

    • Adjusted event handling to ensure proper state updates and prevent default behaviors.
  • Documentation

    • Maintained clarity in documentation comments for component props.

@FelixLgr FelixLgr self-assigned this Dec 16, 2024
Copy link

coderabbitai bot commented Dec 16, 2024

Walkthrough

The pull request introduces modifications to the Input component in Input.tsx, primarily focusing on simplifying the icon rendering logic. The changes streamline the condition for displaying the left icon by removing the !loading check. The core functionality of the input component remains consistent, with maintained state management, event handling, and accessibility support. The modifications aim to provide a more straightforward approach to rendering icons within the input component.

Changes

File Change Summary
packages/react/components/input/Input.tsx - Simplified left icon rendering condition
- Preserved state management logic
- Maintained event handling mechanisms
- No changes to exported interface or component signature

Possibly related PRs

Suggested reviewers

  • JulienMora

Poem

🐰 A rabbit's ode to Input's new grace,
Where icons dance with simpler embrace,
No loading check to slow the way,
Just clean and swift, a coding play!
Rendering magic, light and bright,
Input component shines so right! 🎉

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request.


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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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

@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 comments (1)
packages/react/components/input/Input.tsx (1)

Line range hint 313-313: Enhance loading indicator accessibility.

The loading indicator should communicate its state to screen readers.

Add appropriate ARIA attributes:

- {loading && <span className={hashClass(styled, clsx(is('searching')))} />}
+ {loading && (
+   <span 
+     className={hashClass(styled, clsx(is('searching')))}
+     role="status"
+     aria-label="Loading"
+   />
+ )}
🧹 Nitpick comments (2)
packages/react/components/input/Input.tsx (2)

Line range hint 298-313: Consider consolidating icon rendering logic.

The current implementation has separate conditions for icon rendering which could be simplified. Consider extracting the icon rendering logic into a separate method to improve maintainability.

Here's a suggested refactor:

- {iconNameLeft && <IconWrapper className={'icon-left'} name={iconNameLeft as unknown as IconName} />}
- {iconNameRight && !loading && type !== 'password' && (
-   <IconWrapper className={'icon-right'} name={iconNameRight as unknown as IconName} />
- )}
- {!loading && type === 'password' && (
-   <IconWrapper
-     className={'icon-right'}
-     name={isShowPwd ? IconName.EYE_SLASH : IconName.EYE}
-     onPress={() => {
-       if (inputType === 'password') {
-         setInputType(InputType.TEXT)
-         setIsShowPwd(true)
-       } else {
-         setInputType(InputType.PASSWORD)
-         setIsShowPwd(false)
-       }
-     }}
-   />
- )}
+ {renderIcon('left', iconNameLeft)}
+ {!loading && renderIcon('right', iconNameRight)}
+ {!loading && type === 'password' && renderPasswordIcon()}

Add these helper methods:

const renderIcon = (position: 'left' | 'right', iconName?: IconName) => {
  if (!iconName) return null;
  return (
    <IconWrapper 
      className={`icon-${position}`} 
      name={iconName as unknown as IconName}
    />
  );
};

const renderPasswordIcon = () => (
  <IconWrapper
    className={'icon-right'}
    name={isShowPwd ? IconName.EYE_SLASH : IconName.EYE}
    onPress={() => {
      setInputType(isShowPwd ? InputType.PASSWORD : InputType.TEXT);
      setIsShowPwd(!isShowPwd);
    }}
  />
);

298-298: Consider type safety improvement for IconName casting.

The current code uses a type assertion as unknown as IconName which could be made more type-safe.

Consider creating a type guard:

const isValidIconName = (name: string): name is IconName => {
  return Object.values(IconName).includes(name as IconName);
};

// Then use it in the render:
{iconNameLeft && isValidIconName(iconNameLeft) && (
  <IconWrapper className={'icon-left'} name={iconNameLeft} />
)}
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 44f4c6f and 727bc98.

📒 Files selected for processing (1)
  • packages/react/components/input/Input.tsx (1 hunks)
🔇 Additional comments (1)
packages/react/components/input/Input.tsx (1)

298-298: LGTM! This change fixes the left icon visibility issue.

The modification correctly separates the left icon rendering logic from loading state checks, ensuring the left icon remains visible when the input is in a loading state.

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.

1 participant