Acknowledgements screen displaying a list of licenses, for example from CocoaPods dependencies.
Also available in Objective-C with VTAcknowledgementsViewController.
pod 'AcknowList'to your
Pods-#target#-acknowledgements.plistfile 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 neededunchecked).
AcknowList can be installed with the Swift Package Manager (requires Xcode 12 for localized resources).
Add Package Dependency….
AcknowListViewController instance is usually pushed to an existing
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])
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)
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.
AcknowList now offers a SwiftUI interface, which supports all the major platforms.
AcknowListSwiftUIView with a path to the
plist file, or with an array of
Acknow instances, and present this view from a
|📱||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.
AcknowList is written in Swift 5, and requires Xcode 12 and above.
AcknowList is available under the MIT license. See the
LICENSE.txt file for more info.
|Last commit: 1 week ago|