Skip to content
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

Resolve RecipeVariants type to improve IDE hint #1161

Merged
merged 4 commits into from
Nov 9, 2023
Merged

Resolve RecipeVariants type to improve IDE hint #1161

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
21c4810
Resolve RecipeVariants type to improve IDE hint
PrettyCoffee Aug 11, 2023
748cfd9
Add changeset
askoufis Aug 21, 2023
0f9b295
Merge branch 'master' into feat/resolve-recipe-variants
askoufis Sep 16, 2023
3ead769
Merge branch 'master' into feat/resolve-recipe-variants
mattcompiles Nov 9, 2023
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
5 changes: 5 additions & 0 deletions .changeset/grumpy-suns-doubt.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@vanilla-extract/recipes": patch
---

Improve IDE hover of `RecipeVariants` type by explicitly resolving its output
9 changes: 7 additions & 2 deletions packages/recipes/src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
import type { ComplexStyleRule } from '@vanilla-extract/css';

type Resolve<T> = {
[Key in keyof T]: T[Key];
} & {};

type RecipeStyleRule = ComplexStyleRule | string;

export type VariantDefinitions = Record<string, RecipeStyleRule>;
Expand Down Expand Up @@ -48,5 +52,6 @@ export type RuntimeFn<Variants extends VariantGroups> = ((
classNames: RecipeClassNames<Variants>;
};

export type RecipeVariants<RecipeFn extends RuntimeFn<VariantGroups>> =
Parameters<RecipeFn>[0];
export type RecipeVariants<RecipeFn extends RuntimeFn<VariantGroups>> = Resolve<
Parameters<RecipeFn>[0]
>;