nextui icon indicating copy to clipboard operation
nextui copied to clipboard

fix(system-rsc): missing StringToBoolean<keyof V[K]>[]

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

Closes #3530

📝 Description

Updated the type VariantVal

Typescript error on using the following code

'use client';

import { Button as BaseButton, extendVariants } from '@nextui-org/react';

const Button = extendVariants(BaseButton, {
  // Must define default variants before extending them
  defaultVariants: { size: 'md', variant: 'solid', color: 'default' },
  compoundVariants: [
    {
      variant: ['solid'], // <-- ERROR: Type 'string[]' is not assignable to type '"solid" | "bordered" | "light" | "flat" | "faded" | "shadow" | "ghost" | undefined'.
      color: 'default',
      class: 'text-white'
    }
  ],
});

export default Button;

Please describe the current behavior that you are modifying

string | string[] | undefined. can be accepted by accepted by compoundVariants.variant

Please describe the behavior or changes this PR adds

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

📝 Additional Information

Summary by CodeRabbit

  • New Features

    • Enhanced flexibility for defining component variants by allowing the variant property to accept an array of strings.
    • Improved versatility of VariantValue and Options types for better handling of variants.
  • Bug Fixes

    • Resolved issues with the handling of multiple variant options, ensuring correct processing and application within the system.

awesome-pro avatar Jul 25 '24 17:07 awesome-pro

🦋 Changeset detected

Latest commit: c4592c9a0489d38681ca023ffe26cbf917664fff

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

This PR includes changesets to release 27 packages
Name Type
@nextui-org/system-rsc Patch
@nextui-org/code Patch
@nextui-org/divider Patch
@nextui-org/kbd Patch
@nextui-org/spacer Patch
@nextui-org/spinner Patch
@nextui-org/system Patch
@nextui-org/react Patch
@nextui-org/accordion Patch
@nextui-org/listbox Patch
@nextui-org/menu Patch
@nextui-org/table Patch
@nextui-org/autocomplete Patch
@nextui-org/button Patch
@nextui-org/select Patch
@nextui-org/calendar Patch
@nextui-org/date-picker Patch
@nextui-org/dropdown Patch
@nextui-org/modal Patch
@nextui-org/navbar Patch
@nextui-org/popover Patch
@nextui-org/slider Patch
@nextui-org/snippet Patch
@nextui-org/tabs Patch
@nextui-org/tooltip Patch
@nextui-org/aria-utils Patch
@nextui-org/framer-utils 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

changeset-bot[bot] avatar Jul 25 '24 17: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 25 '24 17:07 vercel[bot]

Walkthrough

This update enhances the @nextui-org/system-rsc package by allowing the compoundVariants.variant to accept an array of strings, improving its flexibility for defining component styles. Additionally, it modifies the VariantValue type in TypeScript to accommodate both single and array values for variant keys, enhancing type versatility. These changes address a specific TypeScript limitation while improving usability for developers working with variants.

Changes

Files Change Summary
.changeset/nice-beans-thank.md Introduced patch for compoundVariants.variant to accept string[].
packages/core/system-rsc/src/extend-variants.d.ts Updated VariantValue type to support arrays for variant keys, and minor doc fix in Options type.

Assessment against linked issues

Objective Addressed Explanation
Allow variant property to accept string[] ( #3530 )
Resolve TypeScript error with variant array ( #3530 )

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 25 '24 17:07 coderabbitai[bot]