@vanilla-extract/recipes - npm Package Compare versions

Comparing version 0.1.1 to 0.2.0

CHANGELOG.md

 # @vanilla-extract/recipes
 
-## 0.1.1
-### Patch Changes
+## 0.2.0
 
+### Minor Changes
 
+- [#376](https://github.com/seek-oss/vanilla-extract/pull/376) [`f8082b9`](https://github.com/seek-oss/vanilla-extract/commit/f8082b9b62c57f394bf82cf05296a680c3ef177b) Thanks [@TheMightyPenguin](https://github.com/TheMightyPenguin)! - Add `RecipeVariants` type
 
-- [#380](https://github.com/seek-oss/vanilla-extract/pull/380) [`3ae2422`](https://github.com/seek-oss/vanilla-extract/commit/3ae24220e2187475561e0be54631558076370fa4) Thanks [@mattcompiles](https://github.com/mattcompiles)! - Add variant group names to debug IDs
+  A utility to make use of the recipe’s type interface. This can be useful when typing functions or component props that need to accept recipe values as part of their interface.
 
+  ```ts
+  // button.css.ts
+  import { recipe, RecipeVariants } from '@vanilla-extract/recipes';
 
+  export const button = recipe({
+    variants: {
+      color: {
+        neutral: { background: 'whitesmoke' },
+        brand: { background: 'blueviolet' },
+        accent: { background: 'slateblue' },
+      },
+      size: {
+        small: { padding: 12 },
+        medium: { padding: 16 },
+        large: { padding: 24 },
+      },
+    },
+  });
 
-- [#380](https://github.com/seek-oss/vanilla-extract/pull/380) [`3ae2422`](https://github.com/seek-oss/vanilla-extract/commit/3ae24220e2187475561e0be54631558076370fa4) Thanks [@mattcompiles](https://github.com/mattcompiles)! - Return default variants when selection is `undefined`
+  // Get the type
+  export type ButtonVariants = RecipeVariants<typeof button>;
+
+  // the above will result in a type equivalent to:
+  export type ButtonVariants = {
+    color?: 'neutral' | 'brand' | 'accent';
+    size?: 'small' | 'medium' | 'large';
+  };
+  ```
+
+## 0.1.1
+
+### Patch Changes
+
+- [#380](https://github.com/seek-oss/vanilla-extract/pull/380) [`3ae2422`](https://github.com/seek-oss/vanilla-extract/commit/3ae24220e2187475561e0be54631558076370fa4) Thanks [@mattcompiles](https://github.com/mattcompiles)! - Add variant group names to debug IDs
+
+* [#380](https://github.com/seek-oss/vanilla-extract/pull/380) [`3ae2422`](https://github.com/seek-oss/vanilla-extract/commit/3ae24220e2187475561e0be54631558076370fa4) Thanks [@mattcompiles](https://github.com/mattcompiles)! - Return default variants when selection is `undefined`

dist/declarations/src/index.d.ts

 import type { PatternOptions, RuntimeFn, VariantGroups } from './types';
+export type { RecipeVariants } from './types';
 export declare function recipe<Variants extends VariantGroups>(options: PatternOptions<Variants>, debugId?: string): RuntimeFn<Variants>;

dist/declarations/src/types.d.ts

@@ -30,2 +30,3 @@ import type { ComplexStyleRule } from '@vanilla-extract/css';
 export declare type RuntimeFn<Variants extends VariantGroups> = (options?: VariantSelection<Variants>) => string;
+export declare type RecipeVariants<RecipeFn extends RuntimeFn<VariantGroups>> = Parameters<RecipeFn>[0];
 export {};

package.json

 {
   "name": "@vanilla-extract/recipes",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "Create multi-variant styles with a type-safe runtime API, heavily inspired by https://stitches.dev",
@@ -5,0 +5,0 @@ "sideEffects": false,

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

41210

increased by3.33%

Lines of code

265

increased by0.76%

No dependency changes