fargo
1a822493ba
963 markdown files reformatted with the repository's pinned prettier so pnpm format:check covers the folded tree like every other repo file. The formatter's embedded-language pass also normalized code fences (TS semicolons, closed HTML tags in examples, lowercased CSS hex colors, one renumbered list that skipped an index). Alphanumeric token deltas vs the fold commit were audited file-by-file; all are formatter-equivalent markup normalizations plus the four sanitized skills.
1.3 KiB
1.3 KiB
category
| category |
|---|
| Sensors |
useParallax
Create parallax effect easily. It uses useDeviceOrientation and fallback to useMouse if orientation is not supported.
Usage
<script setup lang="ts">
import { useParallax } from '@vueuse/core';
const container = ref(null);
const { tilt, roll, source } = useParallax(container);
</script>
<template>
<div ref="container" />
</template>
Type Declarations
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;