Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/vtourraine/acknowlist

Acknowledgements screen displaying a list of licenses, for example from CocoaPods and Swift Package Manager dependencies.
https://github.com/vtourraine/acknowlist

cocoapods ios macos spm swift swiftui tvos uikit watchos

Last synced: about 3 hours ago
JSON representation

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

Host: GitHub
URL: https://github.com/vtourraine/acknowlist
Owner: vtourraine
License: mit
Created: 2015-08-27T16:23:11.000Z (about 9 years ago)
Default Branch: main
Last Pushed: 2024-02-08T15:35:09.000Z (8 months ago)
Last Synced: 2024-04-24T08:23:09.634Z (5 months ago)
Topics: cocoapods, ios, macos, spm, swift, swiftui, tvos, uikit, watchos
Language: Swift
Homepage:
Size: 1.38 MB
Stars: 735
Watchers: 8
Forks: 56
Open Issues: 7
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt

Awesome Lists containing this project

README

        # AcknowList

Acknowledgements screen displaying a list of licenses, for example from [CocoaPods](https://cocoapods.org) and [Swift Package Manager](https://swift.org/package-manager/) dependencies.

![Platform iOS tvOS watchOS macOS visionOS](https://img.shields.io/cocoapods/p/AcknowList.svg)

[![Build & Test](https://github.com/vtourraine/AcknowList/actions/workflows/ios.yml/badge.svg)](https://github.com/vtourraine/AcknowList/actions/workflows/ios.yml)

![Swift 5](https://img.shields.io/badge/Swift-5-blue.svg)

![Swift Package Manager](https://img.shields.io/badge/support-Swift_Package_Manager-orange.svg)

[![CocoaPods compatible](https://img.shields.io/cocoapods/v/AcknowList.svg)](https://cocoapods.org/pods/AcknowList)

[![MIT license](http://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/vtourraine/AcknowList/raw/master/LICENSE)

_Also available in Objective-C with [VTAcknowledgementsViewController](https://github.com/vtourraine/VTAcknowledgementsViewController)._

![AcknowList screenshots](Sources/AcknowList/AcknowList.docc/Resources/[email protected])

## Features

- 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

## 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](https://swift.org/package-manager/) (requires Xcode 12 for localized resources).

1. Click on `File` → `Add 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`.

``` swift

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.

``` swift

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

```

``` swift

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.

``` swift

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.

``` swift

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.

``` swift

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

```

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

``` swift

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+ |

| 🥽 | visionOS 1.0+ | visionOS 1.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](https://github.com/vtourraine/VTAcknowledgementsViewController) instead.

## Requirements

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

## Credits

AcknowList was created by [Vincent Tourraine](https://www.vtourraine.net), and improved by a growing [list of contributors](https://github.com/vtourraine/AcknowList/contributors).

## License

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