Feat: Add 'onRightIconClick' prop on TextInput

[ahsankhan26]

• [x] I have followed the Your First Code Contribution section of the Contributing guide

Summary

This PR adds a prop on TextInput to support onClick for the right icon. This allows users to easily create password inputs with the use of rightIcon prop.

Demo

Code Example

const PasswordInput = () => {
  const [showPass, setShowPass] = useState(false);

  return (
    <TextInput
      type={showPass ? "text" : "password"}
      rightIcon={showPass ? EyeOffIcon : EyeIcon}
      onRightIconClick={() => setShowPass(!showPass)}
    />
  );
};

Summary by CodeRabbit

• New Features

  • Introduced a new optional prop onRightIconClick for the TextInput component, allowing users to define actions when the right icon is clicked.

• Bug Fixes

  • Improved user experience by preventing clicks on the right icon when no action is defined, enhancing interaction reliability.

• Style

  • Updated styling for the right icon in the TextInput, enhancing its visual integration and functionality.

[changeset-bot[bot]]

⚠️ No Changeset found

Latest commit: 061dc172e917a22ce64b598e935e8050a06f4809

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

[vercel[bot]]

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

Name	Status	Preview	Comments	Updated (UTC)
flowbite-react	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 2, 2024 7:30am
flowbite-react-storybook	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 2, 2024 7:30am

[coderabbitai[bot]]

Walkthrough

The changes introduce a new optional property, onRightIconClick, to the TextInputProps interface, allowing a callback function when the right icon is clicked. The TextInput component is updated to handle this prop, including an event handler for the right icon's container. Additionally, the styling for the right icon is modified to remove the pointer-events-none class, enabling interaction when the callback is defined.

Changes

Files	Change Summary
packages/ui/src/components/TextInput/TextInput.tsx	Added onRightIconClick prop to TextInputProps interface and updated the TextInput component to handle the new prop with an event handler for the right icon.
packages/ui/src/components/TextInput/theme.ts	Modified the rightIcon class in the textInputTheme object by removing the pointer-events-none class, allowing interaction with the right icon.

Poem

In a field where icons play,
A click brings joy, come what may.
With a hop and a skip,
The right icon's tip,
Now dances with purpose, hooray! 🐇✨

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.

[v0x12]

Is there any reason why is this PR not accepted?

[Taoister39]

  /**
   * ! HACK
   * await https://github.com/themesberg/flowbite-react/pull/1492
   */
  const containerRef = useRef<HTMLDivElement>(null);
  useEffect(() => {
    const onRightIconClick = handleOpenFolder;
    if (!onRightIconClick || !containerRef.current) {
      return;
    }

    const rightIcon = containerRef.current.querySelector(
      '[data-testid="right-icon"]',
    )!;

    rightIcon.classList.remove('pointer-events-none');
    rightIcon.classList.add('cursor-pointer');
    rightIcon.addEventListener('click', onRightIconClick);

    return () => {
      rightIcon.removeEventListener('click', onRightIconClick);
    };
  }, [handleOpenFolder]);

This PR allows my previous solution.