You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: documentation/docs/usage/usage.md
+4-4Lines changed: 4 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@
4
4
5
5
### Wrap with a ParallaxProvider
6
6
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:
@@ -28,7 +28,7 @@ After wrapping the app with a provider you can start adding parallax effects.
28
28
29
29
### With useParallax()
30
30
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.
@@ -49,7 +49,7 @@ Any of the [documented effects and configurations](https://parallax-controller.v
49
49
50
50
### Or with <Parallax\>
51
51
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).
53
53
54
54
```jsx
55
55
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
69
69
70
70
Any of the [documented effects and configurations](https://parallax-controller.vercel.app/docs/usage/props) can be passed as props to the component.
71
71
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`.
0 commit comments