⬅️ Back to Table of Contents

📄 usePreferredReducedMotion

📊 Analysis Summary

Metric	Count
🔧 Functions	1
📦 Imports	3
🟢 Vue Composition API	1
📑 Type Aliases	1

📚 Table of Contents

• Imports
• Vue Composition API
• Functions
• Type Aliases

🛠️ File Location:

📂 packages/core/usePreferredReducedMotion/index.ts

📦 Imports

Name	Source
ConfigurableWindow	../_configurable
computed	vue
useMediaQuery	../useMediaQuery

---

Vue Composition API

Name	Type	Reactive Variables	Composables
computed	computed	none	none

---

Functions

usePreferredReducedMotion(options: ConfigurableWindow): any

Reactive prefers-reduced-motion media query.

Parameters:

• options any (optional): No description

See: https://vueuse.org/usePreferredReducedMotion

Tags: @__NO_SIDE_EFFECTS__

Raw JSDoc

/**
 * Reactive prefers-reduced-motion media query.
 *
 * @see https://vueuse.org/usePreferredReducedMotion
 * @param [options]
 *
 * @__NO_SIDE_EFFECTS__
 */

Calls:

• useMediaQuery (from ../useMediaQuery)
• computed (from vue)

Code

export function usePreferredReducedMotion(options?: ConfigurableWindow) {
  const isReduced = useMediaQuery('(prefers-reduced-motion: reduce)', options)

  return computed<ReducedMotionType>(() => {
    if (isReduced.value)
      return 'reduce'
    return 'no-preference'
  })
}

---

Type Aliases

ReducedMotionType

type ReducedMotionType = 'reduce' | 'no-preference';

---

Generated by Syntax Scribe