Finder-style iOS file browser written in Swift
Switch branches/tags
Nothing to show
Clone or download
Latest commit b03284f Sep 20, 2017
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
FileBrowser.xcodeproj Release 1.0.0 Sep 20, 2017
FileBrowser Release 1.0.0 Sep 20, 2017
FileBrowserTests Release 1.0.0 Sep 20, 2017
examples Sweift 4 update settings Sep 20, 2017
.gitignore Consolidate initialisers Jul 23, 2017
.swift-version Release 1.0.0 Sep 20, 2017
.travis.yml Release 1.0.0 Sep 20, 2017
CHANGELOG.md Adding changelog Feb 16, 2016
FileBrowser.podspec Release 1.0.0 Sep 20, 2017
LICENSE Initial commit Feb 7, 2016
README.md Release 1.0.0 Sep 20, 2017
build.sh Fix build script Sep 20, 2017

README.md

FileBrowser - iOS Finder-style file browser in Swift

Build Status Version Carthage compatible

FileBrowser

iOS Finder-style file browser in Swift 4.0 with search, file previews and 3D touch. Simple and quick to use.

Features

Features
📱 Browse and select files and folders with a familiar UI on iOS.
🔍 Pull down to search.
👓 Preview most file types. Including plist and json.
📝 Edit/delete files.
👆 3D touch support for faster previews with Peek & Pop.
💮 Fully customizable.

Usage

Import FileBrowser at the top of the Swift file.

import FileBrowser

To show the file browser, all you need to do is:

let fileBrowser = FileBrowser()
present(fileBrowser, animated: true, completion: nil)

By default, the file browser will open in your app's documents directory. When users select a file, a preview will be displayed - offering an action sheet of options based on the file type.

Advanced Usage

You can open FileBrowser in a different root folder by initialising with an NSURL file path of your choice.

let fileBrowser = FileBrowser(initialPath: customPath)

You can also allow editing/deleting files.

let fileBrowser = FileBrowser(initialPath: customPath, allowEditing: true)

Use the didSelectFile closure to change FileBrowser's behaviour when a file is selected.

fileBrowser.didSelectFile = { (file: FBFile) -> Void in
    print(file.displayName)
}

To exclude a certain file type or a specific file path:

fileBrowser.excludesFileExtensions = ["zip"]
fileBrowser.excludesFilepaths = [secretFile]

Setting up with CocoaPods

source 'https://github.com/CocoaPods/Specs.git'
pod 'FileBrowser', '~> 1.0'

Setting up with Carthage

Carthage is a decentralized dependency manager that automates the process of adding frameworks to your Cocoa application.

You can install Carthage with Homebrew using the following command:

$ brew update
$ brew install carthage

To integrate FileBrowser into your Xcode project using Carthage, specify it in your Cartfile:

github "marmelroy/FileBrowser"