flowbite-react
flowbite-react copied to clipboard
Fix/dropdown label optional
This commit resolves issue #1402 where the MouseEvent was not being passed through the DropdownItem's onClick handler.
- Updated the DropdownItem component to correctly pass the MouseEvent to the onClick handler.
- This change allows for proper event handling, including scenarios where event propagation needs to be stopped, such as when the dropdown is a descendant of another clickable item.
- Ensured consistency with NavbarLink, which already passes the event through.
By addressing this, we improve the flexibility and usability of the Dropdown component within the UI, enabling better integration with other interactive elements.
Summary by CodeRabbit
- New Features
- The
labelproperty in the Dropdown component is now optional, providing greater flexibility for users. - Enhanced
onClickevent handling in the DropdownItem component, allowing access to the event object during clicks.
- The
These changes improve the usability and interactivity of the Dropdown and DropdownItem components, making them more adaptable for developers.
⚠️ No Changeset found
Latest commit: 8b19b3495a6235f19d089bf9c4452af6934259b8
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
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 | Aug 25, 2024 1:28pm |
| flowbite-react-storybook | ✅ Ready (Inspect) | Visit Preview | 💬 Add feedback | Aug 25, 2024 1:28pm |
Walkthrough
The changes involve modifications to two components within the Dropdown feature. The DropdownProps interface has been updated to make the label property optional, allowing for greater flexibility. Additionally, the DropdownItemProps interface has seen the onClick prop updated to accept a MouseEvent<HTMLElement>, enhancing event handling capabilities. These adjustments impact how developers can interact with and utilize these components.
Changes
| Files | Change Summary |
|---|---|
packages/ui/src/components/Dropdown/Dropdown.tsx, packages/ui/src/components/Dropdown/DropdownItem.tsx |
- label in DropdownProps: changed from required to optional. - onClick in DropdownItemProps: updated to (event: MouseEvent<HTMLElement>) => void. |
Sequence Diagram(s)
sequenceDiagram
participant User
participant Dropdown
participant DropdownItem
User->>Dropdown: Click to open
Dropdown->>DropdownItem: Render items
User->>DropdownItem: Click item
DropdownItem->>DropdownItem: Handle click with event
Poem
🐰 In the land of UI, changes take flight,
Labels now optional, a beautiful sight!
Dropdowns and items, all click with glee,
Events now dance, just wait and see!
Hopping along, we celebrate the cheer,
For flexible components, we’ll give a big cheer! 🎉
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?
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
@coderabbitaiin 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
@coderabbitaiin 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.@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 as PR comments)
@coderabbitai pauseto pause the reviews on a PR.@coderabbitai resumeto resume the paused reviews.@coderabbitai reviewto trigger an incremental review. This is useful when automatic reviews are disabled for the repository.@coderabbitai full reviewto do a full review from scratch and review all the files again.@coderabbitai summaryto regenerate the summary of the PR.@coderabbitai resolveresolve all the CodeRabbit review comments.@coderabbitai configurationto show the current CodeRabbit configuration for the repository.@coderabbitai helpto get help.
Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
CodeRabbit Configuration File (.coderabbit.yaml)
- You can programmatically configure CodeRabbit by adding a
.coderabbit.yamlfile 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.
@khanSoliheen please, check the code format, and rebase it before execute the changelog. But, aside from that, lgtm.