useDropZone

Category

Elements

Export Size

990 B

Last Changed

3 hours ago

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

WARNING

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

Demo

source

Drop files from your computer on to drop zones

General DropZone

isOverDropZone: false

Image DropZone

isOverDropZone: false

用法

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

const dropZoneRef = ref<HTMLDivElement>()

function onDrop(files: File[] | null) {
  // 当文件被放置到区域时调用
}

const { isOverDropZone } = useDropZone(dropZoneRef, {
  onDrop,
  // 指定要接收的数据类型
  dataTypes: ['image/jpeg'],
  // 控制多文件放置
  multiple: true,
  // 是否阻止未处理事件的默认行为
  preventDefaultForUnhandled: false,
})
</script>

<template>
  <div ref="dropZoneRef">
    将文件拖放到这里
  </div>
</template>

Type Declarations

export interface UseDropZoneReturn {
  files: ShallowRef<File[] | null>
  isOverDropZone: ShallowRef<boolean>
}
export interface UseDropZoneOptions {
  /**
   * 允许的数据类型，如果未设置，则允许所有数据类型。
   * 也可以是检查数据类型的函数。
   */
  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

Source

Source • Demo • Docs

Contributors

jorshen

Changelog

No recent changes