WhatsNewKit

import SwiftUI
import WhatsNewKit
struct ContentView: View {
 var body: some View {
 NavigationView {
 // ...
 }
 .whatsNewSheet()
 }
}

Features

Installation

Swift Package Manager

dependencies: [
 .package(url: "https://github.com/SvenTiigi/WhatsNewKit.git", from: "2.0.0")
]

Example

Usage

Table of contents

Manual Presentation

struct ContentView: View {
 @State
 var whatsNew: WhatsNew? = WhatsNew(
 title: "WhatsNewKit",
 features: [
 .init(
 image: .init(
 systemName: "star.fill",
 foregroundColor: .orange
 ),
 title: "Showcase your new App Features",
 subtitle: "Present your new app features..."
 ),
 // ...
 ]
 )
 var body: some View {
 NavigationView {
 // ...
 }
 .sheet(
 whatsNew: self.$whatsNew
 )
 }
}

Automatic Presentation

struct ContentView: View {
 var body: some View {
 NavigationView {
 // ...
 }
 // Automatically present a WhatsNewView, if needed.
 // The WhatsNew that should be presented to the user
 // is automatically retrieved from the `WhatsNewEnvironment`
 .whatsNewSheet()
 }
}

extension App: SwiftUI.App {
 var body: some Scene {
 WindowGroup {
 ContentView()
 .environment(
 \.whatsNew,
 WhatsNewEnvironment(
 // Specify in which way the presented WhatsNew Versions are stored.
 // In default the `UserDefaultsWhatsNewVersionStore` is used.
 versionStore: UserDefaultsWhatsNewVersionStore(),
 // Pass a `WhatsNewCollectionProvider` or an array of WhatsNew instances
 whatsNewCollection: self
 )
 )
 }
 }
}
// MARK: - App+WhatsNewCollectionProvider
extension App: WhatsNewCollectionProvider {
 /// Declare your WhatsNew instances per version
 var whatsNewCollection: WhatsNewCollection {
 WhatsNew(
 version: "1.0.0",
 // ...
 )
 WhatsNew(
 version: "1.1.0",
 // ...
 )
 WhatsNew(
 version: "1.2.0",
 // ...
 )
 }
}

WhatsNewEnvironment

// Initialize WhatsNewEnvironment by passing an array of WhatsNew Instances.
// UserDefaultsWhatsNewVersionStore is used as default WhatsNewVersionStore
let whatsNewEnvironment = WhatsNewEnvironment(
 whatsNewCollection: [
 WhatsNew(
 version: "1.0.0",
 // ...
 )
 ]
)
// Initialize WhatsNewEnvironment with NSUbiquitousKeyValueWhatsNewVersionStore
// which stores the presented versions in iCloud.
// WhatsNewCollection is provided by a `WhatsNewBuilder` closure
let whatsNewEnvironment = WhatsNewEnvironment(
 versionStore: NSUbiquitousKeyValueWhatsNewVersionStore(),
 whatsNewCollection: {
 WhatsNew(
 version: "1.0.0",
 // ...
 )
 }
)

class MyCustomWhatsNewEnvironment: WhatsNewEnvironment {
 /// Retrieve a WhatsNew that should be presented to the user, if available.
 override func whatsNew() -> WhatsNew? {
 // The current version
 let currentVersion = self.currentVersion
 // Your declared WhatsNew objects
 let whatsNewCollection = self.whatsNewCollection
 // The WhatsNewVersionStore used to determine the already presented versions
 let versionStore = self.whatsNewVersionStore
 // TODO: Determine WhatsNew that should be presented to the user...
 }
}

WhatsNewVersionStore

let whatsNewVersionStore: WhatsNewVersionStore
// Save presented versions
whatsNewVersionStore.save(presentedVersion: "1.0.0")
// Retrieve presented versions
let presentedVersions = whatsNewVersionStore.presentedVersions
// Retrieve bool value if a given version has already been presented
let hasPresented = whatsNewVersionStore.hasPresented("1.0.0")

// Persists presented versions in the UserDefaults
let userDefaultsWhatsNewVersionStore = UserDefaultsWhatsNewVersionStore()
// Persists presented versions in iCloud using the NSUbiquitousKeyValueStore
let ubiquitousKeyValueWhatsNewVersionStore = NSUbiquitousKeyValueWhatsNewVersionStore()
// Stores presented versions in memory. Perfect for testing purposes
let inMemoryWhatsNewVersionStore = InMemoryWhatsNewVersionStore()

NSUbiquitousKeyValueWhatsNewVersionStore

WhatsNew

let whatsnew = WhatsNew(
 // The Version that relates to the features you want to showcase
 version: "1.0.0",
 // The title that is shown at the top
 title: "What's New",
 // The features you want to showcase
 features: [
 WhatsNew.Feature(
 image: .init(systemName: "star.fill"),
 title: "Title",
 subtitle: "Subtitle"
 )
 ],
 // The primary action that is used to dismiss the WhatsNewView
 primaryAction: WhatsNew.PrimaryAction(
 title: "Continue",
 backgroundColor: .accentColor,
 foregroundColor: .white,
 hapticFeedback: .notification(.success),
 onDismiss: {
 print("WhatsNewView has been dismissed")
 }
 ),
 // The optional secondary action that is displayed above the primary action
 secondaryAction: WhatsNew.SecondaryAction(
 title: "Learn more",
 foregroundColor: .accentColor,
 hapticFeedback: .selection,
 action: .openURL(
 .init(string: "https://github.com/SvenTiigi/WhatsNewKit")
 )
 )
)

WhatsNew.Version

// Initialize with major, minor, and patch
let version = WhatsNew.Version(
 major: 1,
 minor: 0,
 patch: 0
)
// Initialize by string literal
let version: WhatsNew.Version = "1.0.0"
// Initialize WhatsNew Version by using the current version of your bundle
let version: WhatsNew.Version = .current()

WhatsNew.Title

// Initialize by string literal
let title: WhatsNew.Title = "Continue"
// Initialize with text and foreground color
let title = WhatsNew.Title(
 text: "Continue",
 foregroundColor: .primary
)
// On >= iOS 15 initialize with AttributedString using Markdown
let title = WhatsNew.Title(
 text: try AttributedString(
 markdown: "What's **New**"
 )
)

WhatsNew.Feature

let feature = WhatsNew.Feature(
 image: .init(
 systemName: "wand.and.stars"
 ),
 title: "New Design",
 subtitle: .init(
 try AttributedString(
 markdown: "An awesome new _Design_"
 )
 )
)

WhatsNew.PrimaryAction

let primaryAction = WhatsNew.PrimaryAction(
 title: "Continue",
 backgroundColor: .blue,
 foregroundColor: .white,
 hapticFeedback: .notification(.success),
 onDismiss: {
 print("WhatsNewView has been dismissed")
 }
)

WhatsNew.SecondaryAction

// SecondaryAction that presents a View
let secondaryActionPresentAboutView = WhatsNew.SecondaryAction(
 title: "Learn more",
 foregroundColor: .blue,
 hapticFeedback: .selection,
 action: .present {
 AboutView()
 }
)
// SecondaryAction that opens a URL
let secondaryActionOpenURL = WhatsNew.SecondaryAction(
 title: "Read more",
 foregroundColor: .blue,
 hapticFeedback: .selection,
 action: .open(
 url: .init(string: "https://github.com/SvenTiigi/WhatsNewKit")
 )
)
// SecondaryAction with custom execution
let secondaryActionCustom = WhatsNew.SecondaryAction(
 title: "Custom",
 action: .custom { presentationMode in
 // ...
 }
)

Layout

WhatsNew.Layout.default.featureListSpacing = 35

.environment(
 \.whatsNew,
 .init(
 defaultLayout: WhatsNew.Layout(
 showsScrollViewIndicators: true,
 featureListSpacing: 35
 ),
 whatsNew: self
 )
)

.whatsNewSheet(
 layout: WhatsNew.Layout(
 contentPadding: .init(
 top: 80,
 leading: 0,
 bottom: 0,
 trailing: 0
 )
 )
)

.sheet(
 whatsNew: self.$whatsNew,
 layout: WhatsNew.Layout(
 footerActionSpacing: 20
 )
)

WhatsNewViewController

let whatsNewViewController = WhatsNewViewController(
 whatsNew: WhatsNew(
 version: "1.0.0",
 // ...
 ),
 layout: WhatsNew.Layout(
 contentSpacing: 80
 )
)

// Verify WhatsNewViewController is available for presentation
guard let whatsNewViewController = WhatsNewViewController(
 whatsNew: WhatsNew(
 version: "1.0.0",
 // ...
 ),
 versionStore: UserDefaultsWhatsNewVersionStore()
) else {
 // Version of WhatsNew has already been presented
 return
}
// Present WhatsNewViewController
// Version will be automatically saved in the provided
// WhatsNewVersionStore when the WhatsNewViewController gets dismissed
self.present(whatsNewViewController, animated: true)