How can I customize the look and feel of FileBrowser in my iOS app?

FileBrowser offers customization through properties like excludesFileExtensions and excludesFilepaths, and you can modify its presentation, but deep UI changes might require subclassing or additional code beyond the basic options provided.

FileBrowser vs QLPreviewController: which one should I use for file previews?

FileBrowser provides a full file browser with search and management features, while QLPreviewController is Apple's built-in solution for previewing files. Use FileBrowser for comprehensive file navigation; QLPreviewController for simple previews without browsing.

How do I handle when a user selects a file in FileBrowser?

Use the didSelectFile closure to define custom behavior when a file is selected, such as logging the file name or performing actions based on the file type, as demonstrated in the advanced usage section of the README.

Does FileBrowser work with SwiftUI or is it only for UIKit?

FileBrowser is built with UIKit, so to use it in SwiftUI projects, you'll need to wrap it in a UIViewControllerRepresentable, as it doesn't have native SwiftUI support out of the box.

Can FileBrowser browse files outside the app's documents directory?

Yes, you can initialize FileBrowser with a custom NSURL path to browse different directories, but it's limited to local file systems accessible to the app, not network or cloud locations.

How to exclude ZIP files from showing in FileBrowser?

Set the excludesFileExtensions property to an array containing 'zip', as shown in the README example, to hide files with that extension from the browser, ensuring only relevant files are displayed.

Open-Awesome

FileBrowser

MITSwift1.0.0

Finder-style iOS file browser library in Swift with search, previews, and 3D touch.

GitHub

1.5k stars222 forks0 contributors

What is FileBrowser?

FileBrowser is an iOS library written in Swift that provides a Finder-style file browser interface for apps. It allows users to browse, search, preview, and manage files within an application's documents directory or custom paths, solving the need for integrated file system navigation without building from scratch.

Target Audience

iOS developers building apps that require in-app file management, such as document editors, media viewers, or utility tools where users interact with local files.

Value Proposition

Developers choose FileBrowser for its native iOS look and feel, quick integration with minimal code, and comprehensive features like search, previews, and 3D touch—saving development time while offering a polished user experience.

Overview

Finder-style iOS file browser written in Swift

Use Cases

Best For

Adding a file picker to an iOS document editor app
Building a media management tool with file previews
Integrating a native file browser in utility or productivity apps
Implementing 3D touch file interactions in iOS apps
Creating customizable file explorers for app-specific directories
Developing apps that require in-app file search and organization

Not Ideal For

Apps that need cross-platform file browsing across iOS and Android
Projects primarily dealing with cloud-based file storage and synchronization
Applications requiring advanced file system operations like background processing or system integration

Pros & Cons

Pros

Native iOS UI

Offers a Finder-style interface that aligns with iOS design standards, ensuring a familiar user experience for browsing files.

Quick Setup

Integration requires only a few lines of code to present the browser, as shown in the basic usage example, saving development time.

Comprehensive Features

Includes search via pull-down, file previews for plist and JSON, editing, deletion, and 3D touch support, covering essential file management tasks.

Customization Options

Allows excluding specific file extensions and paths, and can be tailored to app design, providing flexibility for different use cases.

Cons

Local File Limitation

Focused on browsing local app directories, with no built-in support for network or remote file systems, restricting use in cloud-centric apps.

Swift Version Dependency

Built for Swift 4.0, which may pose compatibility challenges for projects using newer Swift versions or require migration efforts.

iOS-Exclusive

Only available for iOS, making it unsuitable for cross-platform applications and necessitating alternative solutions for other platforms.

Frequently Asked Questions

Related Projects

ZipArchive

ZipArchive is a simple utility class for zipping and unzipping files on iOS, macOS and tvOS.

Stars5,593

Forks1,355

Last commit7 months ago

ZIPFoundation

Effortless ZIP Handling in Swift

Stars2,690

Forks354

Last commit22 days ago

Zip

Swift framework for zipping and unzipping files.

Stars2,602

Forks477

Last commit1 year ago

FileKit

Simple and expressive file management in Swift

Stars2,364

Forks212

Last commit2 years ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub