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: README.md
+16-8Lines changed: 16 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,6 +26,14 @@ or yarn
26
26
yarn add react-scroll-parallax
27
27
```
28
28
29
+
## Test the Latest Version
30
+
31
+
A new `beta` version is in the works that offers a simpler setup but more flexibility for advanced scroll effects. You can find more information here or leave feedback: [V3 Issue](https://github.com/jscottsmith/react-scroll-parallax/issues/123).
32
+
33
+
```
34
+
yarn add react-scroll-parallax@beta
35
+
```
36
+
29
37
## Overview
30
38
31
39
-[Usage](#usage)
@@ -86,16 +94,16 @@ The main component for manipulating a DOM element's position based on it's posit
86
94
87
95
The following are all props that can be passed to the `<Parallax>` component:
|**x**|`Array` of `String` or `Number`|`[0, 0]`| Initial and final offsets on x-axis in `%` or `px`. If no unit is passed percent is assumed. Percent is based on the elements width. |
92
100
|**y**|`Array` of `String` or `Number`|`[0, 0]`| Initial and final offsets on y-axis in `%` or `px`. If no unit is passed percent is assumed. Percent is based on the elements width. |
93
-
|**className**|`String`|| Optionally pass additional class names to be added to the outermost parallax element. |
94
-
|**disabled**|`Boolean`|`false`| Disables parallax effects on individual elements when `true`. |
95
-
|**styleInner**|`Object`|| Optionally pass a style object to be added to the innermost parallax element. |
96
-
|**styleOuter**|`Object`|| Optionally pass a style object to be added to the outermost parallax element. |
97
-
|**tagInner**|`String`|`div`| Optionally pass an element tag name to be applied to the innermost parallax element. |
98
-
|**tagOuter**|`String`|`div`| Optionally pass an element tag name to be applied to the outermost parallax element. |
101
+
|**className**|`String`|| Optionally pass additional class names to be added to the outermost parallax element. |
102
+
|**disabled**|`Boolean`|`false`| Disables parallax effects on individual elements when `true`. |
103
+
|**styleInner**|`Object`|| Optionally pass a style object to be added to the innermost parallax element. |
104
+
|**styleOuter**|`Object`|| Optionally pass a style object to be added to the outermost parallax element. |
105
+
|**tagInner**|`String`|`div`| Optionally pass an element tag name to be applied to the innermost parallax element. |
106
+
|**tagOuter**|`String`|`div`| Optionally pass an element tag name to be applied to the outermost parallax element. |
0 commit comments