update types / add VariantProps<Component> type

implydata · Jul 22, 2021 · d0a9451 · d0a9451
1 parent 161812b
commit d0a9451
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 4 deletions.
diff --git a/packages/core/types/index.d.ts b/packages/core/types/index.d.ts
@@ -29,6 +29,9 @@ export type PropertyValue<K extends keyof CSSUtil.CSSProperties> = { readonly [C
 /** Returns a type that expects a value to be a kind of theme scale value. */
 export type ScaleValue<K> = { readonly [CSSUtil.$$ScaleValue]: K }
 
+/** Returns a type that suggests variants from a component as possible prop values. */
+export type VariantProps<Component> = Component[StyledComponent.$$StyledComponentProps]
+
 /** Returns a library used to create styles. */
 export declare const createCss: CreateCss
 

diff --git a/packages/core/types/styled-component.d.ts b/packages/core/types/styled-component.d.ts
@@ -51,7 +51,7 @@ export declare const $$StyledComponentProps: unique symbol
 export type $$StyledComponentProps = typeof $$StyledComponentProps
 
 /** Returns the first Styled Component type from the given array of compositions. */
-type StyledComponentType<T extends any[]> = (
+export type StyledComponentType<T extends any[]> = (
 	T[0] extends never
 		? 'span'
 	: T[0] extends string
@@ -64,7 +64,7 @@ type StyledComponentType<T extends any[]> = (
 )
 
 /** Returns the cumulative variants from the given array of compositions. */
-type StyledComponentProps<T extends any[]> = (
+export type StyledComponentProps<T extends any[]> = (
 	& (
 		$$StyledComponentProps extends keyof T[0]
 			? T[0][$$StyledComponentProps]

diff --git a/packages/react/types/index.d.ts b/packages/react/types/index.d.ts
@@ -1,5 +1,6 @@
 import type CreateCss from './create-css'
 import type Sheet from './sheet'
+import type StyledComponent from './styled-component'
 
 import type * as CSSUtil from './css-util'
 import type * as Default from './default'
@@ -29,6 +30,9 @@ export type PropertyValue<K extends keyof CSSUtil.CSSProperties> = { readonly [C
 /** Returns a type that expects a value to be a kind of theme scale value. */
 export type ScaleValue<K> = { readonly [CSSUtil.$$ScaleValue]: K }
 
+/** Returns a type that suggests variants from a component as possible prop values. */
+export type VariantProps<Component> = Component[StyledComponent.$$StyledComponentProps]
+
 /** Returns a library used to create styles. */
 export declare const createCss: CreateCss
 

diff --git a/packages/react/types/styled-component.d.ts b/packages/react/types/styled-component.d.ts
@@ -87,7 +87,7 @@ type ForwardRefExoticComponent<ElementType, Props> = React.ForwardRefExoticCompo
 >
 
 /** Returns the first Styled Component type from the given array of compositions. */
-type StyledComponentType<T extends any[]> = (
+export type StyledComponentType<T extends any[]> = (
 	T[0] extends never
 		? 'span'
 	: T[0] extends string
@@ -100,7 +100,7 @@ type StyledComponentType<T extends any[]> = (
 )
 
 /** Returns the cumulative variants from the given array of compositions. */
-type StyledComponentProps<T extends any[]> = (
+export type StyledComponentProps<T extends any[]> = (
 	& (
 		$$StyledComponentProps extends keyof T[0]
 			? T[0][$$StyledComponentProps]