Skip to content

usePreferredContrast

Category
Export Size
583 B
Last Changed
last year

Reactive prefers-contrast media query.

Demo

Preferred contrast:
no-preference

Usage

js
import { usePreferredContrast } from '@vueuse/core'

const preferredContrast = usePreferredContrast()

Component Usage

This function also provides a renderless component version via the @vueuse/components package. Learn more about the usage.

vue
<template>
  <UsePreferredContrast v-slot="{ contrast }">
    Preferred Contrast: {{ contrast }}
  </UsePreferredContrast>
</template>

Type Declarations

typescript
export type ContrastType = "more" | "less" | "custom" | "no-preference"
/**
 * Reactive prefers-contrast media query.
 *
 * @see https://vueuse.org/usePreferredContrast
 * @param [options]
 */
export declare function usePreferredContrast(
  options?: ConfigurableWindow,
): ComputedRef<ContrastType>

Source

SourceDemoDocs

Contributors

Anthony Fu
丶远方
vaakian X
Zhao

Changelog

v9.11.0 on 1/17/2023
d5321 - fix(components): mark defineComponent as pure (#2623)
v9.1.1 on 8/23/2022
6db05 - feat: new function (#2040)

Released under the MIT License.