AcknowList

Acknowledgements screen displaying a list of licenses, for example from CocoaPods dependencies.

Also available in Objective-C with VTAcknowledgementsViewController.

Features

Automatically load acknowledgments from CocoaPods-generated file
Remove unnecessary line breaks from licenses for better text wrapping
Optional list header and footer
Tappable links in header, footer, and acknowledgment text
Storyboard support
Dark Mode support
Dynamic Type support
Localized in 13 languages
UIKit and SwiftUI interfaces

Installation

CocoaPods

Add pod 'AcknowList' to your Podfile.
Run pod install.
Add the Pods-#target#-acknowledgements.plist file generated by CocoaPods to your main target: drag and drop the file from the Pods/Target Support Files/Pods-#target#/ folder in your Xcode project (don’t copy the file, leave Copy items if needed unchecked).

Swift Package Manager

AcknowList can be installed with the Swift Package Manager (requires Xcode 12 for localized resources).

Click on File → Swift Packages → Add Package Dependency….
Enter https://github.com/vtourraine/AcknowList.
Select the version you’d like to use.

Initialization

The AcknowListViewController instance is usually pushed to an existing UINavigationController.

let viewController = AcknowListViewController()
navigationController.pushViewController(viewController, animated: true)

By default, the controller will try to guess the name of your .plist file, based on the bundle name (Pods-#bundle-name#-acknowledgements.plist). If that doesn’t match the file you’re looking for, you can initialize the view controller with a custom file name or path.

let viewController = AcknowListViewController(fileNamed: "Pods-AcknowExample-acknowledgements")

let path = Bundle.main.path(forResource: "Pods-AcknowExample-acknowledgements", ofType: "plist")
let viewController = AcknowListViewController(plistPath: path)

If you want to include licenses that are not part of a .plist file, you can create new Acknow instances, and use them for the acknowledgements array of the controller.

let acknow = Acknow(title: "...", text: "...")
let viewController = AcknowListViewController(acknowledgements: [acknow])

Customization

The controller can also display a header and a footer. By default, they are loaded from the generated plist file, but you can also directly change the properties values.

viewController.headerText = "We love open source software."
viewController.footerText = "Powered by CocoaPods.org"

The controller title is a localized value for “acknowledgements”. You might want to use this localized value for the button presenting the controller.

button.setTitle(AcknowLocalization.localizedTitle(), for: .normal)

By default, AcknowListViewController uses the “grouped” table view style. You can choose a different style:

let viewController = AcknowListViewController(plistPath: path, style: .plain)

If you need to further customize the appearance or behavior of this library, feel free to subclass its classes.

SwiftUI

AcknowList now offers a SwiftUI interface, which supports all the major platforms.

Instantiate a AcknowListSwiftUIView with a path to the plist file, or with an array of Acknow instances, and present this view from a NavigationView.

Platforms

Platform	UIKit	SwiftUI
📱	iOS 9.0+	iOS 13.0+
📺	tvOS 9.0+	tvOS 13.0+
⌚️	not supported	watchOS 7.0+
💻	not supported	macOS 10.15+

⚠️ If you install AcknowList with CocoaPods or Swift Package Manager, it will require iOS 13 and tvOS 13. To support earlier versions, please import this library manually, and ignore the SwiftUI classes. Alternatively, use VTAcknowledgementsViewController instead.

Requirements

AcknowList is written in Swift 5, and requires Xcode 12 and above.

Credits

AcknowList was created by Vincent Tourraine, and improved by a growing list of contributors.

License

AcknowList is available under the MIT license. See the LICENSE.txt file for more info.

orchan/AcknowList