Skip to content

Commit eea4daa

Browse files
deploy: 9e1b636
1 parent eefd450 commit eea4daa

195 files changed

Lines changed: 414 additions & 387 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

12.x/cookbook/advanced/network-requests.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
<script defer src="/react-native-testing-library/static/js/lib-react.49604bf759.js"></script>
1010
<script defer src="/react-native-testing-library/static/js/lib-router.a0df4de158.js"></script>
1111
<script defer src="/react-native-testing-library/static/js/2482.4740a55c68.js"></script>
12-
<script defer src="/react-native-testing-library/static/js/index.5d61bfb5d3.js"></script>
12+
<script defer src="/react-native-testing-library/static/js/index.57322732e5.js"></script>
1313
<meta http-equiv="X-UA-Compatible" content="IE=edge">
1414
<meta name="generator" content="Rspress v2.0.9">
1515
<meta property="og:url" content="https://oss.callstack.com/react-native-testing-library/">

12.x/cookbook/basics/async-tests.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
<script defer src="/react-native-testing-library/static/js/lib-react.49604bf759.js"></script>
1010
<script defer src="/react-native-testing-library/static/js/lib-router.a0df4de158.js"></script>
1111
<script defer src="/react-native-testing-library/static/js/2482.4740a55c68.js"></script>
12-
<script defer src="/react-native-testing-library/static/js/index.5d61bfb5d3.js"></script>
12+
<script defer src="/react-native-testing-library/static/js/index.57322732e5.js"></script>
1313
<meta http-equiv="X-UA-Compatible" content="IE=edge">
1414
<meta name="generator" content="Rspress v2.0.9">
1515
<meta property="og:url" content="https://oss.callstack.com/react-native-testing-library/">
@@ -48,7 +48,7 @@ <h3 class="rp-toc-include" id="example"><a href="#example" class="rp-header-anch
4848
<span class="line"></span>
4949
<span class="line"><span style="color:var(--shiki-token-comment)"> // Follow-up assertions do not need to be async, as we already waited for sign in operation to complete</span></span>
5050
<span class="line"><span style="color:var(--shiki-token-function)"> expect</span><span style="color:var(--shiki-foreground)">(</span></span>
51-
<span class="line"><span style="color:var(--shiki-token-constant)"> screen</span><span style="color:var(--shiki-token-function)">.queryByRole</span><span style="color:var(--shiki-foreground)">(</span><span style="color:var(--shiki-token-string-expression)">&#x27;header&#x27;</span><span style="color:var(--shiki-token-punctuation)">,</span><span style="color:var(--shiki-foreground)"> { name</span><span style="color:var(--shiki-token-keyword)">:</span><span style="color:var(--shiki-token-string-expression)"> &#x27;Sign in to Hello World App&#x27;</span><span style="color:var(--shiki-foreground)"> })</span></span>
51+
<span class="line"><span style="color:var(--shiki-token-constant)"> screen</span><span style="color:var(--shiki-token-function)">.queryByRole</span><span style="color:var(--shiki-foreground)">(</span><span style="color:var(--shiki-token-string-expression)">&#x27;header&#x27;</span><span style="color:var(--shiki-token-punctuation)">,</span><span style="color:var(--shiki-foreground)"> { name</span><span style="color:var(--shiki-token-keyword)">:</span><span style="color:var(--shiki-token-string-expression)"> &#x27;Sign in to Hello World App&#x27;</span><span style="color:var(--shiki-foreground)"> })</span><span style="color:var(--shiki-token-punctuation)">,</span></span>
5252
<span class="line"><span style="color:var(--shiki-foreground)"> ).</span><span style="color:var(--shiki-token-constant)">not</span><span style="color:var(--shiki-token-function)">.toBeOnTheScreen</span><span style="color:var(--shiki-foreground)">();</span></span>
5353
<span class="line"><span style="color:var(--shiki-token-function)"> expect</span><span style="color:var(--shiki-foreground)">(</span><span style="color:var(--shiki-token-constant)">screen</span><span style="color:var(--shiki-token-function)">.queryByLabelText</span><span style="color:var(--shiki-foreground)">(</span><span style="color:var(--shiki-token-string-expression)">&#x27;Username&#x27;</span><span style="color:var(--shiki-foreground)">)).</span><span style="color:var(--shiki-token-constant)">not</span><span style="color:var(--shiki-token-function)">.toBeOnTheScreen</span><span style="color:var(--shiki-foreground)">();</span></span>
5454
<span class="line"><span style="color:var(--shiki-token-function)"> expect</span><span style="color:var(--shiki-foreground)">(</span><span style="color:var(--shiki-token-constant)">screen</span><span style="color:var(--shiki-token-function)">.queryByLabelText</span><span style="color:var(--shiki-foreground)">(</span><span style="color:var(--shiki-token-string-expression)">&#x27;Password&#x27;</span><span style="color:var(--shiki-foreground)">)).</span><span style="color:var(--shiki-token-constant)">not</span><span style="color:var(--shiki-token-function)">.toBeOnTheScreen</span><span style="color:var(--shiki-foreground)">();</span></span>
@@ -81,7 +81,7 @@ <h3 class="rp-toc-include" id="waitfor-function"><a href="#waitfor-function" cla
8181
<span class="line"><span style="color:var(--shiki-foreground)"> options</span><span style="color:var(--shiki-token-keyword)">?:</span><span style="color:var(--shiki-foreground)"> {</span></span>
8282
<span class="line"><span style="color:var(--shiki-foreground)"> timeout</span><span style="color:var(--shiki-token-keyword)">:</span><span style="color:var(--shiki-token-constant)"> number</span><span style="color:var(--shiki-foreground)">;</span></span>
8383
<span class="line"><span style="color:var(--shiki-foreground)"> interval</span><span style="color:var(--shiki-token-keyword)">:</span><span style="color:var(--shiki-token-constant)"> number</span><span style="color:var(--shiki-foreground)">;</span></span>
84-
<span class="line"><span style="color:var(--shiki-foreground)"> }</span></span>
84+
<span class="line"><span style="color:var(--shiki-foreground)"> }</span><span style="color:var(--shiki-token-punctuation)">,</span></span>
8585
<span class="line"><span style="color:var(--shiki-foreground)">)</span><span style="color:var(--shiki-token-keyword)">:</span><span style="color:var(--shiki-token-function)"> Promise</span><span style="color:var(--shiki-foreground)">&lt;</span><span style="color:var(--shiki-token-function)">T</span><span style="color:var(--shiki-foreground)">&gt;;</span></span></code></pre></div><div class="rp-code-button-group"><button class="rp-code-button-group__button rp-code-wrap-button" title="Toggle code wrap"><svg xmlns="http://www.w3.org/2000/svg" width="32" height="32" viewBox="0 0 24 24" class="rp-code-button-group__icon rp-code-button-group__icon--wrapped"><path fill="currentColor" d="M21 5H3v2h18zM3 19h7v-2H3zm0-6h15c1 0 2 .43 2 2s-1 2-2 2h-2v-2l-4 3 4 3v-2h2c2.95 0 4-1.27 4-4 0-2.72-1-4-4-4H3z"></path></svg><svg xmlns="http://www.w3.org/2000/svg" width="32" height="32" viewBox="0 0 24 24" class="rp-code-button-group__icon rp-code-button-group__icon--wrap"><path fill="currentColor" d="M16 7H3V5h13zM3 19h13v-2H3zm19-7-4-3v2H3v2h15v2z"></path></svg></button><button class="rp-code-button-group__button rp-code-copy-button" title="Copy code"><svg xmlns="http://www.w3.org/2000/svg" width="272" height="272" viewBox="0 0 272 272" class="rp-code-button-group__icon rp-code-copy-button__icon rp-code-copy-button__icon--copy"><path fill="currentColor" fill-rule="evenodd" d="M45.883 23.368h123.823v22.514H68.396v146.336H45.883zm45.026 45.027H225.99v180.107H90.91zm22.514 22.513v135.08h90.053V90.908z" clip-rule="evenodd"></path></svg><svg xmlns="http://www.w3.org/2000/svg" width="271" height="271" viewBox="0 0 271 271" class="rp-code-button-group__icon rp-code-copy-button__icon rp-code-copy-button__icon--success"><path fill="currentColor" d="M112.687 203.223H90.174v-22.514h22.512v-22.514h22.512v22.514h-22.511zm-22.514-22.514H67.66v-22.514h22.513zm-22.514-22.514H45.146v-22.512H67.66zm90.054 0h-22.514v-22.512h22.514zm22.514-22.512h-22.514v-22.514h22.514zm22.513-22.514h-22.513V90.655h22.513zm22.514-22.514H202.74V68.143h22.514z"></path></svg></button></div></div></div>
8686
<p>It accepts an <code>expectation</code> to be validated and repeats the check every defined interval until it no longer throws an error. Similarly to <code>findBy*</code> queries they accept <code>timeout</code> and <code>interval</code> options and have the same default values of 1000ms for timeout, and a checking interval of 50 ms.</p>
8787
<h4 class="rp-toc-include" id="example-2"><a href="#example-2" class="rp-header-anchor rp-link" aria-hidden="true">#</a>Example</h4>
@@ -94,7 +94,7 @@ <h3 class="rp-toc-include" id="waitforelementtoberemoved-function"><a href="#wai
9494
<span class="line"><span style="color:var(--shiki-foreground)"> options</span><span style="color:var(--shiki-token-keyword)">?:</span><span style="color:var(--shiki-foreground)"> {</span></span>
9595
<span class="line"><span style="color:var(--shiki-foreground)"> timeout</span><span style="color:var(--shiki-token-keyword)">:</span><span style="color:var(--shiki-token-constant)"> number</span><span style="color:var(--shiki-foreground)">;</span></span>
9696
<span class="line"><span style="color:var(--shiki-foreground)"> interval</span><span style="color:var(--shiki-token-keyword)">:</span><span style="color:var(--shiki-token-constant)"> number</span><span style="color:var(--shiki-foreground)">;</span></span>
97-
<span class="line"><span style="color:var(--shiki-foreground)"> }</span></span>
97+
<span class="line"><span style="color:var(--shiki-foreground)"> }</span><span style="color:var(--shiki-token-punctuation)">,</span></span>
9898
<span class="line"><span style="color:var(--shiki-foreground)">)</span><span style="color:var(--shiki-token-keyword)">:</span><span style="color:var(--shiki-token-function)"> Promise</span><span style="color:var(--shiki-foreground)">&lt;</span><span style="color:var(--shiki-token-function)">T</span><span style="color:var(--shiki-foreground)">&gt; {}</span></span></code></pre></div><div class="rp-code-button-group"><button class="rp-code-button-group__button rp-code-wrap-button" title="Toggle code wrap"><svg xmlns="http://www.w3.org/2000/svg" width="32" height="32" viewBox="0 0 24 24" class="rp-code-button-group__icon rp-code-button-group__icon--wrapped"><path fill="currentColor" d="M21 5H3v2h18zM3 19h7v-2H3zm0-6h15c1 0 2 .43 2 2s-1 2-2 2h-2v-2l-4 3 4 3v-2h2c2.95 0 4-1.27 4-4 0-2.72-1-4-4-4H3z"></path></svg><svg xmlns="http://www.w3.org/2000/svg" width="32" height="32" viewBox="0 0 24 24" class="rp-code-button-group__icon rp-code-button-group__icon--wrap"><path fill="currentColor" d="M16 7H3V5h13zM3 19h13v-2H3zm19-7-4-3v2H3v2h15v2z"></path></svg></button><button class="rp-code-button-group__button rp-code-copy-button" title="Copy code"><svg xmlns="http://www.w3.org/2000/svg" width="272" height="272" viewBox="0 0 272 272" class="rp-code-button-group__icon rp-code-copy-button__icon rp-code-copy-button__icon--copy"><path fill="currentColor" fill-rule="evenodd" d="M45.883 23.368h123.823v22.514H68.396v146.336H45.883zm45.026 45.027H225.99v180.107H90.91zm22.514 22.513v135.08h90.053V90.908z" clip-rule="evenodd"></path></svg><svg xmlns="http://www.w3.org/2000/svg" width="271" height="271" viewBox="0 0 271 271" class="rp-code-button-group__icon rp-code-copy-button__icon rp-code-copy-button__icon--success"><path fill="currentColor" d="M112.687 203.223H90.174v-22.514h22.512v-22.514h22.512v22.514h-22.511zm-22.514-22.514H67.66v-22.514h22.513zm-22.514-22.514H45.146v-22.512H67.66zm90.054 0h-22.514v-22.512h22.514zm22.514-22.512h-22.514v-22.514h22.514zm22.513-22.514h-22.513V90.655h22.513zm22.514-22.514H202.74V68.143h22.514z"></path></svg></button></div></div></div>
9999
<p>This function is, in a way, the negation of <code>waitFor</code> as it expects the initial expectation to be true (not throw an error), only to turn invalid (start throwing errors) on subsequent runs. It operates using the same <code>timeout</code> and <code>interval</code> parameters as <code>findBy*</code> queries and <code>waitFor</code>.</p>
100100
<h4 class="rp-toc-include" id="example-3"><a href="#example-3" class="rp-header-anchor rp-link" aria-hidden="true">#</a>Example</h4>

12.x/cookbook/basics/async-tests.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ test('User can sign in with correct credentials', async () => {
3232

3333
// Follow-up assertions do not need to be async, as we already waited for sign in operation to complete
3434
expect(
35-
screen.queryByRole('header', { name: 'Sign in to Hello World App' })
35+
screen.queryByRole('header', { name: 'Sign in to Hello World App' }),
3636
).not.toBeOnTheScreen();
3737
expect(screen.queryByLabelText('Username')).not.toBeOnTheScreen();
3838
expect(screen.queryByLabelText('Password')).not.toBeOnTheScreen();
@@ -87,7 +87,7 @@ function waitFor<T>(
8787
options?: {
8888
timeout: number;
8989
interval: number;
90-
}
90+
},
9191
): Promise<T>;
9292
```
9393

@@ -111,7 +111,7 @@ function waitForElementToBeRemoved<T>(
111111
options?: {
112112
timeout: number;
113113
interval: number;
114-
}
114+
},
115115
): Promise<T> {}
116116
```
117117

12.x/cookbook/basics/custom-render.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
<script defer src="/react-native-testing-library/static/js/lib-react.49604bf759.js"></script>
1010
<script defer src="/react-native-testing-library/static/js/lib-router.a0df4de158.js"></script>
1111
<script defer src="/react-native-testing-library/static/js/2482.4740a55c68.js"></script>
12-
<script defer src="/react-native-testing-library/static/js/index.5d61bfb5d3.js"></script>
12+
<script defer src="/react-native-testing-library/static/js/index.57322732e5.js"></script>
1313
<meta http-equiv="X-UA-Compatible" content="IE=edge">
1414
<meta name="generator" content="Rspress v2.0.9">
1515
<meta property="og:url" content="https://oss.callstack.com/react-native-testing-library/">
@@ -33,12 +33,12 @@ <h3 class="rp-toc-include" id="example"><a href="#example" class="rp-header-anch
3333
<span class="line"></span>
3434
<span class="line"><span style="color:var(--shiki-token-keyword)">export</span><span style="color:var(--shiki-token-keyword)"> function</span><span style="color:var(--shiki-token-function)"> renderWithProviders</span><span style="color:var(--shiki-foreground)">&lt;</span><span style="color:var(--shiki-token-function)">T</span><span style="color:var(--shiki-foreground)">&gt;(</span></span>
3535
<span class="line"><span style="color:var(--shiki-foreground)"> ui</span><span style="color:var(--shiki-token-keyword)">:</span><span style="color:var(--shiki-token-function)"> React</span><span style="color:var(--shiki-foreground)">.</span><span style="color:var(--shiki-token-function)">ReactElement</span><span style="color:var(--shiki-foreground)">&lt;</span><span style="color:var(--shiki-token-function)">T</span><span style="color:var(--shiki-foreground)">&gt;</span><span style="color:var(--shiki-token-punctuation)">,</span></span>
36-
<span class="line"><span style="color:var(--shiki-foreground)"> options</span><span style="color:var(--shiki-token-keyword)">?:</span><span style="color:var(--shiki-token-function)"> RenderWithProvidersProps</span></span>
36+
<span class="line"><span style="color:var(--shiki-foreground)"> options</span><span style="color:var(--shiki-token-keyword)">?:</span><span style="color:var(--shiki-token-function)"> RenderWithProvidersProps</span><span style="color:var(--shiki-token-punctuation)">,</span></span>
3737
<span class="line"><span style="color:var(--shiki-foreground)">) {</span></span>
3838
<span class="line"><span style="color:var(--shiki-token-keyword)"> return</span><span style="color:var(--shiki-token-function)"> render</span><span style="color:var(--shiki-foreground)">(</span></span>
3939
<span class="line"><span style="color:var(--shiki-foreground)"> &lt;</span><span style="color:var(--shiki-token-constant)">UserProvider.Provider</span><span style="color:var(--shiki-token-function)"> value</span><span style="color:var(--shiki-token-keyword)">=</span><span style="color:var(--shiki-foreground)">{</span><span style="color:var(--shiki-token-constant)">options</span><span style="color:var(--shiki-foreground)">?.user </span><span style="color:var(--shiki-token-keyword)">??</span><span style="color:var(--shiki-token-constant)"> null</span><span style="color:var(--shiki-foreground)">}&gt;</span></span>
4040
<span class="line"><span style="color:var(--shiki-foreground)"> &lt;</span><span style="color:var(--shiki-token-constant)">ThemeProvider.Provider</span><span style="color:var(--shiki-token-function)"> value</span><span style="color:var(--shiki-token-keyword)">=</span><span style="color:var(--shiki-foreground)">{</span><span style="color:var(--shiki-token-constant)">options</span><span style="color:var(--shiki-foreground)">?.theme </span><span style="color:var(--shiki-token-keyword)">??</span><span style="color:var(--shiki-token-string-expression)"> &#x27;light&#x27;</span><span style="color:var(--shiki-foreground)">}&gt;{ui}&lt;/</span><span style="color:var(--shiki-token-constant)">ThemeProvider.Provider</span><span style="color:var(--shiki-foreground)">&gt;</span></span>
41-
<span class="line"><span style="color:var(--shiki-foreground)"> &lt;/</span><span style="color:var(--shiki-token-constant)">UserProvider.Provider</span><span style="color:var(--shiki-foreground)">&gt;</span></span>
41+
<span class="line"><span style="color:var(--shiki-foreground)"> &lt;/</span><span style="color:var(--shiki-token-constant)">UserProvider.Provider</span><span style="color:var(--shiki-foreground)">&gt;</span><span style="color:var(--shiki-token-punctuation)">,</span></span>
4242
<span class="line"><span style="color:var(--shiki-foreground)"> );</span></span>
4343
<span class="line"><span style="color:var(--shiki-foreground)">}</span></span></code></pre></div><div class="rp-code-button-group"><button class="rp-code-button-group__button rp-code-wrap-button" title="Toggle code wrap"><svg xmlns="http://www.w3.org/2000/svg" width="32" height="32" viewBox="0 0 24 24" class="rp-code-button-group__icon rp-code-button-group__icon--wrapped"><path fill="currentColor" d="M21 5H3v2h18zM3 19h7v-2H3zm0-6h15c1 0 2 .43 2 2s-1 2-2 2h-2v-2l-4 3 4 3v-2h2c2.95 0 4-1.27 4-4 0-2.72-1-4-4-4H3z"></path></svg><svg xmlns="http://www.w3.org/2000/svg" width="32" height="32" viewBox="0 0 24 24" class="rp-code-button-group__icon rp-code-button-group__icon--wrap"><path fill="currentColor" d="M16 7H3V5h13zM3 19h13v-2H3zm19-7-4-3v2H3v2h15v2z"></path></svg></button><button class="rp-code-button-group__button rp-code-copy-button" title="Copy code"><svg xmlns="http://www.w3.org/2000/svg" width="272" height="272" viewBox="0 0 272 272" class="rp-code-button-group__icon rp-code-copy-button__icon rp-code-copy-button__icon--copy"><path fill="currentColor" fill-rule="evenodd" d="M45.883 23.368h123.823v22.514H68.396v146.336H45.883zm45.026 45.027H225.99v180.107H90.91zm22.514 22.513v135.08h90.053V90.908z" clip-rule="evenodd"></path></svg><svg xmlns="http://www.w3.org/2000/svg" width="271" height="271" viewBox="0 0 271 271" class="rp-code-button-group__icon rp-code-copy-button__icon rp-code-copy-button__icon--success"><path fill="currentColor" d="M112.687 203.223H90.174v-22.514h22.512v-22.514h22.512v22.514h-22.511zm-22.514-22.514H67.66v-22.514h22.513zm-22.514-22.514H45.146v-22.512H67.66zm90.054 0h-22.514v-22.512h22.514zm22.514-22.512h-22.514v-22.514h22.514zm22.513-22.514h-22.513V90.655h22.513zm22.514-22.514H202.74V68.143h22.514z"></path></svg></button></div></div></div>
4444
<div class="rp-codeblock language-tsx"><div class="rp-codeblock__title">custom-render/index.test.tsx</div><div class="rp-codeblock__content"><div class="rp-codeblock__content__scroll-container rp-scrollbar rp-scrollbar--always"><pre class="shiki css-variables" style="background-color:var(--shiki-background);color:var(--shiki-foreground)" tabindex="0" data-lang="tsx" data-title="custom-render/index.test.tsx"><code><span class="line"><span style="color:var(--shiki-token-keyword)">import</span><span style="color:var(--shiki-foreground)"> { screen } </span><span style="color:var(--shiki-token-keyword)">from</span><span style="color:var(--shiki-token-string-expression)"> &#x27;@testing-library/react-native&#x27;</span><span style="color:var(--shiki-foreground)">;</span></span>

12.x/cookbook/basics/custom-render.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,12 @@ interface RenderWithProvidersProps {
1616

1717
export function renderWithProviders<T>(
1818
ui: React.ReactElement<T>,
19-
options?: RenderWithProvidersProps
19+
options?: RenderWithProvidersProps,
2020
) {
2121
return render(
2222
<UserProvider.Provider value={options?.user ?? null}>
2323
<ThemeProvider.Provider value={options?.theme ?? 'light'}>{ui}</ThemeProvider.Provider>
24-
</UserProvider.Provider>
24+
</UserProvider.Provider>,
2525
);
2626
}
2727
```

0 commit comments

Comments
 (0)