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
+10-54Lines changed: 10 additions & 54 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -62,60 +62,16 @@ const Image = () => (
62
62
63
63
The following are all props that can be passed to the React `<Parallax />` component:
64
64
65
-
**`className`**
66
-
67
-
- type: `String`
68
-
69
-
Optionally pass additional class names to be added to the outer parallax element.
70
-
71
-
**`disabled`**
72
-
73
-
- type: `Boolean`
74
-
- default: `false`
75
-
76
-
Determines if the component will have parallax offsets applied. If `true` parallax styles are completely removed from the element and it is no longer updated.
77
-
78
-
**`offsetXMax`**
79
-
80
-
- type: `Number` or `String`
81
-
- default: `0`
82
-
83
-
Maximum **x** offset in `%` or `px`. If no unit is passed percent is assumed. Percent is based on the elements width.
84
-
85
-
**`offsetXMin`**
86
-
87
-
- type: `Number` or `String`
88
-
- default: `0`
89
-
90
-
Minimum **x** offset in `%` or `px`. If no unit is passed percent is assumed. Percent is based on the elements width.
91
-
92
-
**`offsetYMax`**
93
-
94
-
- type: `Number` or `String`
95
-
- default: `0`
96
-
97
-
Maximum **y** offset in `%` or `px`. If no unit is passed percent is assumed. Percent is based on the elements height.
98
-
99
-
**`offsetYMin`**
100
-
101
-
- type: `Number` or `String`
102
-
- default: `0`
103
-
104
-
Minimum **y** offset in `%` or `px`. If no unit is passed percent is assumed. Percent is based on the elements height.
105
-
106
-
**`slowerScrollRate`**
107
-
108
-
- type: `Boolean`
109
-
- default `false`
110
-
111
-
Internally swaps the min/max offset y values of the parallax component to give the appearance of moving faster or slower than the default rate of scroll.
112
-
113
-
**`tag`**
114
-
115
-
- type: `String`
116
-
- default `div`
117
-
118
-
Optionally pass a tag name to be applied to the outer most parallax element. For example: `<Parallax tag="figure" />`.
|**className** |`String` | |Optionally pass additional class names to be added to the outer most parallax element.
68
+
|**disabled** |`Boolean` |`false` |Determines if the component will have parallax offsets applied. If `true` parallax styles are completely removed from the element and it is no longer updated.
69
+
|**offsetXMax** |`Number` or `String` |`0` |Maximum **x** offset in `%` or `px`. If no unit is passed percent is assumed. Percent is based on the elements width.
70
+
|**offsetXMin** |`Number` or `String` |`0` |Minimum **x** offset in `%` or `px`. If no unit is passed percent is assumed. Percent is based on the elements width.
71
+
|**offsetYMax** |`Number` or `String` |`0` |Maximum **y** offset in `%` or `px`. If no unit is passed percent is assumed. Percent is based on the elements height.
72
+
|**offsetYMin** |`Number` or `String` |`0` |Minimum **y** offset in `%` or `px`. If no unit is passed percent is assumed. Percent is based on the elements height.
73
+
|**slowerScrollRate** |`Boolean` |`false` |Internally swaps the min/max offset y values of the parallax component to give the appearance of moving faster or slower than the default rate of scroll.
74
+
|**tag** |`String` |`div` |Optionally pass an element tag name to be applied to the outer most parallax element.
0 commit comments