usePreferredContrast

Category

Export Size

583 B

Last Changed

8 months ago

Reactive prefers-contrast media query.

Usage

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.

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

Type Declarations

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

Source • Demo • Docs

© 2019-present Anthony Fu
Licensed under the MIT License.
https://vueuse.org/core/usePreferredContrast/