Skip to content

Commit 369c68c

Browse files
committed
Merge branch 'release/2.4.3'
2 parents 96b7323 + aa32abe commit 369c68c

File tree

2 files changed

+17
-9
lines changed

2 files changed

+17
-9
lines changed

README.md

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,14 @@ or yarn
2626
yarn add react-scroll-parallax
2727
```
2828

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+
2937
## Overview
3038

3139
- [Usage](#usage)
@@ -86,16 +94,16 @@ The main component for manipulating a DOM element's position based on it's posit
8694

8795
The following are all props that can be passed to the `<Parallax>` component:
8896

89-
| Name | Type | Default | Description |
90-
| -------------- | :-----------------------------: | :------- | ------------------------------------------------------------------------------------------------------------------ |
97+
| Name | Type | Default | Description |
98+
| -------------- | :-----------------------------: | :------- | ------------------------------------------------------------------------------------------------------------------------------------ |
9199
| **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. |
92100
| **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. |
99107

100108
## \<ParallaxBanner>
101109

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "react-scroll-parallax",
3-
"version": "2.4.2",
3+
"version": "2.4.3",
44
"description": "React components to create parallax scroll effects for banners, images or any other DOM elements.",
55
"repository": {
66
"type": "git",

0 commit comments

Comments
 (0)