Skip to content

Commit 7928e9e

Browse files
committed
docs: update link to parallax props
1 parent 0f9d43c commit 7928e9e

File tree

4 files changed

+12
-13
lines changed

4 files changed

+12
-13
lines changed

documentation/docs/usage/components/parallax-banner-component.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -106,12 +106,12 @@ All other props are defined on the root `div` element.
106106

107107
The `layers` prop takes an array of objects that represent each image (or custom children) of the parallax banner. The following properties describe a layer object:
108108

109-
| Name | Type | Default | Description |
110-
| ------------ | :---------------------: | :------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
111-
| **children** | `ReactElement` | | Custom layer children provided as a React element, for example `<Video />` |
112-
| **expanded** | `boolean` | `true` | Indicate if the layer should be expanded with negative top/bottom margins so the edges will never be visible. |
113-
| **image** | `string` | | Image source that will be applied as a CSS `background-image` on the layer set to `cover`. |
114-
| `...rest` | `ParallaxElementConfig` | | All known parallax props will be passed to `useParallax`. [See all the parallax props](https://parallax-controller.vercel.app/docs/usage/props) that this hook will accept. All other properties are spread to the `<div>` representing the layer. |
109+
| Name | Type | Default | Description |
110+
| ------------ | :---------------------: | :------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
111+
| **children** | `ReactElement` | | Custom layer children provided as a React element, for example `<Video />` |
112+
| **expanded** | `boolean` | `true` | Indicate if the layer should be expanded with negative top/bottom margins so the edges will never be visible. |
113+
| **image** | `string` | | Image source that will be applied as a CSS `background-image` on the layer set to `cover`. |
114+
| `...rest` | `ParallaxElementConfig` | | All known parallax props will be passed to `useParallax`. [See all the parallax props](/docs/usage/parallax-props) that this hook will accept. All other properties are spread to the `<div>` representing the layer. |
115115

116116
```jsx
117117
<ParallaxBanner

documentation/docs/usage/components/parallax-component.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ import { Parallax } from 'react-scroll-parallax';
1414

1515
All props to configure the parallax element, like CSS effects, are documented and managed by the `parallax-controller`.
1616

17-
[See all the parallax props](https://parallax-controller.vercel.app/docs/usage/props) that this component will accept.
17+
[See all the parallax props](/docs/usage/parallax-props) that this component will accept.
1818

1919
### Non Parallax Props
2020

documentation/docs/usage/hooks/use-parallax.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,19 @@ sidebar_position: 1
44

55
# useParallax
66

7-
Main hook for applying parallax effects to a DOM element. Any of the documented [effects and configurations](https://parallax-controller.vercel.app/docs/usage/props) can be passed as params to the hook.
7+
Main hook for applying parallax effects to a DOM element. Any of the documented [effects and configurations](/docs/usage/parallax-props) can be passed as params to the hook.
88

99
```tsx
1010
import { useParallax } from 'react-scroll-parallax';
1111
```
1212

1313
## Example
1414

15-
To use the hook assign the `ref` returned to the element that you would like to apply effects to. Then provide the hook with the [prop configuration](https://parallax-controller.vercel.app/docs/usage/props) for the effects you need.
15+
To use the hook assign the `ref` returned to the element that you would like to apply effects to. Then provide the hook with the [prop configuration](/docs/usage/parallax-props) for the effects you need.
1616

1717
```tsx
1818
function Component() {
19-
const props = { speed: 10 };
20-
const { ref } = useParallax<HTMLDivElement>(props);
19+
const { ref } = useParallax<HTMLDivElement>({ speed: 10 });
2120
return <div ref={ref} />;
2221
}
2322
```

documentation/docs/usage/usage.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ The hook will apply the effect styles directly to the element that the `ref` is
4545

4646
:::
4747

48-
Any of the [documented effects and configurations](https://parallax-controller.vercel.app/docs/usage/props) can be passed as params to the hook.
48+
Any of the [documented effects and configurations](/docs/usage/parallax-props) can be passed as params to the hook.
4949

5050
### Or with <Parallax\>
5151

@@ -67,7 +67,7 @@ The component will apply the effect styles to a `div` managed by the component a
6767

6868
:::
6969

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

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

0 commit comments

Comments
 (0)