Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/marmelroy/FileBrowser
Finder-style iOS file browser written in Swift
https://github.com/marmelroy/FileBrowser
Last synced: about 1 month ago
JSON representation
Finder-style iOS file browser written in Swift
- Host: GitHub
- URL: https://github.com/marmelroy/FileBrowser
- Owner: marmelroy
- License: mit
- Created: 2016-02-07T13:40:57.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2021-11-25T12:48:26.000Z (about 3 years ago)
- Last Synced: 2024-10-29T17:56:17.245Z (2 months ago)
- Language: Swift
- Homepage:
- Size: 2.74 MB
- Stars: 1,521
- Watchers: 35
- Forks: 219
- Open Issues: 31
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ios - FileBrowser - Powerful Swift file browser for iOS. (Files / Getting Started)
- awesome-swift - FileBrowser - Powerful file browser for iOS. (Libs / Files)
- awesome-ios-star - FileBrowser - Powerful Swift file browser for iOS. (Files / Getting Started)
- awesome-swift-cn - FileBrowser - Powerful Swift file browser for iOS. (Libs / Data Management)
- awesome - FileBrowser - Finder-style iOS file browser written in Swift (etc)
- awesome - FileBrowser - Finder-style iOS file browser written in Swift (etc)
README
[](https://travis-ci.org/marmelroy/FileBrowser) [](http://cocoapods.org/?q=FileBrowser)
[](https://github.com/Carthage/Carthage)
# FileBrowser
iOS Finder-style file browser in Swift 4.0 with search, file previews and 3D touch. Simple and quick to use.
## Features
:sparkles: | Features
--------------------------|----------------------------
:iphone: | Browse and select files and folders with a familiar UI on iOS.
:mag: | Pull down to search.
:eyeglasses: | Preview most file types. Including plist and json.
:pencil: | Edit/delete files.
:point_up_2: | 3D touch support for faster previews with Peek & Pop.
:white_flower: | Fully customizable.
## Usage
Import FileBrowser at the top of the Swift file.
```swift
import FileBrowser
```
To show the file browser, all you need to do is:
```swift
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.
```swift
let fileBrowser = FileBrowser(initialPath: customPath)
```
You can also allow editing/deleting files.
```swift
let fileBrowser = FileBrowser(initialPath: customPath, allowEditing: true)
```
Use the didSelectFile closure to change FileBrowser's behaviour when a file is selected.
```swift
fileBrowser.didSelectFile = { (file: FBFile) -> Void in
print(file.displayName)
}
```
To exclude a certain file type or a specific file path:
```swift
fileBrowser.excludesFileExtensions = ["zip"]
fileBrowser.excludesFilepaths = [secretFile]
```
### Setting up with [CocoaPods](http://cocoapods.org/?q=FileBrowser)
```ruby
source 'https://github.com/CocoaPods/Specs.git'
pod 'FileBrowser', '~> 1.0'
```
### Setting up with Carthage
[Carthage](https://github.com/Carthage/Carthage) is a decentralized dependency manager that automates the process of adding frameworks to your Cocoa application.
You can install Carthage with [Homebrew](http://brew.sh/) using the following command:
```bash
$ brew update
$ brew install carthage
```
To integrate FileBrowser into your Xcode project using Carthage, specify it in your `Cartfile`:
```ogdl
github "marmelroy/FileBrowser"
```