WhatsNewKit下载 - WhatsNewKit源代码下载

import SwiftUI
import WhatsNewKit

struct ContentView : View {

    var body : some View {
        NavigationView {
            // ...
        }
        . whatsNewSheet ( )
    }

}

特征

轻松介绍您的新应用功能？
自动和手动演示模式✅
支持Swiftui，Uikit和AppKit？‍？
在iOS，macos和visionos上运行？？
可调节布局？

安装

Swift软件包管理器

要使用Apple的Swift软件包管理器集成，请添加以下作为依赖性的Package.swift ：Swift：

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

或导航到您的Xcode项目，然后选择Swift Packages ，单击“+”图标，然后搜索WhatsNewKit 。

例子

查看示例应用程序，以查看WhatsNewKit正在行动。只需打开Example/Example.xcodeproj并运行“示例”方案。

示例应用程序

用法

手动演示

如果您想手动展示WhatsNewView则可以使用sheet(whatsNew:)修改器。

 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
        )
    }

}

自动演示

自动演示模式使您可以简单地通过SwiftUI环境声明您的新功能，WhatsNewKit将注意相应的WhatsNewView 。

首先将.whatsNewSheet()修饰符添加到应在其中显示WhatsNewView视图中。

 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 ( )
    }

}

.whatsNewSheet()修饰符正在利用WhatsNewEnvironment检索应向当前版本呈现用户提供的可选WhatsNew对象。因此，您可以通过environment修饰符轻松地配置WhatsNewEnvironment 。

 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

WhatsNewEnvironment将注意确定应向当前版本提供给用户的匹配WhatsNew对象。

如上一个示例所示，您可以通过指定WhatsNewVersionStore并提供WhatsNewCollection来初始化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 " ,
            // ...
        )
    }
)

此外， WhatsNewEnvironment还包括补丁版本的后备。例如，当用户安装版本1.0.1并且您仅声明了版本1.0.0的WhatsNew时，环境将自动退回到1.0.0版，并在需要时向用户呈现WhatsNewView 。

如果您希望进一步自定义WhatsNewEnvironment的行为，则可以轻松地子类并覆盖whatsNew()函数。

 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

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 " )

WhatsNewkit随附了三个预定义的实现：

// 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 ( )

如果您已经具有特定的实现来存储与用户相关的设置（例如领域或核心数据），则可以轻松地将现有的实现采用到WhatsNewVersionStore协议。

nsubipiquitousKeyvalueWhatsNewversionStore

如果要使用NSUbiquitousKeyValueWhatsNewVersionStore ，请确保在Xcode项目的“签名和功能”部分中启用iCloud键值存储功能。

iCloud键值存储

什么是新的

以下各节解释了如何将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

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

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

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

WhatsNew.PrimaryAction允许您配置用于删除介绍的WhatsNewView主按钮的行为

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

注意：HapticFeedback仅在iOS上执行

whatsnew.sparyaction

WhatsNew.SecondaryAction显示在WhatsNew.PrimaryAction上方显示。初始化WhatsNew实例时，可以选择提供原始ActionAction，并允许您提供其他视图，执行自定义操作或打开URL。

// 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
        // ...
    }
)

注意：HapticFeedback仅在iOS上执行

布局

WhatsNewKit允许您以各种方式调整呈现的WhatsNewView的布局。

最简单的方法是突变WhatsNew.Layout.default实例。

 WhatsNew . Layout . default . featureListSpacing = 35

使用自动演示样式时，您可以在初始化WhatsNewenvironment时提供默认布局。

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

另外，您可以通过WhatsNew.Layout自动或手动显示WhatsNewView

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

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

WhatsNewViewController

使用UIKit或AppKit时，您可以使用WhatsNewViewController 。

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

如果您只想在尚未提出WhatsNew实例的版本时才提出WhatsNewViewController ，则可以使用便利性故障初始化器。

// 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 )

展开

WhatsNewKit

特征

安装

Swift软件包管理器

例子

用法

目录

手动演示

自动演示

WhatsNewenvironment

WhatsNewversionstore

nsubipiquitousKeyvalueWhatsNewversionStore

什么是新的

whatsnew.version

whatsnew.title

whatsnew.feature

WhatsNew.PrimaryAction

whatsnew.sparyaction

布局

WhatsNewViewController

Google Dorks

shepherd

mongo express

hidusbf

Free Algorithms Books

markdownpedia

chat.petals.dev

GPT Prompt Templates

GPTyped

Google Dorks

shepherd

mongo express

Google Dorks

shepherd

mongo express