# AutomatticAbout-Swift

**Repository Path**: mirrors_Automattic/AutomatticAbout-Swift

## Basic Information

- **Project Name**: AutomatticAbout-Swift
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-12-01
- **Last Updated**: 2026-09-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# AutomatticAbout

This package provides classes that can be used to show an About screen in a host app, such as this example from Jetpack for iOS:

<img src="Images/about-screen.png" width=300 alt="A screenshot of the Jetpack for iOS About screen">

Host apps must provide an `AboutScreenConfiguration`, which specifies the structure and behavior of the about screen. For a real world example, check out the [configuration for Jetpack for iOS](https://github.com/wordpress-mobile/WordPress-iOS/blob/trunk/WordPress/Classes/ViewRelated/Me/App%20Settings/About/AppAboutScreenConfiguration.swift). Apps should also provide an `AboutScreenAppInfo` instance containing the app's icon, title, and version to be displayed in the header of the about screen.

The [`AboutScreenConfiguration` protocol](https://github.com/Automattic/AutomatticAbout-Swift/blob/main/Sources/AutomatticAbout/AboutScreenConfiguration.swift) contains an array of `sections` describing each section within the screen. Each of those is itself an array of `AboutItem`s, which can have titles, subtitles, cell styles, an action, and more.

One of the available cell styles is `.appLogos`, a special cell which contains animated app logos which respond to device physics and produce haptic feedback as they bounce around.

Here's an example configuration: 

```swift
struct AppAboutScreenConfiguration: AboutScreenConfiguration {
    var sections: [AboutScreenSection] {
        [
            // Section one, containing a single 'Blog' item
            [
                AboutItem(title: "Blog", subtitle: "jetpack.com/blog", cellStyle: .subtitle, action: { context in
                    // Perform an action, such as...
                    let vc = SFSafariViewController(url: URL(string: "https://jetpack.com/blog")!)
                    context.viewController.present(vc, animated: true, completion: nil)
                })
            ],
            // Section two, containing two items: an 'Our Apps' row, and a special cell containing animated app icons
            [
                AboutItem(title: "Our Apps", accessoryType: .disclosureIndicator, hidesSeparator: true, action: { context in
                    let vc = SFSafariViewController(url: URL(string: "https://example.com")!)
                    context.viewController.present(vc, animated: true, completion: nil)
                }),
                AboutItem(title: "", cellStyle: .appLogos)
            ]
        ]
    }

    func dismissScreen(_ actionContext: AboutItemActionContext) {
        actionContext.viewController.presentingViewController?.dismiss(animated: true)
        // Optionally perform an action, for example...
        WPAnalytics.track(.aboutScreenDismiss)
    }

    func willShow(viewController: UIViewController) {

    }

    func didHide(viewController: UIViewController) {

    }
    
    static var appInfo: AboutScreenAppInfo {
        AboutScreenAppInfo(name: (Bundle.main.object(forInfoDictionaryKey: "CFBundleDisplayName") as? String) ?? "",
                           version: Bundle.main.shortVersionString,
                           icon: fetch the app's icon here)
    }
}
```

And here's an example of displaying an about screen using the above configuration:

```
    let configuration = AppAboutScreenConfiguration()
    let controller = AutomatticAboutScreen.controller(appInfo: AppAboutScreenConfiguration.appInfo,
                                                      configuration: configuration)
    present(controller, animated: true) {
        self.tableView.deselectSelectedRow(animated: true)
    }
```

Example project app icon uses an image from [Twitter's open source emoji library](https://twemoji.twitter.com).