FileExplorer 使用教程

FileExplorer 使用教程

FileExplorer FileExplorer is a powerful iOS file browser that allows its users to choose and remove files and/or directories 项目地址: https://gitcode.com/gh_mirrors/file/FileExplorer

1. 项目介绍

FileExplorer 是一个强大的 iOS 文件浏览器，它允许用户选择和删除文件及目录。该项目由 Rafał Augustyniak 创建并维护，采用 Swift 语言编写。FileExplorer 提供了内置的搜索功能，支持图片、音频、视频和 PDF 文件的预览，并且可以通过扩展 API 添加对其他文件类型的支持。

2. 项目快速启动

安装

推荐使用 CocoaPods 来添加 FileExplorer 到你的项目。

首先，在你的 Podfile 中添加以下内容：

pod 'FileExplorer', '~> 1.0.4'

然后执行以下命令来安装 Pod：

pod install

安装完成后，在你的项目文件中导入 FileExplorer：

import FileExplorer

基本使用

最简单的展示 FileExplorer 的方式如下：

let fileExplorer = FileExplorerViewController()
self.present(fileExplorer, animated: true, completion: nil)

3. 应用案例和最佳实践

定制化

FileExplorer 允许进行大量定制。以下是一些定制化的示例：

决定哪些文件和/或目录应该可见

通过设置 fileFilters 和 ignoredFileFilters 属性，你可以选择显示哪些文件或目录。

只显示特定扩展名的文件：

let fileExplorer = FileExplorerViewController()
// 只显示 `txt` 和 `jpg` 扩展名的文件
fileExplorer.fileFilters = [Filter.extension("txt"), Filter.extension("jpg")]
self.present(fileExplorer, animated: true, completion: nil)

使用 FileExplorer 作为文件和/或目录选择器

配置 FileExplorer 以允许用户选择文件和/或目录：

let fileExplorer = FileExplorerViewController()
fileExplorer.canChooseFiles = true // 允许用户选择文件
fileExplorer.canChooseDirectories = false // 不允许用户选择目录
fileExplorer.allowsMultipleSelection = true // 允许用户选择多个文件和/或目录
fileExplorer.delegate = self
self.present(fileExplorer, animated: true, completion: nil)

当用户选择了文件后，通过代理回调得到通知：

public func fileExplorerViewController(_ controller: FileExplorerViewController, didChooseURLs urls: [URL]) {
    // 在这里编写你的代码
}

决定用户是否可以删除文件和/或目录

配置 FileExplorer 以允许用户删除文件和/或目录：

let fileExplorer = FileExplorerViewController()
fileExplorer.canRemoveFiles = true // 允许用户删除文件
fileExplorer.canRemoveDirectories = false // 不允许用户删除目录
self.present(fileExplorer, animated: true, completion: nil)

添加对其他文件类型的支持

FileExplorer 是可扩展的。要添加对其他文件类型的支持，你需要实现 FileSpecificationProvider 协议。

class CustomFileSpecificationProvider: FileSpecificationProvider {
    public class var extensions: [String] {
        return ["foo"]
    }
    
    public class func thumbnail(forItemAt url: URL, with size: CGSize) -> UIImage? {
        return nil // 如果返回 nil，FileExplorer 会使用默认的缩略图
    }
    
    public class func viewControllerForItem(at url: URL, data: Data?, attributes: FileAttributes) -> UIViewController {
        let viewController = CustomViewController()
        // 在这里配置你的自定义视图控制器
        return viewController
    }
}

注册你的自定义提供者：

let fileExplorer = FileExplorerViewController()
fileExplorer.fileSpecificationProviders = [CustomFileSpecificationProvider.self]
self.present(fileExplorer, animated: true, completion: nil)

现在，FileExplorerViewController 会使用 CustomFileSpecificationProvider 来为 .foo 扩展名的文件提供缩略图和视图控制器。

4. 典型生态项目

（此处可以根据实际生态项目情况填写，例如其他与 FileExplorer 相关的开源项目、插件或工具等。）

FileExplorer FileExplorer is a powerful iOS file browser that allows its users to choose and remove files and/or directories 项目地址: https://gitcode.com/gh_mirrors/file/FileExplorer