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

Fix/navbar toggle icon #1382

Open dhavalveera opened 2 months ago

dhavalveera commented 2 months ago

Hello,

Currently the NavbarToggle is showing the same Icon even if the Toggle Menu is open or closed, this PR makes the fix for it by adding a default Close Icon as well as extending for the User to modify the close Icon.

Furthermore, there wasn't any documentation for the Navbar for the User to modify the default BarIcon to the custom Icon, this PR fixes that issue as well by adding the Example in the Documentation for using the Custom BarIcon.

This PR helps the User to use the Custom SVG Icon instead of relying on the default one (as no documentation was available until this PR) and progressing & extending Navbar properly & make Production Ready

Summary by CodeRabbit

changeset-bot[bot] commented 2 months ago

⚠️ No Changeset found

Latest commit: b61bb93a0a086c2259fcba1ffa0821fa141f58a7

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

Walkthrough

The recent update introduces a custom menu icon feature for a Navbar component within a React application. It includes a new component withCustomMenuIcon that provides personalization in menu icons, various client and server examples, and updates to support custom toggle menu icons in existing NavbarToggle components. This change enhances the user experience by enabling more customization options for the navigation bar's appearance and behavior.

Changes

Files Change Summary
apps/web/content/docs/components/navbar.mdx Added example for using a custom Open Menu/Bar Icon
apps/web/examples/navbar/index.ts Export withCustomMenuIcon
apps/web/examples/navbar/navbar.withCustomMenuIcon.tsx Introduced withCustomMenuIcon component for a Navbar with a custom menu icon
packages/ui/src/components/Navbar/Navbar.stories.tsx Added CustomToggleMenuIconNavbar story
packages/ui/src/components/Navbar/NavbarToggle.tsx Enhanced to support barIcon and closeIcon props toggle functionality

Sequence Diagram(s)

The changes introduce a new feature for customizing menu icons. Below is the sequence diagram for the new functionality:

sequenceDiagram
    participant User
    participant NavbarComponent
    participant CustomIconComponent
    participant ReactIcons

    User->>NavbarComponent: Clicks to open menu
    NavbarComponent->>CustomIconComponent: Request custom icon
    CustomIconComponent->>ReactIcons: Import barIcon (CiMenuFries)
    ReactIcons-->>CustomIconComponent: Provide barIcon
    CustomIconComponent-->>NavbarComponent: Render barIcon
    NavbarComponent-->>User: Display custom menu icon
    User->>NavbarComponent: Clicks to close menu
    NavbarComponent->>CustomIconComponent: Request closeIcon
    CustomIconComponent->>ReactIcons: Import closeIcon
    ReactIcons-->>CustomIconComponent: Provide closeIcon
    CustomIconComponent-->>NavbarComponent: Render closeIcon
    NavbarComponent-->>User: Display close menu icon

Poem

In the code where menus shine, A custom icon, sleek design, With Flowbite's charm and React's grace, Our Navbar has a brand new face. Toggle here and toggle there, Beauty dances through the air! 🌟

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