文件选择器(H5)组件
H5文件选择器API
注:类型中加粗项为特殊类型定义或枚举类型定义,可在下方查看具体定义
| API | 说明 | 类型 | 是否为必传参数 | 默认值 | 备注 |
|---|---|---|---|---|---|
| title | 文件选择器标题 | string | 是 | selectMode为file时:选择文件;selectMode为folder时:选择文件路径 | - |
| desc | 文件选择器描述 | string | 否 | - | - |
| className | 文件选择器内容类名 | string | 否 | - | - |
| selectMode | 文件选择器选择模式 | SELECT_MODE_TYPE | 否 | 'file' | - |
| defaultPath | 文件选择器初始目录路径参数 | IPath | 否 | - | |
| fileTypeFilter | 文件类型筛选,优先级第三 | IFileTypeFilter | 否 | - | - |
| driveIdFilter | driveId筛选,优先级第二 | IIdFilter | 否 | - | - |
| fileIdFilter | 文件Id筛选,优先级第一 | IIdFilter | 否 | - | - |
| fileName | 文件名 | string | 否 | - | 配合showRenameFile参数使用 |
| showCreateFolder | 是否显示创建文件夹 | boolean | 否 | false | 为true时会覆盖取消按钮 |
| showRenameFile | 是否显示文件重命名 | boolean | 否 | false | - |
| showSearch | 是否显示搜索栏 | boolean | 否 | true | - |
| showFooter | 是否显示底部按钮 | boolean | 否 | true | 该参数仅在选择文件目录模式生效,选择文件模式没有底部按钮 |
| okText | 确定按钮文案 | string | ReactNode | 否 | 确定 | - |
| cancelText | 取消按钮文案 | string | ReactNode | 否 | 取消 | - |
| onOK | 确定按钮回调 | function(target: files | folder, fileName?: string) | 是 | - | - |
| onCancel | 取消按钮回调 | function() | 是 | - | 点击首页返回按钮回调 |
文件选择器API中特殊类型定义
IPath
| API | 说明 | 类型 | 是否为必传参数 | 默认值 | 备注 |
|---|---|---|---|---|---|
| page | 文件选择器页面 | PAGE_TYPE | 是 | - | - |
| parentId | 当前目录id | string | 否 | - | 若右侧初始想在某一目录下,该参数必传;若在根目录则传‘0’ |
| driveId | driveId | string | 否 | - | 若右侧初始想在某一目录下,该参数必传 |
| groupId | 当前路径团队id | string | 否 | - | 若右侧初始想在某一目录下,该参数必传;若在我的云文档目录下则传"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 | 说明 | 类型 | 是否为必传参数 | 默认值 |
|---|---|---|---|---|
| disabled | id黑名单(优先级高) | array<string> | 否 | [] |
| enabled | id白名单 | array<string> | 否 | [] |
文件选择器API中枚举类型定义
SELECT_MODE_TYPE
| 枚举值 | 枚举值类型 | 说明 |
|---|---|---|
| file | string | 选择文件模式 |
| folder | string | 选择文件目录模式 |
PAGE_TYPE
| 枚举值 | 枚举值类型 | 说明 |
|---|---|---|
| home | string | 首页(团队列表) |
| space | string | 我的云文档列表 |
| group | string | 团队文件列表 |
| roaming | string | 我的设备列表 |
| search | string | 搜索 |
PATH_TYPE
| 枚举值 | 枚举值类型 | 对应文件后缀 |
|---|---|---|
| folder | string | 文件夹 |
| whole | string | 全员团队 |
| dept | string | 部门团队 |
| normal | string | 普通团队 |
FILE_FILTER_TYPE
| 枚举值 | 枚举值类型 | 说明 | 备注 |
|---|---|---|---|
| IMG_ARRAY | string | 图片类型 | ['jpg', 'jpeg', 'png', 'gif', 'bmp', 'svg'] |
| ZIP_ARRAY | string | 压缩包类型 | ['zip', '7z', 'rar', 'iso', 'gz', 'tar'] |
| DOC_ARRAY | string | 文字类型 | ['wps','wpt','doc','docx','dot','rtf','xml','docm','dotm','wdoc','uof', 'uot3','uott3'] |
| XLS_ARRAY | string | 表格类型 | ['et','ett','xls','xlsx','xlsm','xlsb','xlam','xltx','xltm','xlt','xla', 'xlw','odc','uxdc','dbf','prn','wxls','csv'] |
| PPT_ARRAY | string | 演示类型 | ['dps','dpt','pptx','ppt','pptm','ppsx','pps','ppsm','potx','pot','potm','wpd','wppt'] |
| TXT_ARRAY | string | 文本类型 | ['txt', 'text'] |
| VIDEO_ARRAY | string | 视频类型 | ['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_ARRAY | string | 音频类型 | ['aac','ac3','amr','ape','cda','dts','flac','m1a','m2a','m4a','mid','midi','mka','mp2','mp3','mpa','ogg','ra','tak','tta','wav','wma','wv'] |