首页
指南
API
开发
贡献
首页
指南
API
开发
贡献

扩展开发

扩展前端文件类型

对于已上传完成的文件，在前端界面上可以基于不同文件类型展示不同预览内容。文件管理器的附件字段内置了基于浏览器（内嵌于 iframe）的文件预览，这种方式支持大部分文件格式（图片、视频、音频和 PDF 等）直接在浏览器中进行预览。当文件格式不支持浏览器预览，或者有特殊的预览交互需要时，可以通过扩展基于文件类型的预览组件来实现。

示例

例如希望对图片类型的文件扩展一个轮播切换组件，可以通过以下代码方式：

import match from 'mime-match';
import { Plugin, attachmentFileTypes } from '@tachybase/client';

class MyPlugin extends Plugin {
  load() {
    attachmentFileTypes.add({
      match(file) {
        return match(file.mimetype, 'image/*');
      },
      Previewer({ index, list, onSwitchIndex }) {
        const onDownload = useCallback(
          (e) => {
            e.preventDefault();
            const file = list[index];
            saveAs(file.url, `${file.title}${file.extname}`);
          },
          [index, list],
        );
        return (
          <LightBox
            // discourageDownloads={true}
            mainSrc={list[index]?.url}
            nextSrc={list[(index + 1) % list.length]?.url}
            prevSrc={list[(index + list.length - 1) % list.length]?.url}
            onCloseRequest={() => onSwitchIndex(null)}
            onMovePrevRequest={() => onSwitchIndex((index + list.length - 1) % list.length)}
            onMoveNextRequest={() => onSwitchIndex((index + 1) % list.length)}
            imageTitle={list[index]?.title}
            toolbarButtons={[
              <button
                key={'preview-img'}
                style={{ fontSize: 22, background: 'none', lineHeight: 1 }}
                type="button"
                aria-label="Download"
                title="Download"
                className="ril-zoom-in ril__toolbarItemChild ril__builtinButton"
                onClick={onDownload}
              >
                <DownloadOutlined />
              </button>,
            ]}
          />
        );
      },
    });
  }
}

其中 attachmentFileTypes 是 @tachybase/client 包中提供的用于扩展文件类型的入口对象，使用其提供的 add 方法来扩展一个文件类型描述对象。

每个文件类型必须实现一个 match() 方法，用于检查文件类型是否满足要求，例子中通过 mime-match 包提供的方法对文件的 mimetype 属性进行检测，如果匹配 image/* 的类型，则认为是需要处理的文件类型。如果未匹配成功，则会降级为内置的类型处理。

在类型描述对象上的 Previewer 属性即为用于预览的组件，当文件类型匹配时，将渲染该组件进行预览。通常建议使用弹窗类型的组件作为基础容器（如 <Modal /> 等），再将预览和需要交互的内容放入该组件，实现预览功能。

API

export interface FileModel {
  id: number;
  filename: string;
  path: string;
  title: string;
  url: string;
  extname: string;
  size: number;
  mimetype: string;
}

export interface PreviewerProps {
  index: number;
  list: FileModel[];
  onSwitchIndex(index): void;
}

export interface AttachmentFileType {
  match(file: any): boolean;
  Previewer?: React.ComponentType<PreviewerProps>;
}

export class AttachmentFileTypes {
  add(type: AttachmentFileType): void;
}

attachmentFileTypes

attachmentFileTypes 是一个全局实例，通过 @tachybase/client 导入：

import { attachmentFileTypes } from '@tachybase/client';

attachmentFileTypes.add()

向文件类型注册中心注册新的文件类型描述对象。描述对象的类型为 AttachmentFileType。

AttachmentFileType

match()

文件格式匹配方法。

传入参数 file 为已上传文件夹的数据对象，包含相关的属性可以用于类型判断：

  • mimetype：mimetype 描述
  • extname：文件后缀名，包含“.”
  • path：文件储存的相对路径
  • url：文件 URL

返回值为 boolean 类型，表示是否匹配的结果。

Previewer

用于预览文件的 React 组件。

传入 Props 参数为：

  • index：文件在附件列表中的索引
  • list：附件列表
  • onSwitchIndex：用于切换索引的方法

其中 onSwitchIndex 可以传入一个 list 中的任意索引值，用于切换到其他文件。如果使用 null 作为参数切换，则直接关闭预览组件。

onSwitchIndex(null);