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

fix: rename wrapper to tab wrapper #4636

Open
wants to merge 2 commits into
base: canary
Choose a base branch
from

Conversation

winchesHe
Copy link
Member

@winchesHe winchesHe commented Jan 24, 2025

Closes #4552

📝 Description

⛳️ Current behavior (updates)

🚀 New behavior

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

📝 Additional Information

Summary by CodeRabbit

  • Bug Fixes

    • Updated tab wrapper naming convention across components
    • Corrected slot references in tabs configuration
  • Chores

    • Patched dependency @heroui/theme

The changes ensure consistent naming for tab wrapper slots and maintain the overall functionality of the tabs component.

Copy link

linear bot commented Jan 24, 2025

Copy link

vercel bot commented Jan 24, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
heroui ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 24, 2025 2:50pm
heroui-sb ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 24, 2025 2:50pm

Copy link

changeset-bot bot commented Jan 24, 2025

🦋 Changeset detected

Latest commit: 5171be3

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 12 packages
Name Type
@heroui/theme Patch
@heroui/autocomplete Patch
@heroui/checkbox Patch
@heroui/date-input Patch
@heroui/date-picker Patch
@heroui/form Patch
@heroui/input-otp Patch
@heroui/input Patch
@heroui/radio Patch
@heroui/select Patch
@heroui/table Patch
@heroui/react Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Copy link
Contributor

coderabbitai bot commented Jan 24, 2025

Walkthrough

The pull request introduces a minor update to the tabs component across multiple files. The primary change involves renaming the wrapper slot to tabWrapper in the theme configuration and corresponding usage within the tabs hook. This modification appears to be a naming consistency update, affecting the component's slot definitions and how wrapper properties are retrieved. A patch for the "@heroui/theme" dependency is also included.

Changes

File Change Summary
.changeset/dull-ladybugs-whisper.md Patch update for @heroui/theme dependency
packages/components/tabs/src/use-tabs.ts Updated getWrapperProps to use slots.tabWrapper instead of slots.wrapper
packages/core/theme/src/components/tabs.ts Renamed wrapper slot to tabWrapper in component configuration

Sequence Diagram

sequenceDiagram
    participant Theme as Theme Configuration
    participant Hook as Tabs Hook
    participant Component as Tabs Component

    Theme->>Theme: Rename slot from 'wrapper' to 'tabWrapper'
    Hook->>Hook: Update wrapper props retrieval
    Component->>Component: Reflect new slot naming
Loading

The sequence diagram illustrates the simple renaming process across the different layers of the tabs component implementation, showing how the slot name change propagates through the theme configuration, hook, and component.


📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between cddba82 and 5171be3.

📒 Files selected for processing (3)
  • .changeset/dull-ladybugs-whisper.md (1 hunks)
  • packages/components/tabs/src/use-tabs.ts (1 hunks)
  • packages/core/theme/src/components/tabs.ts (2 hunks)
✅ Files skipped from review due to trivial changes (1)
  • .changeset/dull-ladybugs-whisper.md
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: TypeScript
  • GitHub Check: Build
🔇 Additional comments (5)
packages/components/tabs/src/use-tabs.ts (1)

174-174: Nice rename for consistent slot naming

Renaming from wrapper to tabWrapper clearly enhances readability and aligns with the updated naming conventions introduced in this PR. The change looks good.

packages/core/theme/src/components/tabs.ts (4)

75-75: Good introduction of the new slot definition for tabWrapper

Defining tabWrapper here aligns with the rename effort and provides a clean separation of responsibilities for the tab wrapper element.


169-169: Clear addition of tabWrapper styles for start placement

Ensures that vertical tabs have a proper layout. The choice of "flex" is correct to allow for vertical orientation.


174-174: Proper handling of reversed row layout for the end placement

Renaming the slot and adding "flex flex-row-reverse" aligns well with the revised tab structure, allowing the tabs to align starting from the right side.


177-177: Appropriate styling for the bottom placement with flex-col-reverse

This change correctly flips the vertical order of the tabs to place them below the content. The rename is consistent across all placements.

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.

Copy link
Member

@wingkwong wingkwong left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. may need to update the doc as well. (currently this slot is missing).
  2. would suggest to mark this with breaking change

@wingkwong wingkwong added this to the v2.7.0 milestone Jan 25, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[BUG] - Missing tabWrapper tv slot in Tabs component
2 participants