Skip to content

docs: Add mocking useLocation to docs #6791

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Nov 4, 2022
Merged

docs: Add mocking useLocation to docs #6791

Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
e9c827c
add mocking-useLocation to how-to in docs
bigbuckalex Nov 3, 2022
dfba073
Update mocking-useLocation.md
bigbuckalex Nov 3, 2022
0d08ec4
move mocking-useLocation to testing
bigbuckalex Nov 4, 2022
50b27f9
Update docs/docs/testing.md
bigbuckalex Nov 4, 2022
cbd297a
Merge branch 'main' into add-mocking-useLocation-to-docs
bigbuckalex Nov 4, 2022
9d8fc1f
Update docs/docs/testing.md
jtoar Nov 4, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions docs/docs/testing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -274,6 +274,19 @@ render(<Article article={ title: 'Foobar' } />, {
})
```
:::
### Mocking useLocation

To mock `useLocation` in your component tests, wrap the component with `LocationProvider`:

```jsx
import { LocationProvider } from '@redwoodjs/router'

render(
<LocationProvider location={{ pathname: '', search: '?cancelled=true' }}>
<Component />
</LocationProvider>
)
```

## Testing Custom Hooks

Expand Down