RFAboutView is an easy, drop-in solution to display copyright, support, privacy and other information while also automatically crediting the developers of third-party CocoaPods. RFAboutView uses AutoLayout and can be used both for iPhone and iPad apps.
Its main features are:
- Displays app name and copyright information.
- Displays an optional link to a website, opening in Safari View Controller
- Displays an optional link to an Email address.
- If the user clicks on the Email link, a
MFMailComposeViewControlleropens, (optionally) pre-filled with diagnostic information useful for support: App name and version, current device, current iOS version, preferred device language.
- Displays acknowledgements for all CocoaPods used in the project. The acknowledgements file automatically created by CocoaPods is used for this, requiring almost no work on your part. See "Automatic acknowledgements" below for more information.
- Clean and modern design with lots of customisation options.
To use RFAboutView, first import it:
Then, initialise a RFAboutViewController and add it to a UINavigationController. The RFAboutViewController must always be used in navigation stack. Here is a complete example:
Installation via Cocoapods
RFAboutView is available through CocoaPods. To install it, simply add the following lines to your Podfile:
pod "RFAboutView-Swift", '~> 2.0.1' use_frameworks!
Installation via Carthage
To install RFAboutView via Carthage, simply add the following line to your
Automatic acknowledgements via Cocoapods
Every time you run
pod update or
pod install, CocoaPods automatically generates a file containing copyright and license information for all CocoaPods used in the project. RFAboutView uses this file to display the acknowledgements. To use it, copy the file
Pods-<Target Name>-acknowledgements.plist found in the
<Project Root>/Pods/Target Support Files/Pods-<Target Name> directory to your project and call it
Acknowledgements.plist. You can also use a different name if you would like – if you do, set the
acknowledgementsFilename property of
RFAboutViewController to the new name (without plist).
To automate this, you can add the following snippet to your
post_install do |installer| require 'fileutils' FileUtils.cp_r('Pods/Target Support Files/Pods-<Target Name>/Pods-<Target Name>-acknowledgements.plist', '<Project Dir>/Acknowledgements.plist', :remove_destination => true) end
Note that the directory names can differ based on the setup of your project and whether or not you are using different targets. Check with your local project directory and change the snippet accordingly. Also don't forget to add the
Acknowledgements.plist file to your Xcode project.
Localisation and changing the default text
If you want to localise RFAboutView for your app or if you would like to change the default texts, you can use the RFAboutView.strings file in the example app as a template.
RFAboutView contains many customisation options. See the file
RFAboutView.swift for a full documentation.
To run the example project, clone the repo, and run
pod install from the Example directory first.
RFAboutView requires iOS 9.0 and Xcode 8.0 (for Swift 3).
René Fouquet, firstname.lastname@example.org Follow me on Twitter at @renefouquet
RFAboutView is available under the MIT license. See the LICENSE file for more info.