Skip to content

Commit 2d93433

Browse files
committed
docs: add additional links in usage docs
1 parent 3c840c5 commit 2d93433

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

documentation/docs/usage/usage.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
### Wrap with a ParallaxProvider
66

7-
The [`<ParallaxProvider/>`](/docs/usage/components/parallax-provider) must wrap the component tree that contains all `<Parallax>` components. This should be a top level component like `<App>` and will provide necessary access through the React context API to the [Parallax Controller](https://parallax-controller.vercel.app/docs/intro). For example:
7+
The [`<ParallaxProvider/>`](/docs/usage/components/parallax-provider) must wrap the component root that contains all [components](/docs/usage/components/) or [hooks](/docs/usage/hooks/) that use the parallax context. This should be a top level component like `<App>` and will provide necessary access through the React context API to the [Parallax Controller](https://parallax-controller.vercel.app/docs/intro). For example:
88

99
```jsx
1010
import { ParallaxProvider } from 'react-scroll-parallax';
@@ -28,7 +28,7 @@ After wrapping the app with a provider you can start adding parallax effects.
2828

2929
### With useParallax()
3030

31-
Then import the `useParallax` hook and use it anywhere within the provider. Here's an example that uses the `speed` prop so simply speed up (or slowdown) the rate of scroll.
31+
Then import the [`useParallax`](/docs/usage/hooks/use-parallax) hook and use it anywhere within the provider. Here's an example that uses the [`speed`](/docs/usage/parallax-props#configuration-props) prop so simply speed up (or slowdown) the rate of scroll.
3232

3333
```jsx
3434
import { useParallax } from 'react-scroll-parallax';
@@ -49,7 +49,7 @@ Any of the [documented effects and configurations](https://parallax-controller.v
4949

5050
### Or with <Parallax\>
5151

52-
You can also use the `Parallax` component. Here's an example that will transform the element on the `translateY` axis starting at `-20%` and ending at `20%` (`[-20, 20]` \*percent is assumed with no provided unit).
52+
You can also use the [`<Parallax>`](/docs/usage/components/parallax-component) component. Here's an example that will transform the element on the [`translateY`](/docs/usage/parallax-props#css-effect-props) axis starting at `-20%` and ending at `20%` (`[-20, 20]` \*percent is assumed with no provided unit).
5353

5454
```jsx
5555
import { Parallax } from 'react-scroll-parallax';
@@ -69,7 +69,7 @@ The component will apply the effect styles to a `div` managed by the component a
6969

7070
Any of the [documented effects and configurations](https://parallax-controller.vercel.app/docs/usage/props) can be passed as props to the component.
7171

72-
This example uses the `translateX` transform starting at `-100px` and ending at `200px`.
72+
This example uses the [`translateX`](/docs/usage/parallax-props#css-effect-props) transform starting at `-100px` and ending at `200px`.
7373

7474
```jsx
7575
import { Parallax } from 'react-scroll-parallax';

0 commit comments

Comments
 (0)