classname-variants 1.3.0 → 1.3.1

package/README.md

@@ -195,7 +195,6 @@ If you want to keep all the variants you have defined for a component but want t
 
 ```tsx
 import { styled } from "classname-variants/react";
-import styles from "./styles.module.css";
 
 const Button = styled("button", {
   variants: {
@@ -235,20 +234,6 @@ const button = variants({
 });
 ```
 
-```ts
-const tw = String.raw;
-
-const button = variants({
-  base: tw.px(5).py(2).text.white,
-  variants: {
-    color: {
-      neutral: tw.bg.slate(500).hover(tw.bg.slate.400),
-      accent: tw.bg.teal(500).hover(tw.bg.teal(400)),
-    },
-  },
-});
-```
-
 You can then add the following line to your `settings.json`:
 
 ```

package/lib/react.d.ts

@@ -13,18 +13,17 @@ declare type VariantProps<C extends VariantsConfig<V>, V extends Variants = C["v
 export declare function variantProps<C extends VariantsConfig<V>, V extends Variants = C["variants"]>(config: Simplify<C>): <P extends VariantProps<C, C["variants"]>>(props: P) => {
     className: string;
 } & Omit<P, keyof C["variants"]>;
-declare type VariantsOf<T> = T extends VariantsConfig<infer V> ? V : {};
 declare type AsProps<T extends ElementType = ElementType> = {
     as?: T;
 };
 declare type PolymorphicComponentProps<T extends ElementType> = AsProps<T> & Omit<ComponentProps<T>, "as">;
-export declare function styled<T extends ElementType, C extends VariantsConfig<V>, V extends Variants = VariantsOf<C>>(type: T, config: string | Simplify<C>): <As extends ElementType<any> = T>(props: AsProps<As> & Omit<ComponentProps<As>, "as"> & { [K in keyof C["variants"] as K extends keyof { [K_1 in keyof C["variants"] as C["variants"][K_1] extends {
+export declare function styled<T extends ElementType, C extends VariantsConfig<V>, V extends Variants = C["variants"]>(type: T, config: string | Simplify<C>): <As extends ElementType<any> = T>(props: AsProps<As> & Omit<ComponentProps<As>, "as"> & (C["variants"] extends infer T_1 extends Variants ? { [K in keyof T_1 as K extends keyof (C["variants"] extends infer T_2 extends Variants ? { [K_1 in keyof T_2 as C["variants"][K_1] extends {
     true: any;
 } | {
     false: any;
-} ? K_1 : never]: C["variants"][K_1]; } | keyof { [K_2 in keyof C["variants"] as K_2 extends keyof C["defaultVariants"] ? K_2 : never]: C["variants"][K_2]; } ? never : K]: { [K_3 in keyof C["variants"]]: keyof C["variants"][K_3] extends "true" | "false" ? boolean : keyof C["variants"][K_3]; }[K]; } & { [K_4 in keyof C["variants"] as K_4 extends keyof { [K_1 in keyof C["variants"] as C["variants"][K_1] extends {
+} ? K_1 : never]: C["variants"][K_1]; } : never) | keyof (C["variants"] extends infer T_3 extends Variants ? { [K_2 in keyof T_3 as K_2 extends keyof C["defaultVariants"] ? K_2 : never]: C["variants"][K_2]; } : never) ? never : K]: (C["variants"] extends infer T_4 extends Variants ? { [K_3 in keyof T_4]: keyof C["variants"][K_3] extends "true" | "false" ? boolean : keyof C["variants"][K_3]; } : never)[K]; } : never) & (C["variants"] extends infer T_5 extends Variants ? { [K_4 in keyof T_5 as K_4 extends keyof (C["variants"] extends infer T_2 extends Variants ? { [K_1 in keyof T_2 as C["variants"][K_1] extends {
     true: any;
 } | {
     false: any;
-} ? K_1 : never]: C["variants"][K_1]; } | keyof { [K_2 in keyof C["variants"] as K_2 extends keyof C["defaultVariants"] ? K_2 : never]: C["variants"][K_2]; } ? K_4 : never]?: { [K_3 in keyof C["variants"]]: keyof C["variants"][K_3] extends "true" | "false" ? boolean : keyof C["variants"][K_3]; }[K_4] | undefined; }) => ReactElement | null;
+} ? K_1 : never]: C["variants"][K_1]; } : never) | keyof (C["variants"] extends infer T_3 extends Variants ? { [K_2 in keyof T_3 as K_2 extends keyof C["defaultVariants"] ? K_2 : never]: C["variants"][K_2]; } : never) ? K_4 : never]?: (C["variants"] extends infer T_4 extends Variants ? { [K_3 in keyof T_4]: keyof C["variants"][K_3] extends "true" | "false" ? boolean : keyof C["variants"][K_3]; } : never)[K_4] | undefined; } : never)) => ReactElement | null;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "classname-variants",
-  "version": "1.3.0",
+  "version": "1.3.1",
   "description": "Variant API for plain class names",
   "author": "Felix Gnass <fgnass@gmail.com>",
   "license": "MIT",

package/src/react.ts

@@ -52,8 +52,6 @@ export function variantProps<
   };
 }
 
-type VariantsOf<T> = T extends VariantsConfig<infer V> ? V : {};
-
 type AsProps<T extends ElementType = ElementType> = {
   as?: T;
 };
@@ -64,7 +62,7 @@ type PolymorphicComponentProps<T extends ElementType> = AsProps<T> &
 export function styled<
   T extends ElementType,
   C extends VariantsConfig<V>,
-  V extends Variants = VariantsOf<C>
+  V extends Variants = C["variants"]
 >(type: T, config: string | Simplify<C>) {
   const styledProps =
     typeof config === "string"

package/lib/example.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/example.js

@@ -1,45 +0,0 @@
-import React from "react";
-import ReactDOM from "react-dom";
-import { styled } from "./src/react";
-function CustomComponent({ title, ...props }) {
-    return React.createElement("div", { ...props }, title);
-}
-const Card = styled("div", "bg-white p-4 border-2 rounded-lg");
-const TitleCard = styled(CustomComponent, "bg-white p-4 border-2 rounded-lg");
-const Button = styled("button", {
-    base: "px-5 py-2 text-white disabled:bg-gray-400 disabled:text-gray-300",
-    variants: {
-        color: {
-            neutral: "bg-slate-500 hover:bg-slate-400",
-            accent: "bg-teal-500 hover:bg-teal-400",
-        },
-        outlined: {
-            true: "border-2",
-        },
-        rounded: {
-            true: "rounded-full",
-            false: "rounded-sm",
-        },
-    },
-    compoundVariants: [
-        {
-            variants: { color: "accent", outlined: true },
-            className: "border-teal-600",
-        },
-    ],
-    defaultVariants: {
-        color: "neutral",
-    },
-});
-function App() {
-    return (React.createElement("div", { className: "flex justify-center items-center pt-8 gap-4 flex-wrap" },
-        React.createElement(Button, { onClick: console.log }, "Accent"),
-        React.createElement(Button, { rounded: true }, "Neutral + Rounded"),
-        React.createElement(Button, { color: "accent", outlined: true }, "Accent + Outlined"),
-        React.createElement(Button, { color: "accent", disabled: true }, "Disabled"),
-        React.createElement(TitleCard, { title: "Hello" }),
-        React.createElement(Card, null,
-            React.createElement("h1", null, "Hello"),
-            React.createElement("p", null, "world"))));
-}
-ReactDOM.render(React.createElement(App, null), document.getElementById("root"));

package/lib/src/index.d.ts

@@ -1,105 +0,0 @@
-/**
- * Definition of the available variants and their options.
- * @example
- * {
- *   color: {
- *     white: "bg-white"
- *     green: "bg-green-500",
- *   },
- *   size: {
- *     small: "text-xs",
- *     large: "text-lg"
- *   }
- * }
- */
-export declare type Variants = Record<string, Record<string, string>>;
-/**
- * Configuration including defaults and compound variants.
- */
-export interface VariantsConfig<V extends Variants> {
-    base?: string;
-    variants: V;
-    compoundVariants?: CompoundVariant<V>[];
-    defaultVariants?: Partial<OptionsOf<V>>;
-}
-/**
- * Rules for class names that are applied for certain variant combinations.
- */
-export interface CompoundVariant<V extends Variants> {
-    variants: Partial<OptionsOf<V>>;
-    className: string;
-}
-/**
- * Only the boolean variants, i.e. ones that have "true" or "false" as options.
- */
-declare type BooleanVariants<V extends Variants> = {
-    [K in keyof V as V[K] extends {
-        true: any;
-    } | {
-        false: any;
-    } ? K : never]: V[K];
-};
-/**
- * Only the variants for which a default options is set.
- */
-declare type DefaultVariants<C extends VariantsConfig<V>, V extends Variants = C["variants"]> = {
-    [K in keyof V as K extends keyof C["defaultVariants"] ? K : never]: C["variants"][K];
-};
-/**
- * Names of all optional variants, i.e. booleans or ones with default options.
- */
-declare type OptionalVariantNames<C extends VariantsConfig<V>, V extends Variants = C["variants"]> = keyof BooleanVariants<V> | keyof DefaultVariants<C>;
-/**
- * Possible options for all the optional variants.
- *
- * @example
- * {
- *   color?: "white" | "green",
- *   rounded?: boolean | undefined
- * }
- */
-declare type OptionalOptions<C extends VariantsConfig<V>, V extends Variants = C["variants"]> = {
-    [K in keyof V as K extends OptionalVariantNames<C> ? K : never]?: OptionsOf<V>[K];
-};
-/**
- * Possible options for all required variants.
- *
- * @example {
- *   size: "small" | "large"
- * }
- */
-declare type RequiredOptions<C extends VariantsConfig<V>, V extends Variants = C["variants"]> = {
-    [K in keyof V as K extends OptionalVariantNames<C> ? never : K]: OptionsOf<V>[K];
-};
-/**
- * Utility type to extract the possible options.
- * Converts "true" | "false" options into booleans.
- *
- * @example
- * OptionsOf<{
- *   size: { small: "text-xs"; large: "text-lg" };
- *   rounded: { true: "rounded-full" }
- * }>
- * ==>
- * {
- *   size: "text-xs" | "text-lg";
- *   rounded: boolean;
- * }
- */
-declare type OptionsOf<V extends Variants> = {
-    [K in keyof V]: keyof V[K] extends "true" | "false" ? boolean : keyof V[K];
-};
-/**
- * Extracts the possible options.
- */
-export declare type VariantOptions<C extends VariantsConfig<V>, V extends Variants = C["variants"]> = RequiredOptions<C> & OptionalOptions<C>;
-/**
- * Without this conversion step, defaultVariants and compoundVariants will
- * allow extra keys, i.e. non-existent variants.
- * See https://github.com/sindresorhus/type-fest/blob/main/source/simplify.d.ts
- */
-export declare type Simplify<T> = {
-    [K in keyof T]: T[K];
-};
-export declare function variants<C extends VariantsConfig<V>, V extends Variants = C["variants"]>(config: Simplify<C>): (props: VariantOptions<C>) => string;
-export {};

package/lib/src/index.js

@@ -1,27 +0,0 @@
-export function variants(config) {
-    const { base, variants, compoundVariants, defaultVariants } = config;
-    const isBooleanVariant = (name) => {
-        const v = variants === null || variants === void 0 ? void 0 : variants[name];
-        return v && ("false" in v || "true" in v);
-    };
-    return (props) => {
-        var _a;
-        const res = [base];
-        const getSelected = (name) => {
-            var _a, _b;
-            return (_b = (_a = props[name]) !== null && _a !== void 0 ? _a : defaultVariants === null || defaultVariants === void 0 ? void 0 : defaultVariants[name]) !== null && _b !== void 0 ? _b : (isBooleanVariant(name) ? false : undefined);
-        };
-        for (let name in variants) {
-            const selected = getSelected(name);
-            if (selected !== undefined)
-                res.push((_a = variants[name]) === null || _a === void 0 ? void 0 : _a[selected]);
-        }
-        for (let { variants, className } of compoundVariants !== null && compoundVariants !== void 0 ? compoundVariants : []) {
-            const isSelected = (name) => getSelected(name) === variants[name];
-            if (Object.keys(variants).every(isSelected)) {
-                res.push(className);
-            }
-        }
-        return res.filter(Boolean).join(" ");
-    };
-}

package/lib/src/react.d.ts

@@ -1,19 +0,0 @@
-import { ComponentProps, ElementType, ForwardRefExoticComponent, PropsWithoutRef } from "react";
-import { Variants, VariantsConfig, VariantOptions, Simplify } from "./index.js";
-/**
- * Utility type to infer the first argument of a variantProps function.
- */
-export declare type VariantPropsOf<T> = T extends (props: infer P) => any ? P : never;
-/**
- * Type for the variantProps() argument – consists of the VariantOptions and an optional className for chaining.
- */
-declare type VariantProps<C extends VariantsConfig<V>, V extends Variants = C["variants"]> = VariantOptions<C> & {
-    className?: string;
-};
-export declare function variantProps<C extends VariantsConfig<V>, V extends Variants = C["variants"]>(config: Simplify<C>): <P extends VariantProps<C, C["variants"]>>(props: P) => {
-    className: string;
-} & Omit<P, keyof C["variants"]>;
-declare type StyledComponent<T extends ElementType, C extends VariantsConfig<V>, V extends Variants = C["variants"]> = ForwardRefExoticComponent<PropsWithoutRef<ComponentProps<T> & VariantOptions<C>> & React.RefAttributes<T>>;
-declare type Vars<T> = T extends VariantsConfig<infer V> ? V : {};
-export declare function styled<T extends ElementType, C extends VariantsConfig<V>, V extends Variants = Vars<C>>(type: T, config: string | Simplify<C>): StyledComponent<T, C>;
-export {};

package/lib/src/react.js

@@ -1,25 +0,0 @@
-import { createElement, forwardRef, } from "react";
-import { variants, } from "./index.js";
-export function variantProps(config) {
-    const variantClassName = variants(config);
-    return (props) => {
-        const result = {};
-        // Pass-through all unrelated props
-        for (let prop in props) {
-            if (config.variants && !(prop in config.variants)) {
-                result[prop] = props[prop];
-            }
-        }
-        // Add the optionally passed className prop for chaining
-        result.className = [props.className, variantClassName(props)]
-            .filter(Boolean)
-            .join(" ");
-        return result;
-    };
-}
-export function styled(type, config) {
-    const styledProps = typeof config === "string"
-        ? variantProps({ base: config, variants: {} })
-        : variantProps(config);
-    return forwardRef((props, ref) => createElement(type, { ...styledProps(props), ref }));
-}