Skip to content

fix(system-rsc): extendVariants Fix/compound variants types #5847

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.

Sign up for GitHub

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

Open
wants to merge 11 commits into
base: canary
Choose a base branch
from
+76 −18
Open

fix(system-rsc): extendVariants Fix/compound variants types #5847

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
f5d622e
fix(extendVariants): return component type error
IsDyh01 Oct 10, 2025
3858ffd
fix(CompoundVariants): correct type inference for extended/compound v…
ITBoomBKStudio Oct 24, 2025
84aaa3e
test: cover compound/extend inference; enforce CP required props
ITBoomBKStudio Oct 24, 2025
5ab2c68
fix(types): correct CompoundVariants class value inference
ITBoomBKStudio Oct 24, 2025
6336fa8
fix(types): make ExtendVariants props optional and guard V[key] with …
ITBoomBKStudio Oct 25, 2025
b770b54
test(extendVariants): add compoundVariants integration test
ITBoomBKStudio Oct 25, 2025
0021c8f
test(extendVariants): new styles - extended & fixed styles - origina…
ITBoomBKStudio Oct 25, 2025
73032ce
test(extendVariants): fixed slot component variant styles extended test
ITBoomBKStudio Oct 25, 2025
8baeab2
fix(types): avoid leaking React internals by removing PropsWithoutRef
ITBoomBKStudio Oct 26, 2025
4e64ece
chore(changeset): add patch for extendVariants and CompoundVariants t…
ITBoomBKStudio Oct 26, 2025
d18110f
refactor(types): unify slot value inference via GetSuggestedValues<S>…
ITBoomBKStudio Oct 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 39 additions & 2 deletions packages/core/system-rsc/__tests__/extend-variants.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import type {ExtendVariantProps} from "../src/extend-variants";
import type {ExtendVariantProps, ExtendVariantWithSlotsProps} from "../src/extend-variants";

import React from "react";
import {render, screen} from "@testing-library/react";
Expand Down Expand Up @@ -37,7 +37,7 @@ const createExtendNoSlotsComponent = (styles: ExtendVariantProps = {}) =>
],
});

const createExtendSlotsComponent = () =>
const createExtendSlotsComponent = (styles: ExtendVariantWithSlotsProps = {}) =>
extendVariants(Card, {
variants: {
shadow: {
Expand Down Expand Up @@ -73,6 +73,13 @@ const createExtendSlotsComponent = () =>
shadow: "xl",
radius: "xl",
},
compoundVariants: styles?.compoundVariants ?? [
{
shadow: "none",
radius: "md",
class: "scale-150",
},
],
});

describe("extendVariants function - no slots", () => {
Expand Down Expand Up @@ -253,4 +260,34 @@ describe("extendVariants function - with slots", () => {
expect(baseEl).toHaveClass("shadow-xs");
expect(headerEl).toHaveClass("rounded-none");
});

test("should include the compound variant styles - original", () => {
const Card2 = createExtendSlotsComponent({
compoundVariants: [
{
shadow: "none",
radius: "md",
class: "scale-150",
},
{
radius: "md",
class: {
header: "rounded-xl",
},
},
],
});

const {getByTestId} = render(
<Card2 radius="md" shadow="none">
Card Content
</Card2>,
);

const baseEl = getByTestId("base");
const headerEl = getByTestId("header");

expect(baseEl).toHaveClass("scale-150");
expect(headerEl).toHaveClass("rounded-xl");
});
});
16 changes: 9 additions & 7 deletions packages/core/system-rsc/src/extend-variants.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,9 @@ type VariantValue<V, SV> = {

type DefaultVariants<V, SV> = VariantValue<V, SV>;

type CompoundVariants<V, SV> = Array<VariantValue<V, SV> & ClassProp<ClassValue>>;
type CompoundVariants<V, SV, S> = Array<
VariantValue<V, SV> & ClassProp<ClassValue | GetSuggestedValues<S>>
>;

type Options = {
/**
Expand Down Expand Up @@ -92,7 +94,7 @@ export type ExtendVariants = {
V extends ComposeVariants<CP, S>,
SV extends SuggestedVariants<CP, S>,
DV extends DefaultVariants<V, SV>,
CV extends CompoundVariants<V, SV>,
CV extends CompoundVariants<V, SV, ComponentSlots<CP>>,
>(
BaseComponent: C,
styles: {
Expand All @@ -103,11 +105,11 @@ export type ExtendVariants = {
},
opts?: Options,
): ForwardRefExoticComponent<
PropsWithoutRef<
CP & {
[key in keyof V]?: StringToBoolean<keyof V[key]>;
}
> &
PropsWithoutRef<{
[key in keyof CP | keyof V]?:
| (key extends keyof CP ? CP[key] : never)
| (key extends keyof V ? StringToBoolean<keyof NonNullable<V[key]>> : never);
}> &
RefAttributes<InferRef<C>>
>;
};
Expand Down
Loading