Skip to content

feat: tv component definition w/ config overrides #242

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@
"test:watch": "jest --watch --no-verbose"
},
"dependencies": {
"defu": "6.1.4",
"tailwind-merge": "2.5.4"
},
"devDependencies": {
Expand Down
14 changes: 11 additions & 3 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

124 changes: 124 additions & 0 deletions src/__tests__/defineTV.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,124 @@
import {expect, describe} from "@jest/globals";

import {defineTV} from "../index";

const createTestComponent = defineTV({
base: "base",
slots: {
a: "apples",
b: "bananas",
},
variants: {
size: {
small: {
a: "small-apples",
b: "small-bananas",
},
medium: {
a: "medium-apples",
b: "medium-bananas",
},
large: {
a: "large-apples",
b: "large-bananas",
},
},
rotten: {
true: {
a: "rotten-apples",
b: "rotten-bananas",
},
false: {
a: "fresh-apples",
b: "fresh-bananas",
},
},
},
compoundSlots: [
{
slots: ["a", "b"],
size: "medium",
class: "slot-compound",
},
],
compoundVariants: [
{
disabled: false,
size: "medium",
class: {a: "variant-compound"},
},
],
defaultVariants: {
size: "medium",
disabled: false,
},
});

describe("defineTV", () => {
it("should define a basic TV component", () => {
const component = createTestComponent();

["a", "b", "base"].forEach((key) => expect(component).toHaveProperty(key));
expect(component.base()).toStrictEqual("base");
expect(component.a()).toStrictEqual(
"apples medium-apples fresh-apples variant-compound slot-compound",
);
expect(component.b()).toStrictEqual("bananas medium-bananas fresh-bananas slot-compound");
});

it("enables slot overrides", () => {
const component = createTestComponent({slots: {a: "oranges", b: "pears"}});

expect(component.a()).toStrictEqual(
"oranges medium-apples fresh-apples variant-compound slot-compound",
);
expect(component.b()).toStrictEqual("pears medium-bananas fresh-bananas slot-compound");
});

it("enables variant overrides", () => {
const component = createTestComponent({
variants: {size: {medium: {a: "medium-oranges", b: "medium-pears"}}},
});

expect(component.a()).toStrictEqual(
"apples medium-oranges fresh-apples variant-compound slot-compound",
);
expect(component.b()).toStrictEqual("bananas medium-pears fresh-bananas slot-compound");
});

it("enables compound slot overrides", () => {
const component = createTestComponent({
compoundSlots: [{slots: ["a", "b"], size: "medium", class: "slot-element"}],
});

expect(component.a()).toStrictEqual(
"apples medium-apples fresh-apples variant-compound slot-element",
);
expect(component.b()).toStrictEqual("bananas medium-bananas fresh-bananas slot-element");
});

it("enables compound variant overrides", () => {
const component = createTestComponent({
compoundVariants: [{rotten: false, size: "medium", class: {a: "variant-element"}}],
});

expect(component.a()).toStrictEqual(
"apples medium-apples fresh-apples variant-element slot-compound",
);
expect(component.b()).toStrictEqual("bananas medium-bananas fresh-bananas slot-compound");
});

it("enables default variant overrides", () => {
const component = createTestComponent({defaultVariants: {size: "small", rotten: true}});

expect(component.a()).toStrictEqual("apples small-apples rotten-apples");
expect(component.b()).toStrictEqual("bananas small-bananas rotten-bananas");
});

it("passes props to the component", () => {
const component = createTestComponent({}, {size: "large", rotten: true});

expect(component.a()).toStrictEqual("apples large-apples rotten-apples");
expect(component.b()).toStrictEqual("bananas large-bananas rotten-bananas");
});
});
Loading