stack/v1/packages/mosaic/framework/skills/vueuse-functions/references/useEyeDropper.md

category

category
Browser

useEyeDropper

Reactive EyeDropper API

Usage

import { useEyeDropper } from '@vueuse/core';

const { isSupported, open, sRGBHex } = useEyeDropper();

Component Usage

<template>
  <UseEyeDropper v-slot="{ isSupported, sRGBHex, open }">
    <button :disabled="!isSupported" @click="() => open()">sRGBHex: {{ sRGBHex }}</button>
  </UseEyeDropper>
</template>

Type Declarations

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
 *
 * @__NO_SIDE_EFFECTS__
 */
export declare function useEyeDropper(options?: UseEyeDropperOptions): {
  isSupported: ComputedRef<boolean>;
  sRGBHex: ShallowRef<string, string>;
  open: (openOptions?: EyeDropperOpenOptions) => Promise<
    | {
        sRGBHex: string;
      }
    | undefined
  >;
};
export type UseEyeDropperReturn = ReturnType<typeof useEyeDropper>;