Fix/navbar toggle icon

[dhavalveera]

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

• New Features
  • Introduced a customizable menu icon option for the navbar, allowing users to switch between different icons for open and close states.
  • Added documentation and examples for implementing a custom menu icon in the navbar.

[changeset-bot]

⚠️ No Changeset found

Latest commit: f70c8c2

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]

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 29, 2024 11:58am
flowbite-react-storybook	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Apr 29, 2024 11:58am

[coderabbitai]

Walkthrough

The update brings a customizable menu icon feature to the navbar component in the web app, showcasing how to integrate a custom toggle icon using Flowbite-React components. The NavbarToggle now offers improved functionality for toggling between open and close icons, enhancing user interaction.

Changes

File Path	Change Summary
.../docs/components/navbar.mdx	Added a new example for using a custom Open Menu/Bar Icon in the navbar component.
.../examples/navbar/index.ts	Exported withCustomMenuIcon.
.../examples/navbar/navbar.withCustomMenuIcon.tsx	Introduced withCustomMenuIcon component with custom icons and links.
.../components/Navbar/Navbar.stories.tsx	Added CustomToggleMenuIconNavbar with CiMenuFries icon.
.../components/Navbar/NavbarToggle.tsx	Added closeIcon prop; improved icon toggling functionality.

🐰✨
In the land of code, where the bits align,
A rabbit hopped, leaving changes behind.
Custom icons dance, on navbars they prance,
A toggle, a flick, enhancing the glance.
Cheers to the devs, with each commit they thrive,
In the digital burrow, where creativity's alive. 🌟
🐰✨

---

Recent Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 11dcc4d and f70c8c2.

Files selected for processing (1)

• apps/web/examples/navbar/navbar.withCustomMenuIcon.tsx (1 hunks)

Files skipped from review as they are similar to previous changes (1)

• apps/web/examples/navbar/navbar.withCustomMenuIcon.tsx

---

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