Skip to content

基于Vue3实现的文件选择插件,支持无限层次的文件夹嵌套

Notifications You must be signed in to change notification settings

likaia/file-folder-selector

Repository files navigation

file-folder-selector · npm yarn github

基于Vue3实现的文件选择插件,支持无限层次的文件夹嵌套

English documents please move: README-EN.md

效果图如下: 效果图

插件安装

yarn add file-folder-selector

# or

npm install file-folder-selector --save

插件使用

在你需要使用此插件的业务代码中导入插件。

<script setup lang="ts">
  import { FileSelect } from "file-folder-selector";
  // 组件的样式文件,可以在项目的业务代码内导入,也可以在项目的入口文件导入
  import "file-folder-selector/dist/style.css";
</script>

template中使用即可。

<template>
  <file-select />
</template>

参数说明

插件接收5个可选参数:

  • fileData 文件树结构数据
    • title 文件名, 值为string 类型
    • id 文件id, 值为string 类型
    • type 文件类型, 值为"file"或"folder"
    • imgSrc 文件图片地址(可选参数),值为string 类型
    • childData 子文件数据(可选参数),值为array类型,如果type为"folder",则传此参数,数组中的每一项类型就为fileData的类型。
  • defaultFolderImage 默认的文件夹图标,值为string 类型
  • defaultFileImage 默认的文件图标,值为string 类型
  • defaultSearchImage 默认的搜索图标,值为string 类型
  • defaultFolderPathImage 默认的文件夹路径图标,值为string 类型

注意:插件默认的图标更换不支持svg格式的图片,插件的fileData参数可参考源码中的FileConfig.json文件

插件提供了1个回调函数:

  • getSelectedFile 获取已选择的文件,它有1个参数selectedArray,它值为array类型,数组中的每一项类型为:{title: string; id: string; type: string }

具体的使用方法可以参考源码中的 file-select-test.vue 文件。

写在最后

至此,插件的所有使用方法就介绍完了。

我是神奇的程序员,一位前端开发工程师。

如果你对我感兴趣,请移步我的个人网站,进一步了解。

About

基于Vue3实现的文件选择插件,支持无限层次的文件夹嵌套

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published