Acknowledgements screen displaying a list of licenses, for example fromCocoaPodsandSwift Package Managerdependencies.
Also available in Objective-C withVTAcknowledgementsViewController.
- Load acknowledgments from CocoaPods-generated files (
Pods-###-acknowledgements.plist
) - Load acknowledgments from Swift Package Manager files (
Package.resolved
) - Fetch missing SPM licenses from GitHub API
- 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
- Add
pod 'AcknowList'
to yourPodfile
. - Run
pod install
. - Add the
Pods-#target#-acknowledgements.plist
file generated by CocoaPods to your main target: drag and drop the file from thePods/Target Support Files/Pods-#target#/
folder to your Xcode project (don’t copy the file, leaveCopy items if needed
unchecked).
AcknowList can be installed with theSwift Package Manager(requires Xcode 12 for localized resources).
- Click on
File
→Add Packages…
. - Enter
https://github /vtourraine/AcknowList
. - Select the version you’d like to use.
- Add the
Package.resolved
file generated by Xcode to your main target. Drag and drop the file from the folder to your Xcode project (don’t copy the file, leaveCopy items if needed
unchecked).- For single Xcode projects, the file is in
[appName].xcodeproj/project.xcworkspace/xcshareddata/swiftpm/
- For Xcode workspaces (for instance with CocoaPods), the file is in
[appName].xcworkspace/xcshareddata/swiftpm/
- For single Xcode projects, the file is in
TheAcknowListViewController
instance is usually pushed to an existingUINavigationController
.
letviewController=AcknowListViewController()
navigationController.pushViewController(viewController,animated:true)
By default, the controller will try to load acknowledgements from a CocoaPods plist file (by guessing its location based on the bundle name), as well as from aPackage.resolved
file.
You can also initialize the view controller with a custom file name or URL.
letviewController=AcknowListViewController(fileNamed:"Pods-AcknowExample-acknowledgements")
leturl=Bundle.main.url(forResource:"Pods-AcknowExample-acknowledgements",withExtension:"plist")
letviewController=AcknowListViewController(plistFileURL:url)
If you want to include licenses that are not part of a.plist
or.resolved
file, you can create newAcknow
instances, and use them for the acknowledgements array of the controller.
letacknow=Acknow(title:"...",text:"...")
letviewController=AcknowListViewController(acknowledgements:[acknow])
The controller can also display a header and a footer. By default, they are loaded from the generatedplist
file, but you can also directly change the properties values.
viewController.headerText="We love open source software."
viewController.footerText="Powered by CocoaPods and SPM"
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:
letviewController=AcknowListViewController(plistFileURL:url,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.
Instantiate aAcknowListSwiftUIView
with a path to theplist
file, or with an array ofAcknow
instances, and present this view from aNavigationView
.
Platform | UIKit | SwiftUI |
---|---|---|
📱 | iOS 9.0+ | iOS 13.0+ |
📺 | tvOS 9.0+ | tvOS 13.0+ |
🥽 | visionOS 1.0+ | visionOS 1.0+ |
⌚️ | not supported | watchOS 7.0+ |
💻 | not supported | macOS 10.15+ |
AcknowList is written in Swift 5, and requires Xcode 12 and above.
AcknowList was created byVincent Tourraine,and improved by a growinglist of contributors.
AcknowList is available under the MIT license. See theLICENSE.txt
file for more info.