Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(drawer) - examples cleanup #1374

Merged
merged 1 commit into from
Apr 17, 2024
Merged

docs(drawer) - examples cleanup #1374

merged 1 commit into from
Apr 17, 2024

Conversation

SutuSebastian
Copy link
Collaborator

@SutuSebastian SutuSebastian commented Apr 17, 2024

Changes

  • remove examples codeRSC due to being a client component only (controlled)
  • use iframe and remove workaround wrapper

Summary by CodeRabbit

  • Refactor

    • Enhanced the drawer components across various examples for improved performance and usability.
    • Simplified the component structure and import statements for better maintainability.
    • Standardized component naming and export methods to align with updated API usage.
  • Style

    • Removed theme customization from drawer components to ensure consistency in design across the platform.
  • Documentation

    • Updated component documentation to reflect changes in structure and usage.

@SutuSebastian SutuSebastian added the 📚 documentation Improvements or additions to documentation label Apr 17, 2024
@SutuSebastian SutuSebastian self-assigned this Apr 17, 2024
Copy link

changeset-bot bot commented Apr 17, 2024

⚠️ No Changeset found

Latest commit: 99cb61d

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

Copy link

vercel bot commented Apr 17, 2024

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 17, 2024 10:22am
flowbite-react-storybook 🛑 Canceled (Inspect) Apr 17, 2024 10:22am

Copy link
Contributor

coderabbitai bot commented Apr 17, 2024

Walkthrough

The recent changes across various drawer component examples focus on streamlining import statements, aligning component usage with the latest API, and eliminating unnecessary code and theme configurations. These updates are geared towards improving code readability, maintainability, and adherence to contemporary component structuring practices.

Changes

Files Change Summary
drawer.backdrop.tsx, drawer.noBackdrop.tsx Updated import statements and component structures, removed redundant code.
drawer.bodyScrolling.tsx, drawer.noBodyScrolling.tsx Simplified imports, refactored component exports, updated Drawer structure.
drawer.bottom.tsx, drawer.contactForm.tsx, drawer.formElements.tsx, drawer.left.tsx, drawer.navigation.tsx, drawer.right.tsx, drawer.root.tsx, drawer.swipeableEdge.tsx, drawer.top.tsx Standardized usage of Drawer.Header and Drawer.Items, eliminated theme configurations, and refined exports.

🐰✨
In the realm of code where drawers gracefully glide,
A rabbit hopped by with a refactor's pride.
Cleaned up imports, structures agleam,
In the coder's world, a simplified dream.
Hop, hop, hooray for clarity's beam!
🌟🐇


Recent Review Details

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 92cec6f and 99cb61d.
Files selected for processing (13)
  • apps/web/examples/drawer/drawer.backdrop.tsx (7 hunks)
  • apps/web/examples/drawer/drawer.bodyScrolling.tsx (8 hunks)
  • apps/web/examples/drawer/drawer.bottom.tsx (6 hunks)
  • apps/web/examples/drawer/drawer.contactForm.tsx (6 hunks)
  • apps/web/examples/drawer/drawer.formElements.tsx (7 hunks)
  • apps/web/examples/drawer/drawer.left.tsx (6 hunks)
  • apps/web/examples/drawer/drawer.navigation.tsx (7 hunks)
  • apps/web/examples/drawer/drawer.noBackdrop.tsx (7 hunks)
  • apps/web/examples/drawer/drawer.noBodyScrolling.tsx (7 hunks)
  • apps/web/examples/drawer/drawer.right.tsx (6 hunks)
  • apps/web/examples/drawer/drawer.root.tsx (6 hunks)
  • apps/web/examples/drawer/drawer.swipeableEdge.tsx (9 hunks)
  • apps/web/examples/drawer/drawer.top.tsx (6 hunks)
Files skipped from review as they are similar to previous changes (13)
  • apps/web/examples/drawer/drawer.backdrop.tsx
  • apps/web/examples/drawer/drawer.bodyScrolling.tsx
  • apps/web/examples/drawer/drawer.bottom.tsx
  • apps/web/examples/drawer/drawer.contactForm.tsx
  • apps/web/examples/drawer/drawer.formElements.tsx
  • apps/web/examples/drawer/drawer.left.tsx
  • apps/web/examples/drawer/drawer.navigation.tsx
  • apps/web/examples/drawer/drawer.noBackdrop.tsx
  • apps/web/examples/drawer/drawer.noBodyScrolling.tsx
  • apps/web/examples/drawer/drawer.right.tsx
  • apps/web/examples/drawer/drawer.root.tsx
  • apps/web/examples/drawer/drawer.swipeableEdge.tsx
  • apps/web/examples/drawer/drawer.top.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
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 SutuSebastian merged commit 7ddef82 into main Apr 17, 2024
8 checks passed
@SutuSebastian SutuSebastian deleted the cleanup/drawer branch April 17, 2024 10:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📚 documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant