Skip to content

useParallax ​

Category
Export Size
1.5 kB
Last Changed
last week

Create parallax effect easily. It uses useDeviceOrientation and fallback to useMouse if orientation is not supported.

Demo ​

roll: .nan
tilt: .nan
source: mouse
Credit of images to Jarom Vogel

Usage ​

vue
<script setup>
import { useParallax } from '@vueuse/core'

const container = ref(null)
const { tilt, roll, source } = useParallax(container)
</script>

<template>
  <div ref="container" />
</template>

Type Declarations ​

typescript
export interface UseParallaxOptions extends ConfigurableWindow {
  deviceOrientationTiltAdjust?: (i: number) => number
  deviceOrientationRollAdjust?: (i: number) => number
  mouseTiltAdjust?: (i: number) => number
  mouseRollAdjust?: (i: number) => number
}
export interface UseParallaxReturn {
  /**
   * Roll value. Scaled to `-0.5 ~ 0.5`
   */
  roll: ComputedRef<number>
  /**
   * Tilt value. Scaled to `-0.5 ~ 0.5`
   */
  tilt: ComputedRef<number>
  /**
   * Sensor source, can be `mouse` or `deviceOrientation`
   */
  source: ComputedRef<"deviceOrientation" | "mouse">
}
/**
 * Create parallax effect easily. It uses `useDeviceOrientation` and fallback to `useMouse`
 * if orientation is not supported.
 *
 * @param target
 * @param options
 */
export declare function useParallax(
  target: MaybeElementRef,
  options?: UseParallaxOptions,
): UseParallaxReturn

Source ​

Source • Demo • Docs

Contributors ​

Anthony Fu
Antério Vieira
huiliangShen
Jelf
wheat

Changelog ​

v10.8.0 on 2/20/2024
3fd94 - feat: can work with different screen orientation (#3675)
v8.9.3 on 7/14/2022
e4b5b - fix!: rename type ParallaxOptions to UseParallaxOptions and ParallaxReturn to UseParallaxReturn (#1885)

Released under the MIT License.