WhatsNewKit
Version 2.2.1
import SwiftUI
import WhatsNewKit
struct ContentView : View {
var body : some View {
NavigationView {
// ...
}
. whatsNewSheet ( )
}
} Чтобы интегрировать использование Manager Apple Swift Package Manager, добавьте следующее в качестве зависимости в ваш 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, который должен быть представлен пользователю для текущей версии. Поэтому вы можете легко настроить WhatsNewEnvironment через модификатор environment .
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 позаботится о том, чтобы определить соответствующий объект WhatsNew, который должен быть представлен пользователю для текущей версии.
Как видно в предыдущем примере, вы можете инициализировать WhatsNewEnvironment , указав WhatsNewVersionStore и предоставив WhatsNewCollection .
// 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 , и вы объявили только WhatsNew для версии 1.0.0 среда автоматически отступает на версию 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 - это тип протокола, который отвечает за сохранение и получение версий, которые были представлены пользователю.
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 ( ) Если у вас уже есть конкретная реализация для хранения настроек, связанных с пользователем, таких как Realm или основные данные, вы можете легко принять существующую реализацию в протокол WhatsNewVersionStore .
Если вы используете NSUbiquitousKeyValueWhatsNewVersionStore , пожалуйста, убедитесь, что можно обеспечить возможность хранения ключей iCloud в разделе «Подписание и возможности» вашего проекта XCode.
В следующих разделах объясняется, как может быть инициализирована структура 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** "
)
) A 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 позволяет настроить поведение первичной кнопки, которая используется для отклонения представленного WhatsNewView
let primaryAction = WhatsNew . PrimaryAction (
title : " Continue " ,
backgroundColor : . blue ,
foregroundColor : . white ,
hapticFeedback : . notification ( . success ) ,
onDismiss : {
print ( " WhatsNewView has been dismissed " )
}
)Примечание: HapticFeedback будет выполнена только на iOS
WhatsNew.SecondaryAction -SecondaryAction, который отображается над WhatsNew.PrimaryAction , можно предоставить при инициализации экземпляра WhatsNew , и позволяет представить дополнительное представление, выполнить пользовательское действие или открыть 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
)
) При использовании UIKit или AppKit вы можете использовать WhatsNewViewController .
let whatsNewViewController = WhatsNewViewController (
whatsNew : WhatsNew (
version : " 1.0.0 " ,
// ...
) ,
layout : WhatsNew . Layout (
contentSpacing : 80
)
) Если вы хотите представить WhatsNewViewController , только если версия экземпляра WhatsNew не была представлена, вы можете использовать удобный невозможный инициализатор.
// 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 )
