Skip to content

Commit 60b40be

Browse files
committed
update README
1 parent 2446140 commit 60b40be

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,11 @@ or yarn
3535
yarn add react-scroll-parallax
3636
```
3737

38-
## Overview
38+
## Documentation
3939

40-
- [Usage](#usage)
40+
- [Example Usage](#usage)
4141
- [`<Parallax>`](/docs/parallax-component.md)
42-
- [Parallax Props](/docs/parallax-component.md#parallax-props)
42+
- [Parallax Props](/docs/parallax-component.md#props)
4343
- [`<ParallaxBanner>`](/docs/parallax-banner-component.md)
4444
- [Banner Usage](/docs/parallax-banner-component.md#banner-usage)
4545
- [Banner Props](/docs/parallax-banner-component.md#banner-props)
@@ -52,7 +52,7 @@ yarn add react-scroll-parallax
5252
- [Optimizations to Reduce Jank](#optimizations-to-reduce-jank)
5353
- [PSA](#psa)
5454

55-
## Example Usage
55+
## Usage
5656

5757
The [`<ParallaxProvider>`](#parallaxprovider) must wrap the component tree that contains all `<Parallax>` components. This should be a top level component like `<App>`. For example:
5858

docs/parallax-component.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,8 @@ The following are all props that can be passed to the `<Parallax>` component:
5151
| Name | Type | Default | Description |
5252
| -------------- | :----------------------: | :------ | -------------------------------------------------------------------------------------------------------------------------------------------- |
5353
| **speed** | `number` | | A value representing the elements scroll speed. If less than zero scroll will appear slower. If greater than zero scroll will appear faster. |
54-
| **x** | `string[]` or `number[]` | | Start and end translation on x-axis in `%` or `px`. If no unit is passed percent is assumed. Percent is based on the elements width. |
55-
| **y** | `string[]` or `number[]` | | Start and end translation on y-axis in `%` or `px`. If no unit is passed percent is assumed. Percent is based on the elements height. |
54+
| **translateX** | `string[]` or `number[]` | | Start and end translation on x-axis in `%` or `px`. If no unit is passed percent is assumed. Percent is based on the elements width. |
55+
| **translateY** | `string[]` or `number[]` | | Start and end translation on y-axis in `%` or `px`. If no unit is passed percent is assumed. Percent is based on the elements height. |
5656
| **rotate** | `string[]` or `number[]` | | Start and end rotation on z-axis in `deg`, `rad`, or `turn`. If no unit is passed `deg` is assumed. |
5757
| **rotateX** | `string[]` or `number[]` | | Start and end rotation on x-axis in `deg`, `rad`, or `turn`. If no unit is passed `deg` is assumed. |
5858
| **rotateY** | `string[]` or `number[]` | | Start and end rotation on y-axis in `deg`, `rad`, or `turn`. If no unit is passed `deg` is assumed. |

0 commit comments

Comments
 (0)