Vandelay is a Swift-based iOS importer/exporter. It supports Codable, strings and data and comes with built-in support for exporting and importing strings and data to and from a bunch of data sources.
The easiest way to add Vandelay to your project is to use Swift Package Manager:
.package(url: "git@github.com:danielsaidi/Vandelay.git" ...)
pod "Vandelay"github "danielsaidi/Vandelay"To add Vandelay to your app without a dependency manager, clone this repository, add Vandelay.xcodeproj to your project and Vandelay.framework as an embedded app binary and target dependency.
Vandelay uses exporters to let you export strings, data and Encodable.
Vandelay comes with the following built-in exporters:
EmailExporter- exportsstrings&dataas email attachmentsFileExporter- exportsstrings&datato local filesMessageExporter- exportsstrings&dataas message attachmentsPasteboardExporter- exportsstringsto the pasteboard
You can extend Vandelay with custom exporters as well.
Use string exporters if you want platform-agnostic, readable exports. Use a data exporters when you only have Data or when a type can't be serialized.
Vandelay uses importers to let you import strings, data and Decodable types.
Vandelay comes with the following built-in importers:
FileExporter- importsstrings&datafrom local filesPasteboardExporter- importsstringsfrom the pasteboardUrlExporter- importsstrings&datafrom custom urls
You can extend Vandelay with custom importers as well.
When importing, the same goes as when exporting: data is more powerful, but strings are more universal.
You can use the existing importers to import data by sharing external files to Vandelay, e.g. by tapping an e-mail attachment or sharing a file to the app.
To import files, your app must be correctly configured to handle the file type. You have to register Document types and Exported Type UTIs and implement the correct functions in AppDelegate (iOS 12 and earlier) or SceneDelegate (iOS 13+). Once the functions are triggered, you can use a UrlImporter to import the tapped file.
Check out the demo app for an example on how this can be done.
You can add QR code scanning support with VandelayQR. It lets you import data by scanning QR codes.
You can add Dropbox support with VandelayDropbox. It lets you export and import data to/from Dropbox.
This repo contains a demo app that lets you export/import todo items (strings) and photos (data). To run the demo app, open and run the Vandelay.xcodeproj project.
The demo app registers a custom file type .vdl which it uses to export and import data. Have a loot at its Info.plist, AppDelegate and SceneDelegate to see how it handles imports.
I hope you like this library. Feel free to reach out if you have questions or if you want to contribute in any way:
- E-mail: daniel.saidi@gmail.com
- Twitter: @danielsaidi
- Web site: danielsaidi.com
Vandelay is available under the MIT license. See the LICENSE file for more info.