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

🎨 Use InputType #231

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

🎨 Use InputType #231

wants to merge 1 commit into from

Conversation

FelixLgr
Copy link
Collaborator

@FelixLgr FelixLgr commented Dec 16, 2024

Summary by CodeRabbit

  • New Features

    • Improved type safety in the Input component by using an enum for input types.
    • Enhanced handling of icons based on input type, ensuring correct display.
  • Bug Fixes

    • Resolved cursor jump issues during input for specific types.
  • Documentation

    • Updated interface and component signatures for clarity.

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

coderabbitai bot commented Dec 16, 2024

Walkthrough

The pull request focuses on refactoring the Input component in packages/react/components/input/Input.tsx. The primary change involves transitioning from string literals to using the InputType enum for input type handling. This modification enhances type safety and consistency in the component's implementation. The changes preserve the existing functionality while improving the type-level semantics of the input type management, with updates to class assignments, icon rendering, and event handling logic.

Changes

File Change Summary
packages/react/components/input/Input.tsx - Replaced string literals with InputType enum for input types
- Updated wrapperClasses and controlClasses to use enum-based conditionals
- Modified IconWrapper props handling with enum-based attribute assignment
- Preserved existing event handling logic with enum-based type references

Suggested labels

enhancement

Suggested reviewers

  • JulienMora

Possibly related PRs

Poem

🐰 A rabbit's ode to type-safe delight,
Enums dancing with inputs so bright,
No more string literals astray,
Type safety leads the coding way!
Hop, hop, hurrah for clean code's might! 🔍

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

🧹 Nitpick comments (4)
packages/react/components/input/Input.tsx (4)

129-129: Consider extracting class conditions into a separate utility function.

The class assignments using clsx could be made more maintainable by extracting the conditions into a dedicated utility function.

+const getInputClasses = (type: InputType, hasIcon: boolean, iconNameRight?: string, iconNameLeft?: string) => ({
+  'has-icons-right': hasIcon ?? (iconNameRight || type === InputType.PASSWORD),
+  'has-icons-left': iconNameLeft || type === InputType.SEARCH
+})

 const controlClasses = hashClass(
   styled,
-  clsx('control', {
-    [has('icons-right')]: hasIcon ?? (iconNameRight || type === InputType.PASSWORD),
-    [has('icons-left')]: iconNameLeft || type === InputType.SEARCH,
-  }),
+  clsx('control', getInputClasses(type, hasIcon, iconNameRight, iconNameLeft)),
 )

Also applies to: 137-138


Line range hint 302-315: Simplify password visibility toggle logic.

The password visibility toggle could be simplified by using a single state variable and deriving the input type from it.

-const [inputType, setInputType] = useState<InputType | InputTypeValues>(type)
-const [isShowPwd, setIsShowPwd] = useState<boolean>(false)
+const [showPassword, setShowPassword] = useState<boolean>(false)
+const effectiveInputType = type === InputType.PASSWORD && showPassword ? InputType.TEXT : type

 {!loading && type === InputType.PASSWORD && (
   <IconWrapper
     className='icon-right'
-    name={isShowPwd ? IconName.EYE_SLASH : IconName.EYE}
-    onPress={() => {
-      if (inputType === InputType.PASSWORD) {
-        setInputType(InputType.TEXT)
-        setIsShowPwd(true)
-      } else {
-        setInputType(InputType.PASSWORD)
-        setIsShowPwd(false)
-      }
-    }}
+    name={showPassword ? IconName.EYE_SLASH : IconName.EYE}
+    onPress={() => setShowPassword(!showPassword)}
   />
 )}

321-323: Add error boundary for InputGauge component.

Consider wrapping the InputGauge component with an error boundary to gracefully handle any validation rule parsing errors.

+const InputGaugeWithErrorBoundary = ({ validationRules, styled, inputValue }) => (
+  <ErrorBoundary fallback={<Text level={TextLevels.TWO}>Unable to display password strength</Text>}>
+    <InputGauge validationRules={validationRules} styled={styled} inputValue={inputValue} />
+  </ErrorBoundary>
+)

-{securityGauge && type === InputType.PASSWORD && (
-  <InputGauge validationRules={validationRules} styled={styled} inputValue={_value} />
-)}
+{securityGauge && type === InputType.PASSWORD && (
+  <InputGaugeWithErrorBoundary
+    validationRules={validationRules}
+    styled={styled}
+    inputValue={_value}
+  />
+)}

Line range hint 214-223: Extract required field indicator into a reusable component.

Consider creating a reusable component for the required field indicator to maintain consistency across forms.

+const RequiredFieldIndicator = () => (
+  <Text markup={TextMarkup.SPAN} typo={TypographyColor.TEXT_ERROR}>
+    *
+  </Text>
+)

 {label && (
   <label className='input-label'>
-    {label}{' '}
-    {required && (
-      <Text markup={TextMarkup.SPAN} typo={TypographyColor.TEXT_ERROR}>
-        *
-      </Text>
-    )}
+    {label}{' '}{required && <RequiredFieldIndicator />}
   </label>
 )}
📜 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 24ff732.

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

Line range hint 1-328: Overall implementation looks good! 👍

The migration from string literals to InputType enum improves type safety while maintaining backward compatibility. The suggested refactors above are optional improvements that could enhance maintainability and reusability.

@FelixLgr FelixLgr changed the title 🎨 use InputType 🎨 Use InputType Dec 16, 2024
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