useEyeDropper

类别

Browser

导出体积

283 B

上次更改

2 months ago

响应式的 EyeDropper API

示例

源码 playground (beta)

你的浏览器不支持此功能

用法

import { useEyeDropper
 } from '@vueuse/core'

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

组件用法

vue

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

类型声明

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 {
  /**
   * 初始 sRGBHex.
   *
   * @default ''
   */
  initialValue
?: string
}
/**
 * 响应式 [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
>