Skip to content

Commit

Permalink
Merge pull request #6 from JB1905/1.2
Browse files Browse the repository at this point in the history
1.2
  • Loading branch information
JB1905 authored Jul 6, 2018
2 parents 770cc06 + cc05b63 commit 9e15347
Show file tree
Hide file tree
Showing 12 changed files with 126 additions and 376 deletions.
12 changes: 11 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,16 @@
# parlx.js Changelog

## 1.2.0 beta 2 / 1.2.0 (2018-07-05)
#### New Feature
- added support for all HTML5 tags as parallax div children

## 1.2.0 beta 1 (2018-06-12)
#### New Feature
- readded support for background-image

#### Bug Fix
- partly fixed bug with image scaling

## 1.1.0 rc 1 / 1.1.0 (2018-04-30)
#### Documentation
- updated comments
Expand All @@ -19,7 +30,6 @@
- fixed bug with autoinit in Node.js
- fixed bug with jQuery and Node.js compatibility


## 1.1.0 beta 3 (2018-03-30)
#### New Feature
- npm added
Expand Down
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@
## Demo
**[See plugin in action](https://jb1905.github.io/parlx.js/)**

## React.js plugin
If You use React.js, install component, with the implementation of the parlx.js library!
**[More here](https://github.com/JB1905/react-parlx/)**

## How to Install
At the beginning connect the library with Your project:

Expand All @@ -20,6 +24,11 @@ $ npm install parlx.js
$ yarn add parlx.js
```

## Soon!
**React.js component with library implementation**

[Beta here](https://www.npmjs.com/package/react-parlx)

## Getting Started
**If you added library via package manager use CommonJS/ES6 import:**
```js
Expand Down Expand Up @@ -73,7 +82,7 @@ To use it, add `data-parlx` to html element e.g:
Name | Type | Default | Description | Available options
-|-|-|-|-
**direction** | string | `vertical` | parallax element move direction | `vertical`, `horizontal`, `diagonal`
**type** | string | `background` | type of parallax | `foreground` (div move), `background` (inner image move)
**type** | string | `background` | type of parallax | `foreground` (div move), `background` (content move)
**speed** | number | `0.3` | parallax speed | values >= `-1` and <= `1`
**height** | string | `400px` | Height of parallax effect container | e.g: `500px`, `70vh`, `auto`
**mobile** | boolean | `true` | Enable or disable parallax effect on mobile devices | Enable `true`, disable `false`
Expand Down
289 changes: 1 addition & 288 deletions demo/css/style.css

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 9e15347

Please sign in to comment.