AcknowList

3.0.0

Acknowledgements screen displaying a list of licenses, for example from CocoaPods and Swift Package Manager dependencies.
vtourraine/AcknowList

What's New

2022-09-17T20:50:02Z
  • Add AcknowList struct to represent list model
  • Add AcknowPackageDecoder to parse “Package.resolved” files (Swift Package Manager)
  • Refactor plist file parser into AcknowPodDecoder
  • Refactor AcknowParser to manage parsing different file types
  • Refactor file paths parameters (String) into file URLs (URL) instead
  • Update AcknowListViewController to load acknowledgements from “Package.resolved” by default

AcknowList

Acknowledgements screen displaying a list of licenses, for example from CocoaPods and Swift Package Manager dependencies.

Platform iOS tvOS watchOS macOS Build & Test Swift 5 Swift Package Manager CocoaPods compatible MIT license

Also available in Objective-C with VTAcknowledgementsViewController.

AcknowList screenshots

Features

  • Load acknowledgments from CocoaPods-generated files (Pods-###-acknowledgements.plist)
  • Load acknowledgments from Swift Package Manager files (Package.resolved)
  • 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

  1. Add pod 'AcknowList' to your Podfile.
  2. Run pod install.
  3. 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 to 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).

  1. Click on FileAdd Packages….
  2. Enter https://github.com/vtourraine/AcknowList.
  3. Select the version you’d like to use.
  4. 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, leave Copy 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/

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 load acknowledgements from a CocoaPods plist file (by guessing its location based on the bundle name), as well as from a Package.resolved file.

You can also initialize the view controller with a custom file name or URL.

let viewController = AcknowListViewController(fileNamed: "Pods-AcknowExample-acknowledgements")
let url = Bundle.main.url(forResource: "Pods-AcknowExample-acknowledgements", withExtension: "plist")
let viewController = AcknowListViewController(plistFileURL: url)

If you want to include licenses that are not part of a .plist or .resolved 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 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:

let viewController = AcknowListViewController(plistFileURL: url, 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.

Description

  • Swift Tools 5.3.0
View More Packages from this Author

Dependencies

  • None
Last updated: Mon Oct 03 2022 02:35:58 GMT-0500 (GMT-05:00)