Skip to content

文件选择器(H5)组件

H5文件选择器API

注:类型中加粗项为特殊类型定义或枚举类型定义,可在下方查看具体定义

API说明类型是否为必传参数默认值备注
title文件选择器标题stringselectMode为file时:选择文件;selectMode为folder时:选择文件路径-
desc文件选择器描述string--
className文件选择器内容类名string--
selectMode文件选择器选择模式SELECT_MODE_TYPE'file'-
defaultPath文件选择器初始目录路径参数IPath-
fileTypeFilter文件类型筛选,优先级第三IFileTypeFilter--
driveIdFilterdriveId筛选,优先级第二IIdFilter--
fileIdFilter文件Id筛选,优先级第一IIdFilter--
fileName文件名string-配合showRenameFile参数使用
showCreateFolder是否显示创建文件夹booleanfalse为true时会覆盖取消按钮
showRenameFile是否显示文件重命名booleanfalse-
showSearch是否显示搜索栏booleantrue-
showFooter是否显示底部按钮booleantrue该参数仅在选择文件目录模式生效,选择文件模式没有底部按钮
okText确定按钮文案string | ReactNode确定-
cancelText取消按钮文案string | ReactNode取消-
onOK确定按钮回调function(target: files | folder, fileName?: string)--
onCancel取消按钮回调function()-点击首页返回按钮回调

文件选择器API中特殊类型定义

IPath

API说明类型是否为必传参数默认值备注
page文件选择器页面PAGE_TYPE--
parentId当前目录idstring-若右侧初始想在某一目录下,该参数必传;若在根目录则传‘0’
driveIddriveIdstring-若右侧初始想在某一目录下,该参数必传
groupId当前路径团队idstring-若右侧初始想在某一目录下,该参数必传;若在我的云文档目录下则传"private";若在我的设备目录下则传"roaming"
type当前路径类型PATH_TYPE-若右侧初始想在某一目录下,该参数必传
name当前路径名string-若右侧初始想在某一目录下,该参数必传

IFileTypeFilter

API说明类型是否为必传参数默认值备注
disabled文件类型黑名单(优先级高)array<FILE_FILTER_TYPE> | array<string>[]由文件后缀名或由文件选择器组件提供的常见组件类型后缀枚举组成的数组
enabled文件类型白名单array<FILE_FILTER_TYPE> | array<string>[]由文件后缀名或由文件选择器组件提供的常见组件类型后缀枚举组成的数组

IIdFilter

API说明类型是否为必传参数默认值
disabledid黑名单(优先级高)array<string>[]
enabledid白名单array<string>[]

文件选择器API中枚举类型定义

SELECT_MODE_TYPE

枚举值枚举值类型说明
filestring选择文件模式
folderstring选择文件目录模式

PAGE_TYPE

枚举值枚举值类型说明
homestring首页(团队列表)
spacestring我的云文档列表
groupstring团队文件列表
roamingstring我的设备列表
searchstring搜索

PATH_TYPE

枚举值枚举值类型对应文件后缀
folderstring文件夹
wholestring全员团队
deptstring部门团队
normalstring普通团队

FILE_FILTER_TYPE

枚举值枚举值类型说明备注
IMG_ARRAYstring图片类型['jpg', 'jpeg', 'png', 'gif', 'bmp', 'svg']
ZIP_ARRAYstring压缩包类型['zip', '7z', 'rar', 'iso', 'gz', 'tar']
DOC_ARRAYstring文字类型['wps','wpt','doc','docx','dot','rtf','xml','docm','dotm','wdoc','uof', 'uot3','uott3']
XLS_ARRAYstring表格类型['et','ett','xls','xlsx','xlsm','xlsb','xlam','xltx','xltm','xlt','xla', 'xlw','odc','uxdc','dbf','prn','wxls','csv']
PPT_ARRAYstring演示类型['dps','dpt','pptx','ppt','pptm','ppsx','pps','ppsm','potx','pot','potm','wpd','wppt']
TXT_ARRAYstring文本类型['txt', 'text']
VIDEO_ARRAYstring视频类型['asf','avi','wm','wmp','wmv','ram','rm','rmvb','rp','rpm','rt','smi','smil','dat','m1v','m2p','m2t','m2ts','m2v','mp2v','mpe','mpeg','mpg','mpv2','pss','pva','tp','tpr','ts','m4b','m4p','m4v','mp4','mpeg4','3g2','3gp','3gp2','3gpp','mov','qt','f4v','flv','hlv','swf','ifo','vob','amv','bik','csf','divx','evo','ivm','mkv','mod','mts','ogm','pmp','scm','tod','vp6','webm','xlmv']
AUDIO_ARRAYstring音频类型['aac','ac3','amr','ape','cda','dts','flac','m1a','m2a','m4a','mid','midi','mka','mp2','mp3','mpa','ogg','ra','tak','tta','wav','wma','wv']