1 |
|
2 | import * as ReactDOMClient from 'react-dom/client'
|
3 | import {
|
4 | queries,
|
5 | Queries,
|
6 | BoundFunction,
|
7 | prettyFormat,
|
8 | Config as ConfigDTL,
|
9 | } from '@testing-library/dom'
|
10 | import {act as reactDeprecatedAct} from 'react-dom/test-utils'
|
11 |
|
12 | import {act as reactAct} from 'react'
|
13 |
|
14 | export * from '@testing-library/dom'
|
15 |
|
16 | export interface Config extends ConfigDTL {
|
17 | reactStrictMode: boolean
|
18 | }
|
19 |
|
20 | export interface ConfigFn {
|
21 | (existingConfig: Config): Partial<Config>
|
22 | }
|
23 |
|
24 | export function configure(configDelta: ConfigFn | Partial<Config>): void
|
25 |
|
26 | export function getConfig(): Config
|
27 |
|
28 | export type RenderResult<
|
29 | Q extends Queries = typeof queries,
|
30 | Container extends RendererableContainer | HydrateableContainer = HTMLElement,
|
31 | BaseElement extends RendererableContainer | HydrateableContainer = Container,
|
32 | > = {
|
33 | container: Container
|
34 | baseElement: BaseElement
|
35 | debug: (
|
36 | baseElement?:
|
37 | | RendererableContainer
|
38 | | HydrateableContainer
|
39 | | Array<RendererableContainer | HydrateableContainer>,
|
40 | maxLength?: number,
|
41 | options?: prettyFormat.OptionsReceived,
|
42 | ) => void
|
43 | rerender: (ui: React.ReactNode) => void
|
44 | unmount: () => void
|
45 | asFragment: () => DocumentFragment
|
46 | } & {[P in keyof Q]: BoundFunction<Q[P]>}
|
47 |
|
48 |
|
49 | export type BaseRenderOptions<
|
50 | Q extends Queries,
|
51 | Container extends RendererableContainer | HydrateableContainer,
|
52 | BaseElement extends RendererableContainer | HydrateableContainer,
|
53 | > = RenderOptions<Q, Container, BaseElement>
|
54 |
|
55 | type RendererableContainer = ReactDOMClient.Container
|
56 | type HydrateableContainer = Parameters<typeof ReactDOMClient['hydrateRoot']>[0]
|
57 |
|
58 | export interface ClientRenderOptions<
|
59 | Q extends Queries,
|
60 | Container extends RendererableContainer,
|
61 | BaseElement extends RendererableContainer = Container,
|
62 | > extends BaseRenderOptions<Q, Container, BaseElement> {
|
63 | |
64 |
|
65 |
|
66 |
|
67 |
|
68 |
|
69 | hydrate?: false | undefined
|
70 | }
|
71 |
|
72 | export interface HydrateOptions<
|
73 | Q extends Queries,
|
74 | Container extends HydrateableContainer,
|
75 | BaseElement extends HydrateableContainer = Container,
|
76 | > extends BaseRenderOptions<Q, Container, BaseElement> {
|
77 | |
78 |
|
79 |
|
80 |
|
81 |
|
82 |
|
83 | hydrate: true
|
84 | }
|
85 |
|
86 | export interface RenderOptions<
|
87 | Q extends Queries = typeof queries,
|
88 | Container extends RendererableContainer | HydrateableContainer = HTMLElement,
|
89 | BaseElement extends RendererableContainer | HydrateableContainer = Container,
|
90 | > {
|
91 | |
92 |
|
93 |
|
94 |
|
95 |
|
96 |
|
97 |
|
98 |
|
99 |
|
100 | container?: Container
|
101 | |
102 |
|
103 |
|
104 |
|
105 |
|
106 |
|
107 | baseElement?: BaseElement
|
108 | |
109 |
|
110 |
|
111 |
|
112 |
|
113 |
|
114 | hydrate?: boolean
|
115 | |
116 |
|
117 |
|
118 |
|
119 |
|
120 | legacyRoot?: boolean
|
121 | |
122 |
|
123 |
|
124 |
|
125 |
|
126 | queries?: Q
|
127 | |
128 |
|
129 |
|
130 |
|
131 |
|
132 |
|
133 | wrapper?: React.JSXElementConstructor<{children: React.ReactNode}>
|
134 | }
|
135 |
|
136 | type Omit<T, K extends keyof T> = Pick<T, Exclude<keyof T, K>>
|
137 |
|
138 |
|
139 |
|
140 |
|
141 | export function render<
|
142 | Q extends Queries = typeof queries,
|
143 | Container extends RendererableContainer | HydrateableContainer = HTMLElement,
|
144 | BaseElement extends RendererableContainer | HydrateableContainer = Container,
|
145 | >(
|
146 | ui: React.ReactNode,
|
147 | options: RenderOptions<Q, Container, BaseElement>,
|
148 | ): RenderResult<Q, Container, BaseElement>
|
149 | export function render(
|
150 | ui: React.ReactNode,
|
151 | options?: Omit<RenderOptions, 'queries'>,
|
152 | ): RenderResult
|
153 |
|
154 | export interface RenderHookResult<Result, Props> {
|
155 | /**
|
156 | * Triggers a re-render. The props will be passed to your renderHook callback.
|
157 | */
|
158 | rerender: (props?: Props) => void
|
159 | /**
|
160 | * This is a stable reference to the latest value returned by your renderHook
|
161 | * callback
|
162 | */
|
163 | result: {
|
164 | |
165 |
|
166 |
|
167 | current: Result
|
168 | }
|
169 | |
170 |
|
171 |
|
172 |
|
173 | unmount: () => void
|
174 | }
|
175 |
|
176 |
|
177 | export type BaseRenderHookOptions<
|
178 | Props,
|
179 | Q extends Queries,
|
180 | Container extends RendererableContainer | HydrateableContainer,
|
181 | BaseElement extends Element | DocumentFragment,
|
182 | > = RenderHookOptions<Props, Q, Container, BaseElement>
|
183 |
|
184 |
|
185 | export interface ClientRenderHookOptions<
|
186 | Props,
|
187 | Q extends Queries,
|
188 | Container extends Element | DocumentFragment,
|
189 | BaseElement extends Element | DocumentFragment = Container,
|
190 | > extends BaseRenderHookOptions<Props, Q, Container, BaseElement> {
|
191 | |
192 |
|
193 |
|
194 |
|
195 |
|
196 |
|
197 | hydrate?: false | undefined
|
198 | }
|
199 |
|
200 |
|
201 | export interface HydrateHookOptions<
|
202 | Props,
|
203 | Q extends Queries,
|
204 | Container extends Element | DocumentFragment,
|
205 | BaseElement extends Element | DocumentFragment = Container,
|
206 | > extends BaseRenderHookOptions<Props, Q, Container, BaseElement> {
|
207 | |
208 |
|
209 |
|
210 |
|
211 |
|
212 |
|
213 | hydrate: true
|
214 | }
|
215 |
|
216 | export interface RenderHookOptions<
|
217 | Props,
|
218 | Q extends Queries = typeof queries,
|
219 | Container extends RendererableContainer | HydrateableContainer = HTMLElement,
|
220 | BaseElement extends RendererableContainer | HydrateableContainer = Container,
|
221 | > extends BaseRenderOptions<Q, Container, BaseElement> {
|
222 | |
223 |
|
224 |
|
225 |
|
226 | initialProps?: Props
|
227 | }
|
228 |
|
229 |
|
230 |
|
231 |
|
232 |
|
233 | export function renderHook<
|
234 | Result,
|
235 | Props,
|
236 | Q extends Queries = typeof queries,
|
237 | Container extends RendererableContainer | HydrateableContainer = HTMLElement,
|
238 | BaseElement extends RendererableContainer | HydrateableContainer = Container,
|
239 | >(
|
240 | render: (initialProps: Props) => Result,
|
241 | options?: RenderHookOptions<Props, Q, Container, BaseElement>,
|
242 | ): RenderHookResult<Result, Props>
|
243 |
|
244 | /**
|
245 | * Unmounts React trees that were mounted with render.
|
246 | */
|
247 | export function cleanup(): void
|
248 |
|
249 | /**
|
250 | * Simply calls React.act(cb)
|
251 | * If that's not available (older version of react) then it
|
252 | * simply calls the deprecated version which is ReactTestUtils.act(cb)
|
253 | */
|
254 | // IfAny<typeof reactAct, reactDeprecatedAct, reactAct> from https://stackoverflow.com/a/61626123/3406963
|
255 | export const act: 0 extends 1 & typeof reactAct
|
256 | ? typeof reactDeprecatedAct
|
257 | : typeof reactAct
|
258 |
|
\ | No newline at end of file |