useDropZone

分类

元素

导出大小

1.13 kB

上次更改

7 个月前

创建一个可以放置文件的区域。

警告

由于 Safari 浏览器的限制，文件类型验证只能在拖放事件期间进行，而不能在拖动事件期间进行。因此，在 Safari 中进行拖动操作时，无论文件类型如何，isOverDropZone 的值将始终为 true。

演示

源代码演示场 (测试版)

将文件从您的电脑拖放到拖放区

通用拖放区

isOverDropZone: false

图片拖放区

isOverDropZone: false

用法

vue

<script setup lang="ts">
import { useDropZone
 } from '@vueuse/core'
import { ref
 } from 'vue'

const dropZoneRef
 = ref
<HTMLDivElement>()

function onDrop
(files
: File[] | null) {
  // called when files are dropped on zone
}

const { isOverDropZone
 } = useDropZone
(dropZoneRef
, {
  onDrop
,
  // specify the types of data to be received.
  dataTypes
: ['image/jpeg'],
  // control multi-file drop
  multiple
: true,
  // whether to prevent default behavior for unhandled events
  preventDefaultForUnhandled
: false,
})
</script>

<template>
  <div
 ref
="dropZoneRef
">
    Drop files here
  </div
>
</template>

类型声明

显示类型声明

export interface UseDropZoneReturn {
  files
: ShallowRef
<File[] | null>
  isOverDropZone
: ShallowRef
<boolean>
}
export interface UseDropZoneOptions {
  /**
   * Allowed data types, if not set, all data types are allowed.
   * Also can be a function to check the data types.
   */
  dataTypes
?:
    | MaybeRef
<readonly string[]>
    | ((types
: readonly string[]) => boolean)
  onDrop
?: (files
: File[] | null, event
: DragEvent) => void
  onEnter
?: (files
: File[] | null, event
: DragEvent) => void
  onLeave
?: (files
: File[] | null, event
: DragEvent) => void
  onOver
?: (files
: File[] | null, event
: DragEvent) => void
  /**
   * Allow multiple files to be dropped. Defaults to true.
   */
  multiple
?: boolean
  /**
   * Prevent default behavior for unhandled events. Defaults to false.
   */
  preventDefaultForUnhandled
?: boolean
}
export declare function useDropZone
(
  target
: MaybeRefOrGetter
<HTMLElement | Document | null | undefined>,
  options
?: UseDropZoneOptions | UseDropZoneOptions["onDrop"],
): UseDropZoneReturn