Skip to content

Commit 45e917a

Browse files
committed
add styleInner and styleOuter props to README
1 parent a124080 commit 45e917a

File tree

1 file changed

+12
-10
lines changed

1 file changed

+12
-10
lines changed

README.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -70,16 +70,18 @@ const ParallaxImage = () => (
7070

7171
The following are all props that can be passed to the React `<Parallax />` component:
7272

73-
|Name |Type |Default |Description
74-
|----------------------|:--------------------:|:---------|----------------------------------------
75-
|**className** |`String` | |Optionally pass additional class names to be added to the outer most parallax element.
76-
|**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.
77-
|**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.
78-
|**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.
79-
|**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.
80-
|**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.
81-
|**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.
82-
|**tag** |`String` |`div` |Optionally pass an element tag name to be applied to the outer most parallax element.
73+
| Name | Type | Default | Description |
74+
| -------------------- | :------------------: | :------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
75+
| **className** | `String` | | Optionally pass additional class names to be added to the outer most parallax element. |
76+
| **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. |
77+
| **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. |
78+
| **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. |
79+
| **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. |
80+
| **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. |
81+
| **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. |
82+
| **styleInner** | `Object` | | Optionally pass a style object to be added to the innermost parallax element |
83+
| **styleOuter** | `Object` | | Optionally pass a style object to be added to the outermost parallax element |
84+
| **tag** | `String` | `div` | Optionally pass an element tag name to be applied to the outermost parallax element. |
8385

8486
## \<ParallaxProvider>
8587

0 commit comments

Comments
 (0)