Swiftpack.co - Jonathan-Gander/WhatsNewView as Swift Package

Swiftpack.co is a collection of thousands of indexed Swift packages. Search packages.
See all packages published by Jonathan-Gander.
Jonathan-Gander/WhatsNewView 1.0.1
A Swift Package to present your new features nicely in your SwiftUI app.
⭐️ 1
🕓 50 weeks ago
iOS
.package(url: "https://github.com/Jonathan-Gander/WhatsNewView.git", from: "1.0.1")

A nice way to present your new app features (in SwiftUI)

WhatsNewView is a Swift Package for SwiftUI that lets you present to your users your app new features in a pretty way (see screenshots below). For example, when you have released an update and you want to explain what is new.

It is really easy to use and to add to your app. It only takes an array of WhatsNewFeature (features to present) as mandatory parameter. All other parameters are here to customize visual aspect and interactions.

If you're using UIKit in your project, have a look on Jonathan-Gander/WhatsNewViewController.

Features

  • Title and subtitle
  • List of all features with image, title, text
  • A Continue button (hiddable)
  • A More info button (hiddable)
  • Change main color (with light/dark mode)
  • Vertical and horizontal orientation
  • Methods to handle user interactions

Usage

Installation

Add WhatsNewView package to your project.

In Xcode 13.1: File -> Add Packages... then enter my project GitHub URL:
https://github.com/Jonathan-Gander/WhatsNewView

Quick start

In file you want to display WhatsNewView:

import WhatsNewView

Then create a WhatsNewView by passing your WhatsNewFeature array. You can also customize your view UI and interaction with other optional parameters.

Details about each parameter:

  • features: Array of WhatsNewFeature to display
  • mainColor: Tint color for features images, Continue button and More info button
  • titleText: View title
  • subtitleText: View subtitle. Set to nil to hide subtitle.
  • continueText: Text for Continue button. Set to nil to hide Continue button.
  • MoreInfoText: Text for More info button. Set to nil to hide More info button.
  • continueButtonAction: Function called when Continue button is tapped.
  • moreInfoButtonAction: Function called when More info button is tapped.
  • featureTapAction: Function called when a feature is tapped. It takes two parameters: tapped feature, and feature index (in features array). Set to nil so features are not buttons (just views).

Complete example

Here is as example of a view displaying a WhatsNewView as a sheet.

struct ContentView: View {
    @State private var showView = false
    @State private var outputText = ""

    private let features = [
        WhatsNewFeature(title: "First amazing feature", text: "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aliquam accumsan pretium arcu, sit amet porta lectus ultrices sed.", image: Image(systemName: "paintbrush")),
        WhatsNewFeature(title: "Second feature", text: "Sed lacinia tortor nunc, at eleifend mi porta eu.", image: Image(systemName: "globe.europe.africa.fill")),
        WhatsNewFeature(title: "Another one", text: "Sed ex risus, vehicula et finibus et, venenatis vitae nisi.", image: Image(systemName: "megaphone")),
    ]
    
    var body: some View {
        NavigationView {
            
            VStack {
                Button("Display WhatsNewView") {
                    outputText = ""
                    showView.toggle()
                }
                .font(.headline)
                
                .sheet(isPresented: $showView) {
                    WhatsNewView(
                        features: features,
                        mainColor: .green,
                        titleText: "What's New",
                        subtitleText: "In version 1.42",
                        continueText: "Continue",
                        moreInfoText: "More info...",
                        continueButtonAction: whatsNewContinue,
                        moreInfoButtonAction: whatsNewMoreInfo,
                        featureTapAction: whatsNewDidTap(feature:atIndex:)
                    )
                }
                    
                Text(outputText)
                    .font(.footnote)
                    .foregroundColor(.secondary)
                    .padding()
            
            }
            
            .navigationTitle("WhatsNewView demo")
        }
    }
    
    func whatsNewContinue() {
        outputText = "Continue button tapped"
        showView.toggle()
    }
    
    func whatsNewMoreInfo() {
        outputText = "More info button tapped"
        showView.toggle()
    }
    
    func whatsNewDidTap(feature: WhatsNewFeature, atIndex index: Int) {
        outputText = "Feature at index \(index) tapped: \(feature.title)"
        showView.toggle()
    }
}

Screenshots

Here are few screenshots (with random texts!) of WhatsNewView:

Simulator Screen Shot - iPhone 12 - 2021-12-05 at 17 19 44 Simulator Screen Shot - iPhone 12 - 2021-12-05 at 17 21 15

Simulator Screen Shot - iPhone 12 - 2021-12-05 at 17 22 00 Simulator Screen Shot - iPhone 12 - 2021-12-05 at 17 23 01

They're already using it

If you use it in your app, please let me know and I will add your link here. You can contact me here.

Licence

Be free to use this WhatsNewView package in your app. Licence is available here. Please only add a copyright and licence notice.

GitHub

link
Stars: 1
Last commit: 2 weeks ago
jonrohan Something's broken? Yell at me @ptrpavlik. Praise and feedback (and money) is also welcome.

Related Packages

Swiftpack is being maintained by Petr Pavlik | @ptrpavlik | @swiftpackco | API | Analytics