feat: make tooltips stay open #1383

brenoliradev · 2024-04-30T00:28:27Z

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:

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

New Features
- Added examples for always open and always closed tooltips on the Tooltips documentation page.
- Introduced an optional isOpen property for the Floating and Tooltip components to control their visibility state.
Documentation
- Updated the Tooltips documentation page with new examples.

changeset-bot · 2024-04-30T00:28:30Z

⚠️ No Changeset found

Latest commit: d3987e2

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 · 2024-04-30T00:28:31Z

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 · 2024-04-30T00:28:37Z

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

Tooltip should have a flag for "interactive". #1290: The isOpen prop aligns with the request for interactive control over tooltips, enhancing user interaction.
"Open" prop for Tooltip component and option to set trigger to "none" #1257: Addresses the need for an "Open" prop for the Tooltip component, fulfilling the user's requirement to control tooltip visibility programmatically.

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 2afa3c8 and d3987e2.

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

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

SutuSebastian · 2024-04-30T06:15:06Z

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 · 2024-04-30T11:13:14Z

Yeah. I just noticed it yesterday.

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

Just fixed it!

SutuSebastian · 2024-06-19T12:52:02Z

packages/ui/src/components/Floating/Floating.tsx

-  const [open, setOpen] = useState(false);
+  const [innerOpen, setOpen] = useState(false);
+
+  const open = useMemo(() => {


no need to use useMemo() here since its not a heavy calculation or any iteration, we can just stick to a more simplified version:

const [_open, setOpen] = useState(false); const open = isOpen ?? _open;

vercel bot had a problem deploying to Preview – flowbite-react-storybook April 30, 2024 00:28 Failure

vercel bot had a problem deploying to Preview – flowbite-react April 30, 2024 00:28 Failure

vercel bot had a problem deploying to Preview – flowbite-react-storybook April 30, 2024 00:33 Failure

vercel bot had a problem deploying to Preview – flowbite-react April 30, 2024 00:34 Failure

feat: tooltip stay open/closed

d3987e2

brenoliradev force-pushed the feat/stay_open_tooltip branch from e448f51 to d3987e2 Compare April 30, 2024 11:11

vercel bot deployed to Preview – flowbite-react-storybook April 30, 2024 11:12 View deployment

vercel bot deployed to Preview – flowbite-react April 30, 2024 11:14 View deployment

SutuSebastian reviewed Jun 19, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: make tooltips stay open #1383

feat: make tooltips stay open #1383

brenoliradev commented Apr 30, 2024 •

edited by coderabbitai bot

Loading

changeset-bot bot commented Apr 30, 2024 •

edited

Loading

vercel bot commented Apr 30, 2024 •

edited

Loading

coderabbitai bot commented Apr 30, 2024 •

edited

Loading

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

SutuSebastian commented Apr 30, 2024

brenoliradev commented Apr 30, 2024

SutuSebastian Jun 19, 2024

feat: make tooltips stay open #1383

Are you sure you want to change the base?

feat: make tooltips stay open #1383

Conversation

brenoliradev commented Apr 30, 2024 • edited by coderabbitai bot Loading

Summary by CodeRabbit

changeset-bot bot commented Apr 30, 2024 • edited Loading

⚠️ No Changeset found

vercel bot commented Apr 30, 2024 • edited Loading

coderabbitai bot commented Apr 30, 2024 • edited Loading

Walkthrough

Changes

Possibly related issues

Poem

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

SutuSebastian commented Apr 30, 2024

brenoliradev commented Apr 30, 2024

SutuSebastian Jun 19, 2024

Choose a reason for hiding this comment

brenoliradev commented Apr 30, 2024 •

edited by coderabbitai bot

Loading

changeset-bot bot commented Apr 30, 2024 •

edited

Loading

vercel bot commented Apr 30, 2024 •

edited

Loading

coderabbitai bot commented Apr 30, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)