fix(useParallax)!: rename type ParallaxOptions to `UseParallaxOptio…

…ns` and `ParallaxReturn` to `UseParallaxReturn` (#1885)
vueuse · Jul 13, 2022 · e4b5bf2 · e4b5bf2
1 parent 9b4f956
commit e4b5bf2
Showing 1 changed file with 4 additions and 4 deletions.
diff --git a/packages/core/useParallax/index.ts b/packages/core/useParallax/index.ts
@@ -6,14 +6,14 @@ import { useMouseInElement } from '../useMouseInElement'
 import type { ConfigurableWindow } from '../_configurable'
 import { defaultWindow } from '../_configurable'
 
-export interface ParallaxOptions extends ConfigurableWindow {
+export interface UseParallaxOptions extends ConfigurableWindow {
   deviceOrientationTiltAdjust?: (i: number) => number
   deviceOrientationRollAdjust?: (i: number) => number
   mouseTiltAdjust?: (i: number) => number
   mouseRollAdjust?: (i: number) => number
 }
 
-export interface ParallaxReturn {
+export interface UseParallaxReturn {
   /**
    * Roll value. Scaled to `-0.5 ~ 0.5`
    */
@@ -37,8 +37,8 @@ export interface ParallaxReturn {
  */
 export function useParallax(
   target: MaybeElementRef,
-  options: ParallaxOptions = {},
-): ParallaxReturn {
+  options: UseParallaxOptions = {},
+): UseParallaxReturn {
   const {
     deviceOrientationTiltAdjust = i => i,
     deviceOrientationRollAdjust = i => i,