VueUseuseEyeDropper
Reactive EyeDropper API
Demo
Not Supported by Your Browser
Usage
ts
import { useEyeDropper } from '@vueuse/core'
const { isSupported, open, sRGBHex } = useEyeDropper()
import { useEyeDropper } from '@vueuse/core'
const { isSupported, open, sRGBHex } = useEyeDropper()
Component Usage
This function also provides a renderless component version via the
@vueuse/componentspackage. Learn more about the usage.
html
<UseEyeDropper v-slot="{ isSupported, sRGBHex, open }">
<button :disabled="!isSupported" @click="open">
sRGBHex: {{ sRGBHex }}
</button>
</UseEyeDropper>
<UseEyeDropper v-slot="{ isSupported, sRGBHex, open }">
<button :disabled="!isSupported" @click="open">
sRGBHex: {{ sRGBHex }}
</button>
</UseEyeDropper>
Type Declarations
typescript
export interface EyeDropperOpenOptions {
/**
* @see https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal
*/
signal?: AbortSignal
}
export interface EyeDropper {
new (): EyeDropper
open: (options?: EyeDropperOpenOptions) => Promise<{
sRGBHex: string
}>
[Symbol.toStringTag]: "EyeDropper"
}
export interface UseEyeDropperOptions {
/**
* Initial sRGBHex.
*
* @default ''
*/
initialValue?: string
}
/**
* Reactive [EyeDropper API](https://developer.mozilla.org/en-US/docs/Web/API/EyeDropper_API)
*
* @see https://vueuse.org/useEyeDropper
* @param initialValue string
*/
export declare function useEyeDropper(options?: UseEyeDropperOptions): {
isSupported: Ref<boolean>
sRGBHex: Ref<string>
open: (openOptions?: EyeDropperOpenOptions) => Promise<
| {
sRGBHex: string
}
| undefined
>
}
export declare type UseEyeDropperReturn = ReturnType<typeof useEyeDropper>
export interface EyeDropperOpenOptions {
/**
* @see https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal
*/
signal?: AbortSignal
}
export interface EyeDropper {
new (): EyeDropper
open: (options?: EyeDropperOpenOptions) => Promise<{
sRGBHex: string
}>
[Symbol.toStringTag]: "EyeDropper"
}
export interface UseEyeDropperOptions {
/**
* Initial sRGBHex.
*
* @default ''
*/
initialValue?: string
}
/**
* Reactive [EyeDropper API](https://developer.mozilla.org/en-US/docs/Web/API/EyeDropper_API)
*
* @see https://vueuse.org/useEyeDropper
* @param initialValue string
*/
export declare function useEyeDropper(options?: UseEyeDropperOptions): {
isSupported: Ref<boolean>
sRGBHex: Ref<string>
open: (openOptions?: EyeDropperOpenOptions) => Promise<
| {
sRGBHex: string
}
| undefined
>
}
export declare type UseEyeDropperReturn = ReturnType<typeof useEyeDropper>
Source
Contributors
Jelf
Anthony Fu
wheat