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: move destroyInactiveTabPanel prop to Tabs instead of Tab #3130

Merged
merged 1 commit into from
May 31, 2024

Conversation

wingkwong
Copy link
Member

@wingkwong wingkwong commented May 30, 2024

Closes #

📝 Description

destroyInactiveTabPanel is a prop for Tabs, not Tab.

⛳️ Current behavior (updates)

Please describe the current behavior that you are modifying

🚀 New behavior

Please describe the behavior or changes this PR adds

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

📝 Additional Information

Summary by CodeRabbit

  • New Features
    • Added destroyInactiveTabPanel property to the Tabs component, allowing users to control whether inactive tab panels should be destroyed when switching tabs.

@wingkwong wingkwong requested a review from jrgarciadev as a code owner May 30, 2024 05:03
Copy link

vercel bot commented May 30, 2024

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

Name Status Preview Comments Updated (UTC)
nextui-docs-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 30, 2024 5:05am
nextui-storybook-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 30, 2024 5:05am

Copy link

changeset-bot bot commented May 30, 2024

⚠️ No Changeset found

Latest commit: f1337e7

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
Contributor

coderabbitai bot commented May 30, 2024

Walkthrough

The recent update introduces a new property destroyInactiveTabPanel to the Tabs component. This property allows developers to control whether inactive tab panels should be destroyed when switching tabs, enhancing the component's flexibility and performance management.

Changes

Files Change Summary
.../components/tabs.mdx Added documentation for the new destroyInactiveTabPanel boolean property in the Tabs component.

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant User
    participant TabsComponent
    participant TabPanel

    User->>TabsComponent: Switch Tab
    TabsComponent->>TabPanel: Check destroyInactiveTabPanel
    alt destroyInactiveTabPanel is true
        TabsComponent->>TabPanel: Destroy Inactive Tab Panel
    else destroyInactiveTabPanel is false
        TabsComponent->>TabPanel: Keep Inactive Tab Panel
    end

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

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

Outside diff range and nitpick comments (1)
apps/docs/content/docs/components/tabs.mdx (1)

Line range hint 105-105: Consider adding a hyphen to "client side" to form the compound adjective "client-side".

This adjustment will improve the grammatical accuracy of the documentation. Here's the suggested change:

- current URL from your client side router.
+ current URL from your client-side router.
Review Details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits Files that changed from the base of the PR and between 0bfa585 and f1337e7.
Files selected for processing (1)
  • apps/docs/content/docs/components/tabs.mdx (2 hunks)
Additional Context Used
LanguageTool (1)
apps/docs/content/docs/components/tabs.mdx (1)

Near line 105: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...cted tab with the current URL from your client side router. You can do this by doing the fo...
Rule ID: EN_COMPOUND_ADJECTIVE_INTERNAL

Additional comments not posted (1)
apps/docs/content/docs/components/tabs.mdx (1)

268-268: Clarification on destroyInactiveTabPanel property is well-documented.

This addition clearly explains the functionality of the destroyInactiveTabPanel property, enhancing the documentation's accuracy and usefulness for developers.

@wingkwong wingkwong changed the title docs: tab destroy inactive tab panel docs: move destroyInactiveTabPanel prop to Tabs instead of Tab May 30, 2024
@jrgarciadev jrgarciadev merged commit a8d9ca0 into main May 31, 2024
3 checks passed
@jrgarciadev jrgarciadev deleted the docs/tab-destroyInactiveTabPanel branch May 31, 2024 02:17
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.

None yet

2 participants