react-polymorphed/index.d.ts at main · nasheomirro/react-polymorphed · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
import * as React from "react";

export {};

// ----------------------------------------------
// utility types
// ----------------------------------------------

type DistributiveOmit<T, K extends keyof any> = T extends any
  ? Omit<T, K>
  : never;

type Merge<A, B> = Omit<A, keyof B> & B;
type DistributiveMerge<A, B> = DistributiveOmit<A, keyof B> & B;

export type OnlyAs<T extends React.ElementType> =
  | T
  // makes sure `ComponentProps<T>` are unknown
  | (() => React.ReactElement<never>);

export type AsProps<
  Component extends React.ElementType,
  PermanentProps extends object,
  ComponentProps extends object
> = DistributiveMerge<ComponentProps, PermanentProps & { as?: Component }>;

/**
 * make typescript not check PropsWithRef<P> individually.
 * more info here: https://dev.to/nasheomirro/create-fast-type-safe-polymorphic-components-with-the-as-prop-ncn
 */
export type FastComponentPropsWithRef<T extends React.ElementType> =
  React.PropsWithRef<
    T extends new (props: infer P) => React.Component<any, any>
      ? React.PropsWithoutRef<P> & React.RefAttributes<InstanceType<T>>
      : React.ComponentProps<T>
  >;

export type PolymorphicPropsWithoutRef<
  Component extends React.ElementType,
  PermanentProps extends object
> = AsProps<
  Component,
  PermanentProps,
  React.ComponentPropsWithoutRef<Component>
>;

export type PolymorphicPropsWithRef<
  Component extends React.ElementType,
  PermanentProps extends object
> = AsProps<Component, PermanentProps, FastComponentPropsWithRef<Component>>;

// ----------------------------------------------
// call signatures
// ----------------------------------------------

export type PolymorphicWithoutRef<
  Default extends OnlyAs,
  Props extends object = {},
  OnlyAs extends React.ElementType = React.ElementType
> = <T extends OnlyAs = Default>(
  props: AsProps<T, Props, React.ComponentPropsWithoutRef<T>>
) => React.ReactElement | null;

export type PolymorphicWithRef<
  Default extends OnlyAs,
  Props extends object = {},
  OnlyAs extends React.ElementType = React.ElementType
> = <T extends OnlyAs = Default>(
  props: AsProps<T, Props, FastComponentPropsWithRef<T>>
) => React.ReactElement | null;

// ----------------------------------------------
// component types
// - note that Merge here is removing the default call signature.
// ----------------------------------------------

export interface PolymorphicComponent<
  Default extends OnlyAs,
  Props extends object = {},
  OnlyAs extends React.ElementType = React.ElementType
> extends PolymorphicWithoutRef<Default, Props, OnlyAs> {
  displayName?: string;
  propTypes?: React.WeakValidationMap<any>;
  contextTypes?: React.ValidationMap<any>;
  defaultProps?: Partial<any>;
  id?: string;
}

export type PolyMemoComponent<
  Default extends OnlyAs,
  Props extends object = {},
  OnlyAs extends React.ElementType = React.ElementType
> = Merge<
  React.MemoExoticComponent<React.ComponentType<Props>>,
  PolymorphicWithoutRef<Default, Props, OnlyAs>
>;

export type PolyLazyComponent<
  Default extends OnlyAs,
  Props extends object = {},
  OnlyAs extends React.ElementType = React.ElementType
> = Merge<
  React.LazyExoticComponent<React.ComponentType<Props>>,
  PolymorphicWithoutRef<Default, Props, OnlyAs>
>;

export type PolyForwardComponent<
  Default extends OnlyAs,
  Props extends object = {},
  OnlyAs extends React.ElementType = React.ElementType
> = Merge<
  React.ForwardRefExoticComponent<
    Merge<FastComponentPropsWithRef<Default>, Props & { as?: Default }>
  >,
  PolymorphicWithRef<Default, Props, OnlyAs>
>;

export type PolyForwardMemoComponent<
  Default extends OnlyAs,
  Props extends object = {},
  OnlyAs extends React.ElementType = React.ElementType
> = Merge<
  React.MemoExoticComponent<React.ComponentType<any>>,
  PolymorphicWithRef<Default, Props, OnlyAs>
>;

export type PolyForwardLazyComponent<
  Default extends OnlyAs,
  Props extends object = {},
  OnlyAs extends React.ElementType = React.ElementType
> = Merge<
  React.LazyExoticComponent<React.ComponentType<any>>,
  PolymorphicWithRef<Default, Props, OnlyAs>
>;

// ----------------------------------------------
// function types
// - got the idea from chakra-ui, cast at your own risk.
// ----------------------------------------------

export type PolyRefFunction = <
  Default extends OnlyAs,
  Props extends object = {},
  OnlyAs extends React.ElementType = React.ElementType
>(
  Component: React.ForwardRefRenderFunction<any, Props & { as?: OnlyAs }>
) => PolyForwardComponent<Default, Props, OnlyAs>;