# @ryova/parallax_component

> vue-component decorator for parallax effect

Latest version **0.0.17** (published 2020-08-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install @ryova/parallax_component
pnpm add @ryova/parallax_component
yarn add @ryova/parallax_component
bun add @ryova/parallax_component
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.17 |
| Published | 2020-08-29 |
| First published | 2020-08-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 23.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Alexey Revo |
| Maintainers | ryova |
| Keywords | vue, vue-component, parallax |

## Links

- npm: https://www.npmjs.com/package/@ryova/parallax_component
- npm.io page: https://npm.io/package/@ryova/parallax_component

## Recent versions

- 0.0.17 (latest) — 2020-08-29
- 0.0.16 — 2020-08-29
- 0.0.15 — 2020-08-29
- 0.0.14 — 2020-08-29
- 0.0.13 — 2020-08-29
- 0.0.12 — 2020-08-29
- 0.0.11 — 2020-08-29
- 0.0.10 — 2020-08-29
- 0.0.9 — 2020-08-29
- 0.0.8 — 2020-08-29
- 0.0.7 — 2020-08-29
- 0.0.4 — 2020-08-28
- 0.0.3 — 2020-08-28
- 0.0.1 — 2020-08-28

## README

# Parallax Component

Simple use vue-component decorator / container for parallax effect.

![](https://s8.gifyu.com/images/2020-08-29_22-21-00.gif)

## Install & Registration

```sh
  npm i @ryova/parallax_component -s
```
---

Local registration:
```js
  import Parallax from '@ryova/parallax_component'
```
---

Dynamic import:

```js
components: {
  Parallax: () => import('@ryova/parallax_component')
}
```
---

## Usage & Props

```html
<div class="container">
  <parallax :Options="{ OpacityFade: true, OpacityFadeOffset: 150 }">
    <span class="item"><span>
  </parallax>
  //or
  <parallax :OpacityFade="true" :OpacityFadeOffset="150">
    <span class="item"><span>
  </parallax>
</div>
```
---

## Props values

| Prop | Default value | Type |
| - | - | - |
| Options| null | Object |
| Multiplier| 0.25 | Number |
| Direction | down | String |
| OpacityFade | false | Boolean |
| OpacityFadeOffset | 0 | Number |

---
## Options Prop

Options object is just a simple props object. For comfortable use.
```js
  const S = this.Options?.Multiplier ?? this.Multiplier
```

---
_Source: https://npm.io/package/@ryova/parallax_component · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._