# vue-parallaxy

> Vue 3 component for parallax scrolling effects

Latest version **2.0.0** (published 2026-11-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install vue-parallaxy
pnpm add vue-parallaxy
yarn add vue-parallaxy
bun add vue-parallaxy
```

## Health

**Score 60/100 (C)** — status: active.

Positive: esm support; no vulnerabilities; recently updated; high maintenance score.

Warnings: low downloads; no types.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2026-11-19 |
| First published | 2016-12-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Node | >=20.19.0 |
| Dependencies | 0 |
| Unpacked size | 326.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 625 |
| Author | Jakub Juszczak |
| Maintainers | apertureless |
| Keywords | vue.js, Vue, vue3, parallax, scrolling, image effect |

## Links

- npm: https://www.npmjs.com/package/vue-parallaxy
- Repository: https://github.com/apertureless/vue-parallax
- Homepage: https://apertureless.github.io/vue-parallax/
- Issues: https://github.com/apertureless/vue-parallax/issues
- npm.io page: https://npm.io/package/vue-parallaxy

## Alternatives

- [exif-parser](https://npm.io/package/exif-parser.md) — 3.8M weekly downloads
- [vite-plugin-compression](https://npm.io/package/vite-plugin-compression.md) — 569.5K weekly downloads
- [pica](https://npm.io/package/pica.md) — 442.4K weekly downloads
- [@reportportal/client-javascript](https://npm.io/package/@reportportal/client-javascript.md) — 408.8K weekly downloads
- [@tldraw/state](https://npm.io/package/@tldraw/state.md) — 316.0K weekly downloads

## Recent versions

- 2.0.0 (latest) — 2026-11-19
- 1.1.1 — 2018-02-02
- 1.1.0 — 2018-01-31
- 1.0.4 — 2017-11-06
- 1.0.3 — 2017-05-04
- 1.0.2 — 2017-03-17
- 1.0.1 — 2017-03-08
- 1.0.0 — 2017-03-01
- 0.1.4 — 2017-02-22
- 0.1.3 — 2017-01-18
- 0.1.2 — 2017-01-12
- 0.1.1 — 2016-12-18

## README

# vue-parallaxy
[![npm version](https://badge.fury.io/js/vue-parallaxy.svg)](https://badge.fury.io/js/vue-parallaxy)
[![vue3](https://img.shields.io/badge/vue-3.x-brightgreen.svg)](https://vuejs.org/)
[![license](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/apertureless/vue-parallax/blob/master/LICENSE.txt)

[![ko-fi](https://www.ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/C0C1WP7C)

Is a component for fast 60fps parallax scroll effects in Vue 3.

## Demo

[Demo here](https://apertureless.github.io/vue-parallax/)

## Install

`npm install vue-parallaxy` or `yarn add vue-parallaxy`

Peer dependency: `vue` `^3.2.0`

Vue 2 projects should stay on `vue-parallaxy@1`.

## Usage
*vue-parallax* works with slots. So you can pass an image or even srcsets for better mobile experiences.

```html
<!-- Image.vue -->

<template>
  <parallax>
    <img src="path/cool-background-image.jpg" alt="very cool bg">
  </parallax>
</template>

<script>
  import Parallax from 'vue-parallaxy'
  import 'vue-parallaxy/style.css'

  export default {
    components: {
      Parallax
    }
  }
</script>
```


## Props

| Prop   |      Type      |  Default Value | Description
|----------|:-------------:|------|------|
| parallax |  Boolean | true | Activates parallax effect |
| speedFactor |  Number   | 0.15 | factor on how strong the effect is|
| direction |  String   | 'up' | Either 'up' or 'down', determines scroll direction of image |
| fixed | Boolean | false | Other parallax effect. Image is fixed in position |
| sectionHeight | Number | 70 | section height for mobile |
| breakpoint | String | '(min-width: 968px)' | Media query for mobile deactivation |
| sectionClass | String | 'Masthead' | CSS class of the outer section tag |
| containerClass | String | 'Masthead__image' | CSS class of the container holding the  image |
| parallaxClass | String | 'is-parallax' | Modifier class for the parallax effect |
| fixedClass | String | 'is-fixed' | Modifier class for the fixed parallax effect |

## Customizing

You can change some of the behavior by changing the css classes. To be more clean, you can change them over the props. No need to overwrite or `!important` the existing classes.

## Build Setup

``` bash
# install dependencies
npm install

# serve with hot reload at localhost:5173
npm run dev

# build library for production
npm run build

# run unit tests
npm run unit

# run all tests
npm test
```

## Contributing

1. Fork it ( https://github.com/apertureless/vue-parallax/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request

## License

This software is distributed under [MIT license](LICENSE.txt).

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