mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2026-10-03 22:37:03 +00:00
[styled-components] Update for TypeScript 3.7 (#40209)
Converts self-referential interfaces to recursive types to work around https://github.com/microsoft/TypeScript/issues/34796 Now that the types _really_ had to be updated for a new version, there's no longer any reason to keep compatibility definitions for old versions of TypeScript around, so removed the ones that were already marked as such. This fixes the types for the as= property.
This commit is contained in:
Jessica Franco
@@ -2,5 +2,9 @@
|
||||
"private": true,
|
||||
"dependencies": {
|
||||
"csstype": "^2.2.0"
|
||||
},
|
||||
"types": "index",
|
||||
"typesVersions": {
|
||||
">=3.7.0-0": { "*": ["ts3.7/*"] }
|
||||
}
|
||||
}
|
||||
|
||||
+19
@@ -0,0 +1,19 @@
|
||||
import {} from "react";
|
||||
import { CSSProp } from ".";
|
||||
|
||||
declare module "react" {
|
||||
interface Attributes {
|
||||
// NOTE: unlike the plain javascript version, it is not possible to get access
|
||||
// to the element's own attributes inside function interpolations.
|
||||
// Only theme will be accessible, and only with the DefaultTheme due to the global
|
||||
// nature of this declaration.
|
||||
// If you are writing this inline you already have access to all the attributes anyway,
|
||||
// no need for the extra indirection.
|
||||
/**
|
||||
* If present, this React element will be converted by
|
||||
* `babel-plugin-styled-components` into a styled component
|
||||
* with the given css as its styles.
|
||||
*/
|
||||
css?: CSSProp;
|
||||
}
|
||||
}
|
||||
+483
@@ -0,0 +1,483 @@
|
||||
// forward declarations
|
||||
declare global {
|
||||
namespace NodeJS {
|
||||
// tslint:disable-next-line:no-empty-interface
|
||||
interface ReadableStream {}
|
||||
}
|
||||
}
|
||||
|
||||
import * as CSS from "csstype";
|
||||
import * as React from "react";
|
||||
|
||||
export type CSSProperties = CSS.Properties<string | number>;
|
||||
|
||||
export type CSSPseudos = { [K in CSS.Pseudos]?: CSSObject };
|
||||
|
||||
export interface CSSObject extends CSSProperties, CSSPseudos {
|
||||
[key: string]: CSSObject | string | number | undefined;
|
||||
}
|
||||
|
||||
export type CSSKeyframes = object & { [key: string]: CSSObject };
|
||||
|
||||
export interface ThemeProps<T> {
|
||||
theme: T;
|
||||
}
|
||||
|
||||
export type ThemedStyledProps<P, T> = P & ThemeProps<T>;
|
||||
export type StyledProps<P> = ThemedStyledProps<P, AnyIfEmpty<DefaultTheme>>;
|
||||
|
||||
// Any prop that has a default prop becomes optional, but its type is unchanged
|
||||
// Undeclared default props are augmented into the resulting allowable attributes
|
||||
// If declared props have indexed properties, ignore default props entirely as keyof gets widened
|
||||
// Wrap in an outer-level conditional type to allow distribution over props that are unions
|
||||
type Defaultize<P, D> = P extends any
|
||||
? string extends keyof P ? P :
|
||||
& Pick<P, Exclude<keyof P, keyof D>>
|
||||
& Partial<Pick<P, Extract<keyof P, keyof D>>>
|
||||
& Partial<Pick<D, Exclude<keyof D, keyof P>>>
|
||||
: never;
|
||||
|
||||
type ReactDefaultizedProps<C, P> = C extends { defaultProps: infer D; }
|
||||
? Defaultize<P, D>
|
||||
: P;
|
||||
|
||||
export type StyledComponentProps<
|
||||
// The Component from whose props are derived
|
||||
C extends keyof JSX.IntrinsicElements | React.ComponentType<any>,
|
||||
// The Theme from the current context
|
||||
T extends object,
|
||||
// The other props added by the template
|
||||
O extends object,
|
||||
// The props that are made optional by .attrs
|
||||
A extends keyof any
|
||||
> =
|
||||
// Distribute O if O is a union type
|
||||
O extends object
|
||||
? WithOptionalTheme<
|
||||
Omit<ReactDefaultizedProps<C, React.ComponentPropsWithRef<C>> & O, A> &
|
||||
Partial<Pick<React.ComponentPropsWithRef<C> & O, A>>,
|
||||
T
|
||||
> &
|
||||
WithChildrenIfReactComponentClass<C>
|
||||
: never;
|
||||
|
||||
// Because of React typing quirks, when getting props from a React.ComponentClass,
|
||||
// we need to manually add a `children` field.
|
||||
// See https://github.com/DefinitelyTyped/DefinitelyTyped/pull/31945
|
||||
// and https://github.com/DefinitelyTyped/DefinitelyTyped/pull/32843
|
||||
type WithChildrenIfReactComponentClass<
|
||||
C extends keyof JSX.IntrinsicElements | React.ComponentType<any>
|
||||
> = C extends React.ComponentClass<any> ? { children?: React.ReactNode } : {};
|
||||
|
||||
type StyledComponentPropsWithAs<
|
||||
C extends keyof JSX.IntrinsicElements | React.ComponentType<any>,
|
||||
T extends object,
|
||||
O extends object,
|
||||
A extends keyof any
|
||||
> = StyledComponentProps<C, T, O, A> & { as?: C };
|
||||
|
||||
export type FalseyValue = undefined | null | false;
|
||||
export type Interpolation<P> =
|
||||
| InterpolationValue
|
||||
| InterpolationFunction<P>
|
||||
| FlattenInterpolation<P>;
|
||||
// cannot be made a self-referential interface, breaks WithPropNested
|
||||
// see https://github.com/microsoft/TypeScript/issues/34796
|
||||
export type FlattenInterpolation<P> = ReadonlyArray<Interpolation<P>>;
|
||||
export type InterpolationValue =
|
||||
| string
|
||||
| number
|
||||
| FalseyValue
|
||||
| Keyframes
|
||||
| StyledComponentInterpolation
|
||||
| CSSObject;
|
||||
export type SimpleInterpolation =
|
||||
| InterpolationValue
|
||||
| FlattenSimpleInterpolation;
|
||||
export type FlattenSimpleInterpolation = ReadonlyArray<SimpleInterpolation>;
|
||||
|
||||
export type InterpolationFunction<P> = (props: P) => Interpolation<P>;
|
||||
|
||||
type Attrs<P, A extends Partial<P>, T> =
|
||||
| ((props: ThemedStyledProps<P, T>) => A)
|
||||
| A;
|
||||
type DeprecatedAttrs<P, A extends Partial<P>, T> = {
|
||||
[K in keyof A]: ((props: ThemedStyledProps<P, T>) => A[K]) | A[K]
|
||||
};
|
||||
|
||||
export type ThemedGlobalStyledClassProps<P, T> = WithOptionalTheme<P, T> & {
|
||||
suppressMultiMountWarning?: boolean;
|
||||
};
|
||||
|
||||
export interface GlobalStyleComponent<P, T>
|
||||
extends React.ComponentClass<ThemedGlobalStyledClassProps<P, T>> {}
|
||||
|
||||
// remove the call signature from StyledComponent so Interpolation can still infer InterpolationFunction
|
||||
type StyledComponentInterpolation =
|
||||
| Pick<
|
||||
StyledComponentBase<any, any, any, any>,
|
||||
keyof StyledComponentBase<any, any>
|
||||
>
|
||||
| Pick<
|
||||
StyledComponentBase<any, any, any>,
|
||||
keyof StyledComponentBase<any, any>
|
||||
>;
|
||||
|
||||
// abuse Pick to strip the call signature from ForwardRefExoticComponent
|
||||
type ForwardRefExoticBase<P> = Pick<
|
||||
React.ForwardRefExoticComponent<P>,
|
||||
keyof React.ForwardRefExoticComponent<any>
|
||||
>;
|
||||
|
||||
// extracts React defaultProps
|
||||
type ReactDefaultProps<C> = C extends { defaultProps: infer D; } ? D : never;
|
||||
|
||||
// any doesn't count as assignable to never in the extends clause, and we default A to never
|
||||
export type AnyStyledComponent =
|
||||
| StyledComponent<any, any, any, any>
|
||||
| StyledComponent<any, any, any>;
|
||||
|
||||
export type StyledComponent<
|
||||
C extends keyof JSX.IntrinsicElements | React.ComponentType<any>,
|
||||
T extends object,
|
||||
O extends object = {},
|
||||
A extends keyof any = never
|
||||
> = // the "string" allows this to be used as an object key
|
||||
// I really want to avoid this if possible but it's the only way to use nesting with object styles...
|
||||
string & StyledComponentBase<C, T, O, A>;
|
||||
|
||||
export interface StyledComponentBase<
|
||||
C extends keyof JSX.IntrinsicElements | React.ComponentType<any>,
|
||||
T extends object,
|
||||
O extends object = {},
|
||||
A extends keyof any = never
|
||||
> extends ForwardRefExoticBase<StyledComponentProps<C, T, O, A>> {
|
||||
// add our own fake call signature to implement the polymorphic 'as' prop
|
||||
(
|
||||
props: StyledComponentProps<C, T, O, A> & { as?: never }
|
||||
): React.ReactElement<StyledComponentProps<C, T, O, A>>;
|
||||
<AsC extends keyof JSX.IntrinsicElements | React.ComponentType<any> = C>(
|
||||
props: StyledComponentPropsWithAs<AsC, T, O, A>
|
||||
): React.ReactElement<StyledComponentPropsWithAs<AsC, T, O, A>>;
|
||||
|
||||
withComponent<WithC extends AnyStyledComponent>(
|
||||
component: WithC
|
||||
): StyledComponent<
|
||||
StyledComponentInnerComponent<WithC>,
|
||||
T,
|
||||
O & StyledComponentInnerOtherProps<WithC>,
|
||||
A | StyledComponentInnerAttrs<WithC>
|
||||
>;
|
||||
withComponent<
|
||||
WithC extends keyof JSX.IntrinsicElements | React.ComponentType<any>
|
||||
>(
|
||||
component: WithC
|
||||
): StyledComponent<WithC, T, O, A>;
|
||||
}
|
||||
|
||||
export interface ThemedStyledFunctionBase<
|
||||
C extends keyof JSX.IntrinsicElements | React.ComponentType<any>,
|
||||
T extends object,
|
||||
O extends object = {},
|
||||
A extends keyof any = never
|
||||
> {
|
||||
(first: TemplateStringsArray): StyledComponent<C, T, O, A>;
|
||||
(
|
||||
first:
|
||||
| TemplateStringsArray
|
||||
| CSSObject
|
||||
| InterpolationFunction<
|
||||
ThemedStyledProps<StyledComponentPropsWithRef<C> & O, T>
|
||||
>,
|
||||
...rest: Array<
|
||||
Interpolation<
|
||||
ThemedStyledProps<StyledComponentPropsWithRef<C> & O, T>
|
||||
>
|
||||
>
|
||||
): StyledComponent<C, T, O, A>;
|
||||
<U extends object>(
|
||||
first:
|
||||
| TemplateStringsArray
|
||||
| CSSObject
|
||||
| InterpolationFunction<
|
||||
ThemedStyledProps<StyledComponentPropsWithRef<C> & O & U, T>
|
||||
>,
|
||||
...rest: Array<
|
||||
Interpolation<
|
||||
ThemedStyledProps<StyledComponentPropsWithRef<C> & O & U, T>
|
||||
>
|
||||
>
|
||||
): StyledComponent<C, T, O & U, A>;
|
||||
}
|
||||
|
||||
export interface ThemedStyledFunction<
|
||||
C extends keyof JSX.IntrinsicElements | React.ComponentType<any>,
|
||||
T extends object,
|
||||
O extends object = {},
|
||||
A extends keyof any = never
|
||||
> extends ThemedStyledFunctionBase<C, T, O, A> {
|
||||
// Fun thing: 'attrs' can also provide a polymorphic 'as' prop
|
||||
// My head already hurts enough so maybe later...
|
||||
attrs<
|
||||
U,
|
||||
NewA extends Partial<StyledComponentPropsWithRef<C> & U> & {
|
||||
[others: string]: any;
|
||||
} = {}
|
||||
>(
|
||||
attrs: Attrs<StyledComponentPropsWithRef<C> & U, NewA, T>
|
||||
): ThemedStyledFunction<C, T, O & NewA, A | keyof NewA>;
|
||||
// Only this overload is deprecated
|
||||
// tslint:disable:unified-signatures
|
||||
/** @deprecated Prefer using the new single function style, to be removed in v5 */
|
||||
attrs<
|
||||
U,
|
||||
NewA extends Partial<StyledComponentPropsWithRef<C> & U> & {
|
||||
[others: string]: any;
|
||||
} = {}
|
||||
>(
|
||||
attrs: DeprecatedAttrs<StyledComponentPropsWithRef<C> & U, NewA, T>
|
||||
): ThemedStyledFunction<C, T, O & NewA, A | keyof NewA>;
|
||||
// tslint:enable:unified-signatures
|
||||
}
|
||||
|
||||
export type StyledFunction<
|
||||
C extends keyof JSX.IntrinsicElements | React.ComponentType<any>
|
||||
> = ThemedStyledFunction<C, any>;
|
||||
|
||||
type ThemedStyledComponentFactories<T extends object> = {
|
||||
[TTag in keyof JSX.IntrinsicElements]: ThemedStyledFunction<TTag, T>
|
||||
};
|
||||
|
||||
export type StyledComponentInnerComponent<
|
||||
C extends React.ComponentType<any>
|
||||
> = C extends
|
||||
| StyledComponent<infer I, any, any, any>
|
||||
| StyledComponent<infer I, any, any>
|
||||
? I
|
||||
: C;
|
||||
export type StyledComponentPropsWithRef<
|
||||
C extends keyof JSX.IntrinsicElements | React.ComponentType<any>
|
||||
> = C extends AnyStyledComponent
|
||||
? React.ComponentPropsWithRef<StyledComponentInnerComponent<C>>
|
||||
: React.ComponentPropsWithRef<C>;
|
||||
export type StyledComponentInnerOtherProps<C extends AnyStyledComponent> = C extends
|
||||
| StyledComponent<any, any, infer O, any>
|
||||
| StyledComponent<any, any, infer O>
|
||||
? O
|
||||
: never;
|
||||
export type StyledComponentInnerAttrs<
|
||||
C extends AnyStyledComponent
|
||||
> = C extends StyledComponent<any, any, any, infer A> ? A : never;
|
||||
|
||||
export interface ThemedBaseStyledInterface<T extends object>
|
||||
extends ThemedStyledComponentFactories<T> {
|
||||
<C extends AnyStyledComponent>(component: C): ThemedStyledFunction<
|
||||
StyledComponentInnerComponent<C>,
|
||||
T,
|
||||
StyledComponentInnerOtherProps<C>,
|
||||
StyledComponentInnerAttrs<C>
|
||||
>;
|
||||
<C extends keyof JSX.IntrinsicElements | React.ComponentType<any>>(
|
||||
// unfortunately using a conditional type to validate that it can receive a `theme?: Theme`
|
||||
// causes tests to fail in TS 3.1
|
||||
component: C
|
||||
): ThemedStyledFunction<C, T>;
|
||||
}
|
||||
|
||||
export type ThemedStyledInterface<T extends object> = ThemedBaseStyledInterface<
|
||||
AnyIfEmpty<T>
|
||||
>;
|
||||
export type StyledInterface = ThemedStyledInterface<DefaultTheme>;
|
||||
|
||||
export interface BaseThemedCssFunction<T extends object> {
|
||||
(
|
||||
first: TemplateStringsArray | CSSObject,
|
||||
...interpolations: SimpleInterpolation[]
|
||||
): FlattenSimpleInterpolation;
|
||||
(
|
||||
first:
|
||||
| TemplateStringsArray
|
||||
| CSSObject
|
||||
| InterpolationFunction<ThemedStyledProps<{}, T>>,
|
||||
...interpolations: Array<Interpolation<ThemedStyledProps<{}, T>>>
|
||||
): FlattenInterpolation<ThemedStyledProps<{}, T>>;
|
||||
<P extends object>(
|
||||
first:
|
||||
| TemplateStringsArray
|
||||
| CSSObject
|
||||
| InterpolationFunction<ThemedStyledProps<P, T>>,
|
||||
...interpolations: Array<Interpolation<ThemedStyledProps<P, T>>>
|
||||
): FlattenInterpolation<ThemedStyledProps<P, T>>;
|
||||
}
|
||||
|
||||
export type ThemedCssFunction<T extends object> = BaseThemedCssFunction<
|
||||
AnyIfEmpty<T>
|
||||
>;
|
||||
|
||||
// Helper type operators
|
||||
type Omit<T, K extends keyof T> = Pick<T, Exclude<keyof T, K>>;
|
||||
type WithOptionalTheme<P extends { theme?: T }, T> = Omit<P, "theme"> & {
|
||||
theme?: T;
|
||||
};
|
||||
type AnyIfEmpty<T extends object> = keyof T extends never ? any : T;
|
||||
|
||||
export interface ThemedStyledComponentsModule<
|
||||
T extends object,
|
||||
U extends object = T
|
||||
> {
|
||||
default: ThemedStyledInterface<T>;
|
||||
|
||||
css: ThemedCssFunction<T>;
|
||||
|
||||
// unfortunately keyframes can't interpolate props from the theme
|
||||
keyframes(
|
||||
strings: TemplateStringsArray | CSSKeyframes,
|
||||
...interpolations: SimpleInterpolation[]
|
||||
): Keyframes;
|
||||
|
||||
createGlobalStyle<P extends object = {}>(
|
||||
first:
|
||||
| TemplateStringsArray
|
||||
| CSSObject
|
||||
| InterpolationFunction<ThemedStyledProps<P, T>>,
|
||||
...interpolations: Array<Interpolation<ThemedStyledProps<P, T>>>
|
||||
): GlobalStyleComponent<P, T>;
|
||||
|
||||
withTheme: WithThemeFnInterface<T>;
|
||||
ThemeProvider: ThemeProviderComponent<T, U>;
|
||||
ThemeConsumer: React.Consumer<T>;
|
||||
ThemeContext: React.Context<T>;
|
||||
|
||||
// This could be made to assert `target is StyledComponent<any, T>` instead, but that feels not type safe
|
||||
isStyledComponent: typeof isStyledComponent;
|
||||
|
||||
ServerStyleSheet: typeof ServerStyleSheet;
|
||||
StyleSheetManager: typeof StyleSheetManager;
|
||||
}
|
||||
|
||||
declare const styled: StyledInterface;
|
||||
|
||||
export const css: ThemedCssFunction<DefaultTheme>;
|
||||
|
||||
export type BaseWithThemeFnInterface<T extends object> = <
|
||||
C extends React.ComponentType<any>
|
||||
>(
|
||||
// this check is roundabout because the extends clause above would
|
||||
// not allow any component that accepts _more_ than theme as a prop
|
||||
component: React.ComponentProps<C> extends { theme?: T } ? C : never
|
||||
) => React.ForwardRefExoticComponent<
|
||||
WithOptionalTheme<React.ComponentPropsWithRef<C>, T>
|
||||
>;
|
||||
export type WithThemeFnInterface<T extends object> = BaseWithThemeFnInterface<
|
||||
AnyIfEmpty<T>
|
||||
>;
|
||||
export const withTheme: WithThemeFnInterface<DefaultTheme>;
|
||||
|
||||
/**
|
||||
* This interface can be augmented by users to add types to `styled-components`' default theme
|
||||
* without needing to reexport `ThemedStyledComponentsModule`.
|
||||
*/
|
||||
// Unfortunately, there is no way to write tests for this
|
||||
// as any augmentation will break the tests for the default case (not augmented).
|
||||
// tslint:disable-next-line:no-empty-interface
|
||||
export interface DefaultTheme {}
|
||||
|
||||
export interface ThemeProviderProps<T extends object, U extends object = T> {
|
||||
children?: React.ReactChild; // only one child is allowed, goes through React.Children.only
|
||||
theme: T | ((theme: U) => T);
|
||||
}
|
||||
export type BaseThemeProviderComponent<
|
||||
T extends object,
|
||||
U extends object = T
|
||||
> = React.ComponentClass<ThemeProviderProps<T, U>>;
|
||||
export type ThemeProviderComponent<
|
||||
T extends object,
|
||||
U extends object = T
|
||||
> = BaseThemeProviderComponent<AnyIfEmpty<T>, AnyIfEmpty<U>>;
|
||||
export const ThemeProvider: ThemeProviderComponent<AnyIfEmpty<DefaultTheme>>;
|
||||
// NOTE: this technically starts as undefined, but allowing undefined is unhelpful when used correctly
|
||||
export const ThemeContext: React.Context<AnyIfEmpty<DefaultTheme>>;
|
||||
export const ThemeConsumer: typeof ThemeContext["Consumer"];
|
||||
|
||||
export interface Keyframes {
|
||||
getName(): string;
|
||||
}
|
||||
|
||||
export function keyframes(
|
||||
strings: TemplateStringsArray | CSSKeyframes,
|
||||
...interpolations: SimpleInterpolation[]
|
||||
): Keyframes;
|
||||
|
||||
export function createGlobalStyle<P extends object = {}>(
|
||||
first:
|
||||
| TemplateStringsArray
|
||||
| CSSObject
|
||||
| InterpolationFunction<ThemedStyledProps<P, DefaultTheme>>,
|
||||
...interpolations: Array<Interpolation<ThemedStyledProps<P, DefaultTheme>>>
|
||||
): GlobalStyleComponent<P, DefaultTheme>;
|
||||
|
||||
export function isStyledComponent(
|
||||
target: any
|
||||
): target is StyledComponent<any, any>;
|
||||
|
||||
export class ServerStyleSheet {
|
||||
collectStyles(
|
||||
tree: React.ReactNode
|
||||
): React.ReactElement<{ sheet: ServerStyleSheet }>;
|
||||
|
||||
getStyleTags(): string;
|
||||
getStyleElement(): Array<React.ReactElement<{}>>;
|
||||
interleaveWithNodeStream(
|
||||
readableStream: NodeJS.ReadableStream
|
||||
): NodeJS.ReadableStream;
|
||||
readonly instance: this;
|
||||
seal(): void;
|
||||
}
|
||||
|
||||
type StyleSheetManagerProps =
|
||||
| {
|
||||
sheet: ServerStyleSheet;
|
||||
target?: never;
|
||||
}
|
||||
| {
|
||||
sheet?: never;
|
||||
target: HTMLElement;
|
||||
};
|
||||
|
||||
export class StyleSheetManager extends React.Component<
|
||||
StyleSheetManagerProps
|
||||
> {}
|
||||
|
||||
/**
|
||||
* The CSS prop is not declared by default in the types as it would cause 'css' to be present
|
||||
* on the types of anything that uses styled-components indirectly, even if they do not use the
|
||||
* babel plugin.
|
||||
*
|
||||
* You can load a default declaration by using writing this special import from
|
||||
* a typescript file. This module does not exist in reality, which is why the {} is important:
|
||||
*
|
||||
* ```ts
|
||||
* import {} from 'styled-components/cssprop'
|
||||
* ```
|
||||
*
|
||||
* Or you can declare your own module augmentation, which allows you to specify the type of Theme:
|
||||
*
|
||||
* ```ts
|
||||
* import { CSSProp } from 'styled-components'
|
||||
*
|
||||
* interface MyTheme {}
|
||||
*
|
||||
* declare module 'react' {
|
||||
* interface Attributes {
|
||||
* css?: CSSProp<MyTheme>
|
||||
* }
|
||||
* }
|
||||
* ```
|
||||
*/
|
||||
// ONLY string literals and inline invocations of css`` are supported, anything else crashes the plugin
|
||||
export type CSSProp<T = AnyIfEmpty<DefaultTheme>> =
|
||||
| string
|
||||
| CSSObject
|
||||
| FlattenInterpolation<ThemeProps<T>>;
|
||||
|
||||
export default styled;
|
||||
+7
@@ -0,0 +1,7 @@
|
||||
export { default } from '.';
|
||||
export * from '.';
|
||||
|
||||
/**
|
||||
* Recommended: also `import {} from 'styled-components/cssprop'`,
|
||||
* or augment react's `Attribute` interface with your own version.
|
||||
*/
|
||||
+229
@@ -0,0 +1,229 @@
|
||||
import * as ReactNative from 'react-native';
|
||||
import * as React from 'react';
|
||||
|
||||
export {
|
||||
css,
|
||||
DefaultTheme,
|
||||
isStyledComponent,
|
||||
ThemeConsumer,
|
||||
ThemeContext,
|
||||
ThemeProps,
|
||||
ThemeProvider,
|
||||
withTheme,
|
||||
} from './index';
|
||||
|
||||
import {
|
||||
AnyStyledComponent,
|
||||
DefaultTheme,
|
||||
isStyledComponent,
|
||||
StyledComponentInnerAttrs,
|
||||
StyledComponentInnerComponent,
|
||||
StyledComponentInnerOtherProps,
|
||||
ThemedCssFunction,
|
||||
ThemedStyledFunction,
|
||||
ThemedStyledInterface,
|
||||
ThemeProviderComponent,
|
||||
WithThemeFnInterface
|
||||
} from './index';
|
||||
|
||||
type AnyIfEmpty<T extends object> = keyof T extends never ? any : T;
|
||||
|
||||
export type ReactNativeThemedStyledFunction<
|
||||
C extends React.ComponentType<any>,
|
||||
T extends object,
|
||||
> = ThemedStyledFunction<C, T>;
|
||||
|
||||
// Copied over from "ThemedBaseStyledInterface" in index.d.ts in order to remove DOM element typings
|
||||
interface ReactNativeThemedBaseStyledInterface<T extends object> {
|
||||
<C extends AnyStyledComponent>(component: C): ThemedStyledFunction<
|
||||
StyledComponentInnerComponent<C>,
|
||||
T,
|
||||
StyledComponentInnerOtherProps<C>,
|
||||
StyledComponentInnerAttrs<C>
|
||||
>;
|
||||
<C extends React.ComponentType<any>>(
|
||||
// unfortunately using a conditional type to validate that it can receive a `theme?: Theme`
|
||||
// causes tests to fail in TS 3.1
|
||||
component: C
|
||||
): ThemedStyledFunction<C, T>;
|
||||
}
|
||||
|
||||
type ReactNativeThemedStyledInterface<T extends object> = ReactNativeThemedBaseStyledInterface<
|
||||
AnyIfEmpty<T>
|
||||
>;
|
||||
|
||||
export interface ReactNativeStyledInterface<T extends object> extends ReactNativeThemedStyledInterface<T> {
|
||||
ActivityIndicator: ReactNativeThemedStyledFunction<
|
||||
typeof ReactNative.ActivityIndicator,
|
||||
T
|
||||
>;
|
||||
ActivityIndicatorIOS: ReactNativeThemedStyledFunction<
|
||||
typeof ReactNative.ActivityIndicator,
|
||||
T
|
||||
>;
|
||||
Button: ReactNativeThemedStyledFunction<
|
||||
typeof ReactNative.Button,
|
||||
T
|
||||
>;
|
||||
DatePickerIOS: ReactNativeThemedStyledFunction<
|
||||
typeof ReactNative.DatePickerIOS,
|
||||
T
|
||||
>;
|
||||
DrawerLayoutAndroid: ReactNativeThemedStyledFunction<
|
||||
typeof ReactNative.DrawerLayoutAndroid,
|
||||
T
|
||||
>;
|
||||
Image: ReactNativeThemedStyledFunction<
|
||||
typeof ReactNative.Image,
|
||||
T
|
||||
>;
|
||||
ImageBackground: ReactNativeThemedStyledFunction<
|
||||
typeof ReactNative.ImageBackground,
|
||||
T
|
||||
>;
|
||||
KeyboardAvoidingView: ReactNativeThemedStyledFunction<
|
||||
typeof ReactNative.KeyboardAvoidingView,
|
||||
T
|
||||
>;
|
||||
ListView: ReactNativeThemedStyledFunction<
|
||||
typeof ReactNative.ListView,
|
||||
T
|
||||
>;
|
||||
Modal: ReactNativeThemedStyledFunction<
|
||||
typeof ReactNative.Modal,
|
||||
T
|
||||
>;
|
||||
NavigatorIOS: ReactNativeThemedStyledFunction<
|
||||
typeof ReactNative.NavigatorIOS,
|
||||
T
|
||||
>;
|
||||
Picker: ReactNativeThemedStyledFunction<
|
||||
typeof ReactNative.Picker,
|
||||
T
|
||||
>;
|
||||
PickerIOS: ReactNativeThemedStyledFunction<
|
||||
typeof ReactNative.PickerIOS,
|
||||
T
|
||||
>;
|
||||
ProgressBarAndroid: ReactNativeThemedStyledFunction<
|
||||
typeof ReactNative.ProgressBarAndroid,
|
||||
T
|
||||
>;
|
||||
ProgressViewIOS: ReactNativeThemedStyledFunction<
|
||||
typeof ReactNative.ProgressViewIOS,
|
||||
T
|
||||
>;
|
||||
ScrollView: ReactNativeThemedStyledFunction<
|
||||
typeof ReactNative.ScrollView,
|
||||
T
|
||||
>;
|
||||
SegmentedControlIOS: ReactNativeThemedStyledFunction<
|
||||
typeof ReactNative.SegmentedControlIOS,
|
||||
T
|
||||
>;
|
||||
Slider: ReactNativeThemedStyledFunction<
|
||||
typeof ReactNative.Slider,
|
||||
T
|
||||
>;
|
||||
SliderIOS: ReactNativeThemedStyledFunction<
|
||||
typeof ReactNative.Slider,
|
||||
T
|
||||
>;
|
||||
SnapshotViewIOS: ReactNativeThemedStyledFunction<
|
||||
typeof ReactNative.SnapshotViewIOS,
|
||||
T
|
||||
>;
|
||||
Switch: ReactNativeThemedStyledFunction<
|
||||
typeof ReactNative.Switch,
|
||||
T
|
||||
>;
|
||||
RecyclerViewBackedScrollView: ReactNativeThemedStyledFunction<
|
||||
typeof ReactNative.RecyclerViewBackedScrollView,
|
||||
T
|
||||
>;
|
||||
RefreshControl: ReactNativeThemedStyledFunction<
|
||||
typeof ReactNative.RefreshControl,
|
||||
T
|
||||
>;
|
||||
SafeAreaView: ReactNativeThemedStyledFunction<
|
||||
typeof ReactNative.SafeAreaView,
|
||||
T
|
||||
>;
|
||||
StatusBar: ReactNativeThemedStyledFunction<
|
||||
typeof ReactNative.StatusBar,
|
||||
T
|
||||
>;
|
||||
SwipeableListView: ReactNativeThemedStyledFunction<
|
||||
typeof ReactNative.SwipeableListView,
|
||||
T
|
||||
>;
|
||||
SwitchAndroid: ReactNativeThemedStyledFunction<
|
||||
typeof ReactNative.Switch,
|
||||
T
|
||||
>;
|
||||
SwitchIOS: ReactNativeThemedStyledFunction<
|
||||
typeof ReactNative.SwitchIOS,
|
||||
T
|
||||
>;
|
||||
TabBarIOS: ReactNativeThemedStyledFunction<
|
||||
typeof ReactNative.TabBarIOS,
|
||||
T
|
||||
>;
|
||||
Text: ReactNativeThemedStyledFunction<
|
||||
typeof ReactNative.Text,
|
||||
T
|
||||
>;
|
||||
TextInput: ReactNativeThemedStyledFunction<
|
||||
typeof ReactNative.TextInput,
|
||||
T
|
||||
>;
|
||||
ToolbarAndroid: ReactNativeThemedStyledFunction<
|
||||
typeof ReactNative.ToolbarAndroid,
|
||||
T
|
||||
>;
|
||||
TouchableHighlight: ReactNativeThemedStyledFunction<
|
||||
typeof ReactNative.TouchableHighlight,
|
||||
T
|
||||
>;
|
||||
TouchableNativeFeedback: ReactNativeThemedStyledFunction<
|
||||
typeof ReactNative.TouchableNativeFeedback,
|
||||
T
|
||||
>;
|
||||
TouchableOpacity: ReactNativeThemedStyledFunction<
|
||||
typeof ReactNative.TouchableOpacity,
|
||||
T
|
||||
>;
|
||||
TouchableWithoutFeedback: ReactNativeThemedStyledFunction<
|
||||
typeof ReactNative.TouchableWithoutFeedback,
|
||||
T
|
||||
>;
|
||||
View: ReactNativeThemedStyledFunction<
|
||||
typeof ReactNative.View,
|
||||
T
|
||||
>;
|
||||
ViewPagerAndroid: ReactNativeThemedStyledFunction<
|
||||
typeof ReactNative.ViewPagerAndroid,
|
||||
T
|
||||
>;
|
||||
}
|
||||
|
||||
export interface ReactNativeThemedStyledComponentsModule<
|
||||
T extends object,
|
||||
U extends object = T
|
||||
> {
|
||||
default: ReactNativeStyledInterface<T>;
|
||||
|
||||
css: ThemedCssFunction<T>;
|
||||
|
||||
withTheme: WithThemeFnInterface<T>;
|
||||
ThemeProvider: ThemeProviderComponent<T, U>;
|
||||
ThemeConsumer: React.Consumer<T>;
|
||||
ThemeContext: React.Context<T>;
|
||||
|
||||
// This could be made to assert `target is StyledComponent<any, T>` instead, but that feels not type safe
|
||||
isStyledComponent: typeof isStyledComponent;
|
||||
}
|
||||
|
||||
declare const styled: ReactNativeStyledInterface<DefaultTheme>;
|
||||
|
||||
export default styled;
|
||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,20 @@
|
||||
import styled, { createGlobalStyle } from 'styled-components/macro';
|
||||
|
||||
// Check that the default export works.
|
||||
const TitleFromMacro = styled.h1`
|
||||
font-size: 1.5em;
|
||||
text-align: center;
|
||||
color: palevioletred;
|
||||
`;
|
||||
|
||||
// Check that named exports work as well.
|
||||
const GlobalStyleFromMacro = createGlobalStyle`
|
||||
@font-face {
|
||||
font-family: 'Operator Mono';
|
||||
src: url('../fonts/Operator-Mono.ttf');
|
||||
}
|
||||
|
||||
body {
|
||||
margin: 0;
|
||||
}
|
||||
`;
|
||||
@@ -0,0 +1,198 @@
|
||||
import * as React from "react";
|
||||
import * as ReactNative from "react-native";
|
||||
import * as ReactDOMServer from "react-dom/server";
|
||||
|
||||
import styled, {
|
||||
css,
|
||||
isStyledComponent,
|
||||
ThemeProps,
|
||||
ThemeProvider,
|
||||
withTheme,
|
||||
ThemeConsumer,
|
||||
ReactNativeThemedStyledComponentsModule,
|
||||
} from "styled-components/native";
|
||||
import {} from "styled-components/cssprop";
|
||||
|
||||
const StyledView = styled.View`
|
||||
background-color: papayawhip;
|
||||
`;
|
||||
|
||||
const StyledText = styled(ReactNative.Text)`
|
||||
color: palevioletred;
|
||||
`;
|
||||
|
||||
class MyReactNativeComponent extends React.Component {
|
||||
render() {
|
||||
return (
|
||||
<StyledView>
|
||||
<StyledText>Hello World!</StyledText>
|
||||
</StyledView>
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
const ValidProp = <StyledText adjustsFontSizeToFit />;
|
||||
const invalidProp = <StyledText randoName={2} />; // $ExpectError
|
||||
const invalidTag = styled.div` margin-top: 5px; `; // $ExpectError
|
||||
|
||||
interface MyTheme {
|
||||
primary: string;
|
||||
}
|
||||
|
||||
interface ButtonProps {
|
||||
name: string;
|
||||
primary?: boolean;
|
||||
theme: MyTheme;
|
||||
}
|
||||
|
||||
class MyButton extends React.Component<ButtonProps> {
|
||||
render() {
|
||||
return <ReactNative.TouchableOpacity>Custom button</ReactNative.TouchableOpacity>;
|
||||
}
|
||||
}
|
||||
|
||||
const TomatoButton = styled(MyButton)`
|
||||
color: tomato;
|
||||
border-color: tomato;
|
||||
`;
|
||||
|
||||
// needs name prop, but not theme prop
|
||||
const tomatoElement = <TomatoButton name="needed" />;
|
||||
|
||||
async function typedThemes() {
|
||||
const theme = {
|
||||
color: "green"
|
||||
};
|
||||
|
||||
// abuse "await import(...)" to be able to reference the styled-components namespace
|
||||
// without actually doing a top level namespace import
|
||||
const {
|
||||
default: styled,
|
||||
css,
|
||||
ThemeProvider,
|
||||
ThemeConsumer
|
||||
} = (await import("styled-components/native")) as any as ReactNativeThemedStyledComponentsModule<
|
||||
typeof theme
|
||||
>;
|
||||
|
||||
const ThemedView = styled.View`
|
||||
background: ${props => {
|
||||
// $ExpectType string
|
||||
props.theme.color;
|
||||
// $ExpectType string | undefined
|
||||
props.testID;
|
||||
return props.theme.color;
|
||||
}};
|
||||
`;
|
||||
const ThemedView2 = styled.View(props => {
|
||||
// $ExpectType string
|
||||
props.theme.color;
|
||||
// $ExpectType string | undefined
|
||||
props.testID;
|
||||
|
||||
return {
|
||||
background: props.theme.color
|
||||
};
|
||||
});
|
||||
const ThemedView3 = styled.View(props => {
|
||||
// $ExpectType string
|
||||
props.theme.color;
|
||||
// $ExpectType string | undefined
|
||||
props.testID;
|
||||
|
||||
return css`
|
||||
background: ${props.theme.color};
|
||||
`;
|
||||
});
|
||||
const themedCss = css`
|
||||
background: ${props => {
|
||||
// $ExpectType string
|
||||
props.theme.color;
|
||||
// $ExpectType "theme"
|
||||
type Keys = keyof typeof props;
|
||||
return props.theme.color;
|
||||
}};
|
||||
`;
|
||||
// can't use a FlattenInterpolation as the first argument, would make broken css
|
||||
// $ExpectError
|
||||
const ThemedView4 = styled.View(themedCss);
|
||||
|
||||
const themedCssWithNesting = css(props => ({
|
||||
color: props.theme.color,
|
||||
[ThemedView3]: {
|
||||
color: "green"
|
||||
}
|
||||
}));
|
||||
|
||||
return (
|
||||
<ThemeProvider theme={theme}>
|
||||
<>
|
||||
<ThemedView />
|
||||
<ThemedView2 />
|
||||
<ThemedView3 />
|
||||
<ThemeConsumer>
|
||||
{theme => {
|
||||
// $ExpectType string
|
||||
theme.color;
|
||||
return theme.color;
|
||||
}}
|
||||
</ThemeConsumer>
|
||||
</>
|
||||
</ThemeProvider>
|
||||
);
|
||||
}
|
||||
|
||||
async function reexportCompatibility() {
|
||||
const sc = await import("styled-components/native");
|
||||
const themed = sc as ReactNativeThemedStyledComponentsModule<any>;
|
||||
|
||||
let { ...scExports } = sc;
|
||||
let { ...themedExports } = themed;
|
||||
// both branches must be assignable to each other
|
||||
if (Math.random()) {
|
||||
scExports = themedExports;
|
||||
} else {
|
||||
themedExports = scExports;
|
||||
}
|
||||
}
|
||||
|
||||
async function themeAugmentation() {
|
||||
interface BaseTheme {
|
||||
background: string;
|
||||
}
|
||||
interface ExtraTheme extends BaseTheme {
|
||||
accent: string;
|
||||
}
|
||||
|
||||
const base = (await import("styled-components/native")) as any as ReactNativeThemedStyledComponentsModule<
|
||||
BaseTheme
|
||||
>;
|
||||
const extra = (await import("styled-components/native")) as any as ReactNativeThemedStyledComponentsModule<
|
||||
ExtraTheme,
|
||||
BaseTheme
|
||||
>;
|
||||
|
||||
return (
|
||||
<base.ThemeProvider
|
||||
theme={{
|
||||
background: "black"
|
||||
}}
|
||||
>
|
||||
<>
|
||||
<extra.ThemeProvider
|
||||
theme={base => base} // $ExpectError
|
||||
>
|
||||
<extra.ThemeConsumer>{() => null}</extra.ThemeConsumer>
|
||||
</extra.ThemeProvider>
|
||||
<extra.ThemeProvider
|
||||
theme={base => ({
|
||||
...base,
|
||||
accent: "blue"
|
||||
})}
|
||||
>
|
||||
<extra.ThemeConsumer>{() => null}</extra.ThemeConsumer>
|
||||
</extra.ThemeProvider>
|
||||
</>
|
||||
</base.ThemeProvider>
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,29 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"baseUrl": "../../",
|
||||
"forceConsistentCasingInFileNames": true,
|
||||
"jsx": "react",
|
||||
"lib": [
|
||||
"es6"
|
||||
],
|
||||
"module": "commonjs",
|
||||
"noEmit": true,
|
||||
"noImplicitAny": true,
|
||||
"noImplicitThis": true,
|
||||
"strictFunctionTypes": true,
|
||||
"strictNullChecks": true,
|
||||
"typeRoots": [
|
||||
"../../"
|
||||
],
|
||||
"types": []
|
||||
},
|
||||
"files": [
|
||||
"index.d.ts",
|
||||
"native.d.ts",
|
||||
"macro.d.ts",
|
||||
"cssprop.d.ts",
|
||||
"test/index.tsx",
|
||||
"test/native.tsx",
|
||||
"test/macro.tsx"
|
||||
]
|
||||
}
|
||||
@@ -0,0 +1 @@
|
||||
{ "extends": "dtslint/dt.json" }
|
||||
Reference in New Issue
Block a user