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/components/parallax-banner-component.md
+6-6Lines changed: 6 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -106,12 +106,12 @@ All other props are defined on the root `div` element.
106
106
107
107
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:
|**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. |
|**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. |
Copy file name to clipboardExpand all lines: documentation/docs/usage/hooks/use-parallax.md
+3-4Lines changed: 3 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -4,20 +4,19 @@ sidebar_position: 1
4
4
5
5
# useParallax
6
6
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.
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.
0 commit comments