Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(usePreferredReducedMotion): new function #2039

Merged
merged 3 commits into from Aug 4, 2022
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/components/index.ts
Expand Up @@ -40,6 +40,7 @@ export * from '../core/usePointer/component'
export * from '../core/usePreferredColorScheme/component'
export * from '../core/usePreferredDark/component'
export * from '../core/usePreferredLanguages/component'
export * from '../core/usePreferredReducedMotion/component'
export * from '../core/useScreenSafeArea/component'
export * from '../core/useScroll/directive'
export * from '../core/useScrollLock/directive'
Expand Down
16 changes: 16 additions & 0 deletions packages/core/usePreferredReducedMotion/component.ts
@@ -0,0 +1,16 @@
import { defineComponent, reactive } from 'vue-demi'
import { usePreferredReducedMotion } from '@vueuse/core'

export const UsePreferredReducedMotion = defineComponent({
name: 'UsePreferredReducedMotion',
setup(props, { slots }) {
const data = reactive({
motion: usePreferredReducedMotion(),
})

return () => {
if (slots.default)
return slots.default(data)
}
},
})
12 changes: 12 additions & 0 deletions packages/core/usePreferredReducedMotion/demo.vue
@@ -0,0 +1,12 @@
<script setup lang="ts">
import { usePreferredReducedMotion } from '@vueuse/core'

const motion = usePreferredReducedMotion()
</script>

<template>
<note class="mb-2">
Preferred Motion:
</note>
<code>{{ motion }}</code>
</template>
23 changes: 23 additions & 0 deletions packages/core/usePreferredReducedMotion/index.md
@@ -0,0 +1,23 @@
---
category: Browser
---

# usePreferredReducedMotion

Reactive [prefers-reduced-motion](https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-reduced-motion) media query.

## Usage

```js
import { usePreferredReducedMotion } from '@vueuse/core'

const preferredMotion = usePreferredReducedMotion()
```

## Component Usage

```html
<UsePreferredReducedMotion v-slot="{ motion }">
Preferred Color Scheme: {{ motion }}
<UsePreferredReducedMotion>
```
21 changes: 21 additions & 0 deletions packages/core/usePreferredReducedMotion/index.ts
@@ -0,0 +1,21 @@
import { computed } from 'vue-demi'
import { useMediaQuery } from '../useMediaQuery'
import type { ConfigurableWindow } from '../_configurable'

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

/**
* Reactive prefers-reduced-motion media query.
*
* @see https://vueuse.org/usePreferredReducedMotion
* @param [options]
*/
export function usePreferredReducedMotion(options?: ConfigurableWindow) {
const isReduced = useMediaQuery('(prefers-reduced-motion: reduce)', options)

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