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

Merged
merged 5 commits into from
Jan 30, 2025
Merged

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):

wrapper will be renamed to tabWrapper

📝 Additional Information

Summary by CodeRabbit

Summary by CodeRabbit

  • Bug Fixes

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

    • Patched dependency @heroui/theme
  • Documentation

    • Updated documentation for the Tabs component to reflect the renaming of the tab wrapper slot and updated type definitions.

These changes enhance consistency in the naming of tab wrapper slots while preserving 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 30, 2025 11:22am
heroui-sb ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 30, 2025 11:22am

Copy link

changeset-bot bot commented Jan 24, 2025

🦋 Changeset detected

Latest commit: 6ec9d40

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 affects the component's slot definitions and how wrapper properties are retrieved. Additionally, a patch for the "@heroui/theme" dependency is 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
apps/docs/content/docs/components/tabs.mdx Updated documentation to reflect the change from tab to tabWrapper in the Slots section and type definitions

Assessment against linked issues

Objective Addressed Explanation
Enable passing tabWrapper key to classNames prop (4552)
Ensure tabWrapper slot is accessible through tailwind slots (4552)

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
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Nitpick comments (1)
.changeset/dull-ladybugs-whisper.md (1)

4-5: Improve the commit message format.

The commit message could be clearer and follow conventional commit format better.

Consider this improved format:

-Fix tabs slots "tab" rename to "tabWrapper" -- Breaking Change (#4552)
+feat!: rename tabs slot from "tab" to "tabWrapper" (#4552)
+
+BREAKING CHANGE: The "tab" slot has been renamed to "tabWrapper" for better clarity
+and consistency with other wrapper implementations.

This format:

  • Uses the conventional commits prefix with ! to indicate breaking change
  • Adds a blank line after the title
  • Includes a clear BREAKING CHANGE note
  • Provides context for the change
🧰 Tools
🪛 LanguageTool

[uncategorized] ~5-~5: This verb may not be in the correct tense. Consider changing the tense to fit the context better.
Context: ...theme": patch --- Fix tabs slots "tab" rename to "tabWrapper" -- Breaking Change (#45...

(AI_EN_LECTOR_REPLACEMENT_VERB_TENSE)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 0e58930 and 20955f3.

📒 Files selected for processing (1)
  • .changeset/dull-ladybugs-whisper.md (1 hunks)
🧰 Additional context used
🪛 LanguageTool
.changeset/dull-ladybugs-whisper.md

[uncategorized] ~5-~5: This verb may not be in the correct tense. Consider changing the tense to fit the context better.
Context: ...theme": patch --- Fix tabs slots "tab" rename to "tabWrapper" -- Breaking Change (#45...

(AI_EN_LECTOR_REPLACEMENT_VERB_TENSE)

⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Build

.changeset/dull-ladybugs-whisper.md Show resolved Hide resolved
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.

@winchesHe I'm a bit confused. This PR includes two renames. Can you double check if they are expected?

  • tab -> tabWrapper
  • wrapper -> tabWrapper

tab will be still here in tabs tv while wrapper will not.

@winchesHe
Copy link
Member Author

@winchesHe I'm a bit confused. This PR includes two renames. Can you double check if they are expected?

  • tab -> tabWrapper
  • wrapper -> tabWrapper

tab will be still here in tabs tv while wrapper will not.

updated

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

♻️ Duplicate comments (1)
.changeset/dull-ladybugs-whisper.md (1)

1-3: ⚠️ Potential issue

Version bump should be major for breaking changes.

The changeset indicates a patch version bump, but the commit message mentions this is a breaking change. According to semver, breaking changes should increment the major version.

Apply this diff to update the version bump:

---
-"@heroui/theme": patch
+"@heroui/theme": major
---
🧹 Nitpick comments (1)
.changeset/dull-ladybugs-whisper.md (1)

5-5: Improve commit message format.

The commit message should use the past tense to describe what the change accomplished.

Apply this diff to improve the commit message:

-Fix tabs slots "wrapper" rename to "tabWrapper" -- Breaking Change (#4552)
+Fixed tabs slots by renaming "wrapper" to "tabWrapper" -- Breaking Change (#4552)
🧰 Tools
🪛 LanguageTool

[uncategorized] ~5-~5: This verb may not be in the correct tense. Consider changing the tense to fit the context better.
Context: ...e": patch --- Fix tabs slots "wrapper" rename to "tabWrapper" -- Breaking Change (#45...

(AI_EN_LECTOR_REPLACEMENT_VERB_TENSE)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 20955f3 and 6ec9d40.

📒 Files selected for processing (2)
  • .changeset/dull-ladybugs-whisper.md (1 hunks)
  • apps/docs/content/docs/components/tabs.mdx (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • apps/docs/content/docs/components/tabs.mdx
🧰 Additional context used
🪛 LanguageTool
.changeset/dull-ladybugs-whisper.md

[uncategorized] ~5-~5: This verb may not be in the correct tense. Consider changing the tense to fit the context better.
Context: ...e": patch --- Fix tabs slots "wrapper" rename to "tabWrapper" -- Breaking Change (#45...

(AI_EN_LECTOR_REPLACEMENT_VERB_TENSE)

⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: TypeScript
  • GitHub Check: Build

@jrgarciadev jrgarciadev merged commit 06d6f08 into canary Jan 30, 2025
8 checks passed
@jrgarciadev jrgarciadev deleted the fix/tab-wrapper-eng-1865 branch January 30, 2025 14:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
💥 Type: Breaking Change This PR includes breaking changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

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