tailwind-variants 0.0.1 → 0.0.3

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Tailwid Variants
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,37 @@
+# Tailwind Variants
+
+🚧 Under construction - please check back later
+
+## Acknowledgements
+
+- [**cva**](https://github.com/joe-bell/cva) ([Joe Bell](https://github.com/joe-bell)) 
+  This project as started as an extension of Joe's work on `cva` – a great tool for generating variants for a single element with Tailwind CSS. Big shoutout to [Joe Bell](https://github.com/joe-bell) and [contributors](https://github.com/joe-bell/cva/graphs/contributors) you guys rock! 🤘 - we recommend to use `cva` if don't need to generate variants for multiple elements at the same time.
+
+- [**Stitches**](https://stitches.dev/) ([Modulz](https://modulz.app))  
+  The pioneers of the `variants` API movement. Inmense thanks to [Modulz](https://modulz.app) for their work on Stitches and the community around it. 🙏
+
+## Installation
+
+```sh
+yarn add tailwind-variants
+#or
+npm i tailwind-variants
+```
+## Contributing
+
+Contributions are always welcome!
+
+Please follow our [contributing guidelines](./CONTRIBUTING.md).
+
+Please adhere to this project's [CODE_OF_CONDUCT](./CODE_OF_CONDUCT.md).
+
+## Authors
+
+- Junior garcia ([@jrgarciadev](https://github.com/jrgaciadev))
+- Tianen Pang ([@tianenpang](https://github.com/tianenpang))
+
+## License
+
+Licensed under the MIT License.
+
+See [LICENSE](./LICENSE.md) for more information.

package/dist/config.d.ts

@@ -0,0 +1,16 @@
+import type {Config as TwMergeConfig} from "tailwind-merge";
+
+export type TVConfig = {
+  /**
+   * Whether to merge the class names with `tailwind-merge` library.
+   * It's avoid to have duplicate tailwind classes. (Recommended)
+   * @see https://github.com/dcastil/tailwind-merge/blob/v1.8.1/README.md
+   * @default true
+   */
+  twMerge?: boolean;
+  /**
+   * The config object for `tailwind-merge` library.
+   * @see https://github.com/dcastil/tailwind-merge/blob/v1.8.1/docs/configuration.md
+   */
+  twMergeConfig?: TwMergeConfig;
+};

package/dist/index.cjs

@@ -0,0 +1,8 @@
+'use strict';
+
+var classVarianceAuthority = require('class-variance-authority');
+var tailwindMerge = require('tailwind-merge');
+
+var g=e=>e.filter(c=>c),C=e=>typeof e=="boolean"?`${e}`:e===0?"0":e,k=e=>e&&Object.keys(e).length>0,b=(...e)=>(c={})=>c.merge?(k(c.twMergeConfig)?tailwindMerge.extendTailwindMerge(c.twMergeConfig):tailwindMerge.twMerge)(classVarianceAuthority.cx(e)):classVarianceAuthority.cx(e);var W=(e,c={twMerge:!0,twMergeConfig:{}})=>a=>{var V;if((e==null?void 0:e.variants)==null)return b(e==null?void 0:e.base,a==null?void 0:a.class,a==null?void 0:a.className)(c);let{slots:w=[],variants:d,defaultVariants:f}=e,N=Array.isArray(w)?new Set(["base",...w.filter(n=>n!=="base")]):[],x=n=>{let t=a==null?void 0:a[n],r=f==null?void 0:f[n];if(t===null)return null;let i=C(t)||C(r);return d[n][i]},S=Object.keys(d).map(x),M=n=>g(Object.keys(d).map(t=>{let r=x(t);return !r||typeof r!="object"?null:r[n]})),j=a&&Object.entries(a).reduce((n,[t,r])=>(r===void 0||(n[t]=r),n),{}),A=(V=e==null?void 0:e.compoundVariants)==null?void 0:V.reduce((n,{class:t,className:r,...i})=>Object.entries(i).every(([m,u])=>Array.isArray(u)?u.includes({...f,...j}[m]):{...f,...j}[m]===u)?[...n,t,r]:n,[]),h=()=>{let n=g(A);return Array.isArray(n)?n.reduce((t,r)=>(typeof r=="string"&&(t.base=b(t.base,r)(c)),typeof r=="object"&&Object.entries(r).forEach(([i,m])=>{t[i]=b(t[i],m)(c);}),t),{}):n};if(N.length>1){let n=M("base"),t=h(),r=N.slice(1).reduce((i,m)=>(i[m]=u=>b(M(m),t[m],u==null?void 0:u.class,u==null?void 0:u.className)(c),i),{});return {base:i=>b(e==null?void 0:e.base,n,t.base,i==null?void 0:i.class,i==null?void 0:i.className)(c),...r}}return b(e==null?void 0:e.base,S,A,a==null?void 0:a.class,a==null?void 0:a.className)(c)};
+
+exports.tv = W;

package/dist/index.d.ts

@@ -0,0 +1,44 @@
+import {TVConfig} from "./config";
+import {ClassValue, ClassProp, OmitUndefined} from "./utils";
+
+type TVVariants<S extends string[]> = {
+  [key: string]: {
+    [key: string]: {[P in S[number]]?: ClassValue} | ClassValue;
+  };
+};
+
+type TVCompoundVariants<V extends TVVariants<S>, S extends string[]> = Array<
+  {
+    [K in keyof V]?: keyof V[K];
+  } & ClassProp<{[K in S[number]]?: ClassValue} | ClassValue>
+>;
+
+type TVDefaultVariants<V extends TVVariants<S>, S extends string[]> = {
+  [K in keyof V]?: keyof V[K];
+};
+
+type TVReturnType<S extends string[]> = S extends string[]
+  ? {[K in S[number]]: (slotProps: ClassProp) => string}
+  : (slotProps: ClassProp) => string;
+
+export declare function tv<
+  S extends string,
+  V extends TVVariants<S[]>,
+  CV extends TVCompoundVariants<V, S[]>,
+  DV extends TVDefaultVariants<V, S[]>,
+  C extends TVConfig,
+>(
+  options: {
+    base?: ClassValue;
+    slots?: S[];
+    variants?: V;
+    compoundVariants?: CV;
+    defaultVariants?: DV;
+  },
+  config?: C,
+): TVReturnType<S[]>;
+
+export type VariantProps<Component extends (...args: any) => any> = Omit<
+  OmitUndefined<Parameters<Component>[0]>,
+  "class" | "className"
+>;

package/dist/index.js

@@ -0,0 +1,6 @@
+import { cx } from 'class-variance-authority';
+import { extendTailwindMerge, twMerge } from 'tailwind-merge';
+
+var g=e=>e.filter(c=>c),C=e=>typeof e=="boolean"?`${e}`:e===0?"0":e,k=e=>e&&Object.keys(e).length>0,b=(...e)=>(c={})=>c.merge?(k(c.twMergeConfig)?extendTailwindMerge(c.twMergeConfig):twMerge)(cx(e)):cx(e);var W=(e,c={twMerge:!0,twMergeConfig:{}})=>a=>{var V;if((e==null?void 0:e.variants)==null)return b(e==null?void 0:e.base,a==null?void 0:a.class,a==null?void 0:a.className)(c);let{slots:w=[],variants:d,defaultVariants:f}=e,N=Array.isArray(w)?new Set(["base",...w.filter(n=>n!=="base")]):[],x=n=>{let t=a==null?void 0:a[n],r=f==null?void 0:f[n];if(t===null)return null;let i=C(t)||C(r);return d[n][i]},S=Object.keys(d).map(x),M=n=>g(Object.keys(d).map(t=>{let r=x(t);return !r||typeof r!="object"?null:r[n]})),j=a&&Object.entries(a).reduce((n,[t,r])=>(r===void 0||(n[t]=r),n),{}),A=(V=e==null?void 0:e.compoundVariants)==null?void 0:V.reduce((n,{class:t,className:r,...i})=>Object.entries(i).every(([m,u])=>Array.isArray(u)?u.includes({...f,...j}[m]):{...f,...j}[m]===u)?[...n,t,r]:n,[]),h=()=>{let n=g(A);return Array.isArray(n)?n.reduce((t,r)=>(typeof r=="string"&&(t.base=b(t.base,r)(c)),typeof r=="object"&&Object.entries(r).forEach(([i,m])=>{t[i]=b(t[i],m)(c);}),t),{}):n};if(N.length>1){let n=M("base"),t=h(),r=N.slice(1).reduce((i,m)=>(i[m]=u=>b(M(m),t[m],u==null?void 0:u.class,u==null?void 0:u.className)(c),i),{});return {base:i=>b(e==null?void 0:e.base,n,t.base,i==null?void 0:i.class,i==null?void 0:i.className)(c),...r}}return b(e==null?void 0:e.base,S,A,a==null?void 0:a.class,a==null?void 0:a.className)(c)};
+
+export { W as tv };

package/dist/types.d.ts

@@ -0,0 +1,58 @@
+import type {Config as TwMergeConfig} from "tailwind-merge";
+
+export type ClassPropKey = "class" | "className";
+export type ClassValue = string | null | undefined | ClassValue[];
+
+export type ClassProp =
+  | {
+      class: ClassValue;
+      className?: never;
+    }
+  | {class?: never; className: ClassValue}
+  | {class?: never; className?: never};
+
+export type OmitUndefined<T> = T extends undefined ? never : T;
+export type StringToBoolean<T> = T extends "true" | "false" ? boolean : T;
+
+export type Config = {
+  /**
+   * Whether to merge the class names with `tailwind-merge` library.
+   * It's avoid to have duplicate tailwind classes. (Recommended)
+   * @see https://github.com/dcastil/tailwind-merge/blob/v1.8.1/README.md
+   * @default true
+   */
+  twMerge?: boolean;
+  /**
+   * The config object for `tailwind-merge` library.
+   * @see https://github.com/dcastil/tailwind-merge/blob/v1.8.1/docs/configuration.md
+   */
+  twMergeConfig?: TwMergeConfig;
+};
+
+type StylesSchema = Record<string, Record<string, ClassValue>>;
+
+export type SlotVariants<T extends StylesConfig> = {
+  [Slot in keyof T["slots"]]?: ClassValue;
+};
+
+type StylesVariants<T extends StylesSchema> = {
+  [Variant in keyof T]?: StringToBoolean<keyof T[Variant]> | null;
+};
+
+type StylesVariantsMulti<T extends StylesSchema> = {
+  [Variant in keyof T]?: StringToBoolean<keyof T[Variant]> | StringToBoolean<keyof T[Variant]>[];
+};
+
+export type StylesConfig<T = {}> = T extends StylesSchema
+  ? {
+      base?: ClassValue;
+      slots?: string[];
+      variants?: T;
+      defaultVariants?: StylesVariants<T>;
+      compoundVariants?: (T extends StylesSchema
+        ? (StylesVariants<T> | StylesVariantsMulti<T>) & ClassProp
+        : ClassProp)[];
+    }
+  : never;
+
+export type TvVariantsProps = StylesVariants<StylesSchema> & ClassProp;

package/dist/utils.d.ts

@@ -0,0 +1,23 @@
+import {CxOptions, CxReturn} from "class-variance-authority";
+
+import {TVConfig} from "./config";
+
+export declare const cleanArray: (array: string[]) => string[];
+
+export declare const falsyToString: <T extends unknown>(value: T) => string | T;
+
+export declare const cx: <T extends CxOptions>(...classes: T) => (config: TVConfig) => CxReturn;
+
+export type ClassPropKey = "class" | "className";
+export type ClassValue = string | string[] | null | undefined;
+
+export type ClassProp<V extends unknown = ClassValue> =
+  | {
+      class: V;
+      className?: never;
+    }
+  | {class?: never; className: V}
+  | {class?: never; className?: never};
+
+export type OmitUndefined<T> = T extends undefined ? never : T;
+export type StringToBoolean<T> = T extends "true" | "false" ? boolean : T;

package/package.json

@@ -1,10 +1,76 @@
 {
   "name": "tailwind-variants",
-  "version": "0.0.1",
-  "description": "Class variants management for tailwindcss",
-  "main": "src/index.js",
+  "version": "0.0.3",
+  "description": "🦄 Tailwindcss first-class variant API",
+  "author": "Junior Garcia <jrgarciadev@gmail.com>",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/nextui-org/tailwind-variants"
+  },
+  "bugs": {
+    "url": "https://github.com/nextui-org/tailwind-variants/issues"
+  },
+  "type": "module",
+  "main": "src/index.ts",
+  "typings": "./dist/index.d.ts",
+  "sideEffects": false,
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    ".": {
+      "require": "./dist/index.cjs",
+      "import": "./dist/index.js",
+      "types": "./types/index.d.ts"
+    }
+  },
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "build": "tsup src/index.js && node copy-types.cjs",
+    "dev": "pnpm build:fast -- --watch",
+    "clean": "rimraf dist .turbo",
+    "typecheck": "tsc --noEmit",
+    "dry-run": "pnpm ts-node tests/dry-run.js",
+    "prepack": "clean-package",
+    "postpack": "clean-package restore",
+    "lint": "eslint -c .eslintrc.json ./src/**/*.{ts,tsx}",
+    "lint:fix": "eslint --fix -c .eslintrc.json ./src/**/*.{ts,tsx}",
+    "test": "jest --verbose"
+  },
+  "dependencies": {
+    "class-variance-authority": "0.4.0",
+    "tailwind-merge": "^1.8.1"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^17.2.0",
+    "@commitlint/config-conventional": "^17.2.0",
+    "@swc-node/jest": "^1.5.2",
+    "@swc/cli": "0.1.57",
+    "@swc/core": "1.2.198",
+    "@types/jest": "28.1.1",
+    "@typescript-eslint/eslint-plugin": "^5.42.0",
+    "@typescript-eslint/parser": "^5.42.0",
+    "clean-package": "2.1.1",
+    "eslint": "^7.29.0",
+    "eslint-config-prettier": "^8.2.0",
+    "eslint-config-ts-lambdas": "^1.2.3",
+    "eslint-import-resolver-typescript": "^2.4.0",
+    "eslint-loader": "^4.0.2",
+    "eslint-plugin-import": "^2.26.0",
+    "eslint-plugin-jest": "^24.3.6",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-prettier": "^4.0.0",
+    "eslint-plugin-promise": "^6.0.0",
+    "prettier": "^2.2.1",
+    "prettier-eslint": "^12.0.0",
+    "prettier-eslint-cli": "^5.0.1",
+    "ts-node": "^10.9.1",
+    "tsup": "6.4.0",
+    "typescript": "4.6.2",
+    "webpack": "^5.53.0"
   },
   "keywords": [
     "tailwindcss",
@@ -13,6 +79,19 @@
     "styled.",
     "styles"
   ],
-  "author": "Junior Garcia",
-  "license": "MIT"
+  "engines": {
+    "node": ">=16.x",
+    "pnpm": ">=7.x"
+  },
+  "tsup": {
+    "clean": true,
+    "minify": true,
+    "treeshake": true,
+    "target": "es2019",
+    "format": [
+      "cjs",
+      "esm"
+    ]
+  },
+  "packageManager": "pnpm@7.14.2"
 }