search

themesberg / flowbite-react

Official React components built for Flowbite and Tailwind CSS
https://flowbite-react.com
MIT License
1.77k stars 395 forks source link

feat: make tooltips stay open #1383

Open brenoliradev opened 2 months ago

brenoliradev commented 2 months ago

Hey,

I'm pretending to be more active again giving contributions to flow-bite. It has some time from my last contributions so I'm feeling a little ankward about the standards of this project lol

Just picked up #1257 and gave it a shot. To summarize, I'm adding the possibility to override the open/closed status for tooltips:

image

I implemented it in a simple way, just added a new prop called "isOpen" that overrides the "open" state - now called innerOpen. Since he also wanted to change it's trigger, I made it's default to "null" and did a simple check to ensure that it would work as expected when true or false.

Tbh idk if it's a valid way to do it here at flow-bite so let's discuss about it. :)

Cheers,

Summary by CodeRabbit

changeset-bot[bot] commented 2 months ago

⚠️ No Changeset found

Latest commit: d3987e22386537746eb6676eb5086957bc760038

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] commented 2 months ago

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 Apr 30, 2024 11:14am
flowbite-react-storybook ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 30, 2024 11:14am
coderabbitai[bot] commented 2 months ago

Walkthrough

This update enhances tooltip functionality by introducing control over the open state of tooltips, enabling them to be permanently open or closed. The changes include new examples in the UI documentation and adjustments to the tooltip components to support this feature.

Changes

File Path Change Summary
src/docs/pages/TooltipsPage.tsx Added examples for always open/closed tooltips.
src/lib/components/Floating/... Added isOpen prop to control the open state.
src/lib/components/Tooltip/... Added isOpen boolean property to TooltipProps.

Possibly related issues

Poem

🐇 Oh hop and tweak, the code does peak, 🌟
With props anew, the tooltips speak.
Open or closed, they now can stay,
A rabbit's touch, makes UI sway.
🎉 Celebrate, for bugs we shoo,
With every line, the features grew!

Recent Review Details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between 2afa3c8fcd8deabc511003fb7f15e71e221f3798 and d3987e22386537746eb6676eb5086957bc760038.
Files selected for processing (3) * packages/ui/src/components/Floating/Floating.tsx (3 hunks) * packages/ui/src/components/Tooltip/Tooltip.stories.tsx (1 hunks) * packages/ui/src/components/Tooltip/Tooltip.tsx (3 hunks)
Files skipped from review due to trivial changes (1) * packages/ui/src/components/Tooltip/Tooltip.stories.tsx
Additional comments not posted (6)
packages/ui/src/components/Tooltip/Tooltip.tsx (3)
`18-18`: The addition of `isOpen` as an optional property in `TooltipProps` is well-implemented and aligns with the PR's objectives. --- `34-34`: The default assignment of `isOpen` to `null` and its subsequent usage in the `Tooltip` component are correctly implemented to support both controlled and uncontrolled modes. --- `49-49`: Passing the `isOpen` prop to the `Floating` component is correctly implemented, ensuring that the tooltip's visibility can be externally controlled as intended.
packages/ui/src/components/Floating/Floating.tsx (3)
`46-46`: The addition of `isOpen` as an optional property in `FloatingProps` is well-implemented and aligns with the PR's objectives. --- `63-63`: The default assignment of `isOpen` to `null` in the `Floating` component is correctly implemented to support both controlled and uncontrolled modes. --- `69-73`: The logic to determine the `open` state in the `Floating` component is well-implemented, using `useMemo` to efficiently handle changes in the `isOpen` prop and support both controlled and uncontrolled modes.
--- 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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
SutuSebastian commented 2 months ago

it seems like ur branch base HEAD is way out of date, leading to massive conflicts.

Please sync ur fork with latest themesberg:main and then rework/reopen this PR, its easier this way.

brenoliradev commented 2 months ago

Yeah. I just noticed it yesterday.

I was using my outdated main (on my personal repo) instead of upstream main.

Just fixed it!