nextui icon indicating copy to clipboard operation
nextui copied to clipboard

docs(card, badge): slots section addition

Open awesome-pro opened this issue 1 year ago • 3 comments

Closes #3233

📝 Description

Added the missing Slots section

⛳️ Current behavior (updates)

Please describe the current behavior that you are modifying

🚀 New behavior

Card Addition Screenshot 2024-07-30 at 8 30 43 PM

Badge Addition Screenshot 2024-07-30 at 8 31 30 PM

💣 Is this a breaking change (Yes/No): NO

📝 Additional Information

Summary by CodeRabbit

  • Bug Fixes

    • Fixed the navbar height issue when using the h-full class, improving layout and usability.
  • Documentation

    • Added a "Slots" section to the Badge component documentation, detailing the base and badge slots for better clarity.
    • Introduced a "Slots" section in the Card component documentation, outlining the base, header, body, and footer slots to enhance understanding of the component structure.

awesome-pro avatar Jul 30 '24 15:07 awesome-pro

⚠️ No Changeset found

Latest commit: 0424f0ca3f76191ccd7b6e88e2a56720b3a71953

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

changeset-bot[bot] avatar Jul 30 '24 15:07 changeset-bot[bot]

@abhinandan-verma is attempting to deploy a commit to the NextUI Inc Team on Vercel.

A member of the Team first needs to authorize it.

vercel[bot] avatar Jul 30 '24 15:07 vercel[bot]

Walkthrough

This update provides enhancements to the documentation for the Badge and Card components by adding a "Slots" section that clarifies their structure. It also includes a patch for the @nextui-org/theme package, fixing the navbar height issue when the h-full class is applied. These changes improve usability and ensure better understanding for developers, maintaining consistent design and functionality across components.

Changes

File Path Change Summary
.changeset/brown-days-applaud.md Fixed navbar height issue in @nextui-org/theme, improving layout and usability when using h-full class.
apps/docs/content/docs/components/*.mdx Added "Slots" sections to the documentation for Badge and Card components, detailing the structure and purpose of their respective slots.

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

coderabbitai[bot] avatar Jul 30 '24 15:07 coderabbitai[bot]