Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Commit 1faf874

Browse files
committed
Added coming soon placeholders for docs
1 parent f0587a5 commit 1faf874

File tree

6 files changed

+52
-5
lines changed

6 files changed

+52
-5
lines changed

‎README.md‎

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -110,14 +110,22 @@ test('should increment counter', () => {
110110
npm install --save-dev @testing-library/react-hooks
111111
```
112112

113-
We are using [react-test-renderer](https://www.npmjs.com/package/react-test-renderer) as a
114-
peerDependency, so make sure you have installed this library as well. Install the same version like
115-
you use in react.
113+
### Peer Dependencies
114+
115+
`react-hooks-testing-library` does not come bundled with a version of
116+
[`react`](https://www.npmjs.com/package/react) or
117+
[`react-test-renderer`](https://www.npmjs.com/package/react-test-renderer) to allow you to install
118+
the specific version you want to test against. Generally, the installed versions for `react` and
119+
`react-test-renderer` should match:
116120

117121
```sh
118-
npm install --save-dev react-test-renderer@x.y.z
122+
npm install react@^x.y.z
123+
npm install --save-dev react-test-renderer@^x.y.z
119124
```
120125

126+
Both of these dependecies must be installed as at least version `16.8.0` to be compatible with
127+
`react-hooks-testing-library`.
128+
121129
## Documentation
122130

123131
There are some [work-in-progress docs here](https://react-hooks-testing-library.com/). Please leave

‎docs/examples/index.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
name: Examples
3+
route: '/examples'
4+
---
5+
6+
# Examples
7+
8+
Coming soon.
9+
[Want to contribute?](https://github.com/testing-library/react-hooks-testing-library/tree/master/docs/examples)

‎docs/introduction/setup.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,22 @@ This module is distributed via [npm](https://www.npmjs.com/) which is bundled wi
1515
npm install --save-dev @testing-library/react-hooks
1616
```
1717

18+
### Peer Dependencies
19+
20+
`react-hooks-testing-library` does not come bundled with a version of
21+
[`react`](https://www.npmjs.com/package/react) or
22+
[`react-test-renderer`](https://www.npmjs.com/package/react-test-renderer) to allow you to install
23+
the specific version you want to test against. Generally, the installed versions for `react` and
24+
`react-test-renderer` should match:
25+
26+
```sh
27+
npm install react@^x.y.z
28+
npm install --save-dev react-test-renderer@^x.y.z
29+
```
30+
31+
Both of these dependecies must be installed as at least version `16.8.0` to be compatible with
32+
`react-hooks-testing-library`.
33+
1834
## Testing Framework
1935

2036
In order to run tests, you will probably want to be using a test framework. If you have not already

‎docs/reference/faq.md‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,7 @@ route: '/reference/faq'
1212

1313
### Why do I need to use `result.current` instead of just `result`?
1414

15-
The "ref-like" representation of the hook's result allows the value to be updated when the hook gets rerendered, whether that be from calling `rerender`, calling a callback returned from the hook, or an asynchronous action triggered by executing the hook. Without `current` the library would have to provide some way of requesting the updated values for assertions.
15+
The "ref-like" representation of the hook's result allows the value to be updated when the hook gets
16+
rerendered, whether that be from calling `rerender`, calling a callback returned from the hook, or
17+
an asynchronous action triggered by executing the hook. Without `current` the library would have to
18+
provide some way of requesting the updated values for assertions.

‎docs/reference/troubleshooting.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
name: Troubleshooting
3+
menu: Reference
4+
route: '/reference/troubleshooting'
5+
---
6+
7+
# Troubleshooting
8+
9+
Coming soon.
10+
[Want to contribute?](https://github.com/testing-library/react-hooks-testing-library/edit/master/docs/reference/troubleshooting.md)

‎doczrc.js‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
export default {
2+
title: 'React Hooks Testing Library',
23
files: '**/*.{md,mdx}',
34
src: 'docs',
45
dest: 'site',

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /