@pluginjs/parallax

Parallax

A flexible modern parallax js plugin.

Samples

Introduction

Installation

Yarn

yarn add @pluginjs/parallax

NPM

npm i @pluginjs/parallax

Getting Started

CDN:

Development:

<script src="https://unpkg.com/@pluginjs/parallax/dist/parallax.js"></script>
<link rel="stylesheet" href="https://unpkg.com/@pluginjs/parallax/dist/parallax.css">

Production:

<script src="https://unpkg.com/@pluginjs/parallax/dist/parallax.min.js"></script>
<link rel="stylesheet" href="https://unpkg.com/@pluginjs/parallax/dist/parallax.min.css">

Initialize

HTML:

<div class="element"></div>

ECMAScript Module:

import Parallax from "@pluginjs/parallax"
import "@pluginjs/parallax/dist/parallax.css"

Parallax.of(document.querySelector('.element'), options)

CommonJS:

require("@pluginjs/parallax/dist/parallax.css")
const Parallax = require("@pluginjs/parallax")

Parallax.of(document.querySelector('.element'), options)

Browser:

<link rel="stylesheet" href="https://unpkg.com/@pluginjs/parallax/dist/parallax.css">
<script src="https://unpkg.com/@pluginjs/parallax/dist/parallax.js"></script>
<script>
  Pj.parallax('.element', options)
</script>

API

Options

Options are called on parallax instances through the parallax options itself. You can also save the instances to variable for further use.

Name	Description	Default
"theme"	Set plugin theme option	null
"container"	Set container	null
"direction"	Set direction ['vertical', 'horizontal']	vertical
"type"	Set type ['scroll', 'opacity', 'scale']	scroll
"speed"	Set speed [-1 ~ 1]	0.5
"mode"	Set mode ['background', 'image']	background
"image"	Set image [null, src, {}]	null
"video"	Set video [null, {}]	null
"loader"	Set loader [true, false, {}]	true

Events

Events are called on parallax instances through the parallax events itself. You can also save the instances to variable for further use.

Name	Description
"ready"	Gets fired when plugin has ready
"enable"	Gets fired when plugin has enabled
"disable"	Gets fired when plugin has disabled
"destroy"	Gets fired when plugin has destroy
"enter"	Gets fired when plugin has enter viewport
"leave"	Gets fired when plugin has leave viewport

Methods

Methods are called on parallax instances through the parallax method itself. You can also save the instances to variable for further use.

Name	Description
"enable"	Enabled plugin if plugin is disabled
"disable"	Disable plugin
"destroy"	Destroy plugin
"setSpeed"	Set value of setSpeed
"getSpeed"	Get value of getSpeed

Classes

Name | Description | Default --|| "NAMESPACE" | Declare plugin namespace | pj-parallax "CONTAINER" | Declare plugin container node | {namespace}-container

Browser support

Tested on all major browsers.

IE / Edge	Firefox	Chrome	Safari	Opera
IE11, Edge	last 2 versions	last 2 versions	last 2 versions	last 2 versions

License

@pluginjs/parallax is Licensed under the GPL-v3 license.

If you want to use @pluginjs/parallax project to develop commercial sites, themes, projects, and applications, the Commercial license is the appropriate license. With this option, your source code is kept proprietary.

For purchase an Commercial License, contact us [e-mail].

Copyright

Copyright (C) 2022 Creation Studio Limited.