Revision control
Copy as Markdown
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
#if DEBUG
import SwiftUI
import Common
private struct PreviewModel: OnboardingCardInfoModelProtocol {
var image: UIImage? { UIImage(named: imageID, in: Bundle.module, compatibleWith: nil) }
var cardType: OnboardingCardType
var name, title, body, a11yIdRoot, imageID: String
var order: Int
var instructionsPopup: OnboardingInstructionsPopupInfoModel<OnboardingInstructionsPopupActions>?
var link: OnboardingLinkInfoModel?
var buttons: OnboardingButtons<OnboardingActions>
var multipleChoiceButtons: [OnboardingMultipleChoiceButtonModel<OnboardingMultipleChoiceAction>]
var onboardingType: OnboardingType
init(
cardType: OnboardingCardType,
name: String,
order: Int,
title: String,
body: String,
link: OnboardingLinkInfoModel? = nil,
buttons: OnboardingButtons<OnboardingActions>,
multipleChoiceButtons: [OnboardingMultipleChoiceButtonModel<OnboardingMultipleChoiceAction>] = [],
onboardingType: OnboardingType = .freshInstall,
a11yIdRoot: String,
imageID: String,
instructionsPopup: OnboardingInstructionsPopupInfoModel<OnboardingInstructionsPopupActions>? = nil
) {
self.cardType = cardType; self.name = name; self.order = order; self.title = title; self.body = body
self.link = link; self.buttons = buttons; self.multipleChoiceButtons = multipleChoiceButtons
self.onboardingType = onboardingType; self.a11yIdRoot = a11yIdRoot; self.imageID = imageID
self.instructionsPopup = instructionsPopup
}
}
public enum OnboardingType: String, Codable {
case freshInstall = "fresh-install"
case upgrade
}
public enum OnboardingMultipleChoiceAction: String, CaseIterable, Codable {
case themeDark = "theme-dark"
case themeLight = "theme-light"
case themeSystemDefault = "theme-system-default"
case toolbarBottom = "toolbar-bottom"
case toolbarTop = "toolbar-top"
var id: String { rawValue }
var displayName: String {
switch self {
case .themeDark:
return "Dark"
case .themeLight:
return "Light"
case .themeSystemDefault:
return "System Default"
case .toolbarBottom:
return "Bottom"
case .toolbarTop:
return "Top"
}
}
}
public enum OnboardingInstructionsPopupActions: String, CaseIterable, Codable {
case dismiss
case dismissAndNextCard = "dismiss-and-next-card"
case openIosFxSettings = "open-ios-fx-settings"
var displayName: String { rawValue }
var id: String { rawValue }
}
public enum OnboardingActions: String, CaseIterable, Codable {
case endOnboarding = "end-onboarding"
case forwardOneCard = "forward-one-card"
case forwardTwoCard = "forward-two-card"
case forwardThreeCard = "forward-three-card"
case openInstructionsPopup = "open-instructions-popup"
case openIosFxSettings = "open-ios-fx-settings"
case readPrivacyPolicy = "read-privacy-policy"
case requestNotifications = "request-notifications"
case setDefaultBrowser = "set-default-browser"
case syncSignIn = "sync-sign-in"
var displayName: String { rawValue }
var id: String { rawValue }
}
extension PreviewModel {
static let welcome = PreviewModel(
cardType: .basic,
name: "welcome",
order: 10,
title: "Get automatic protection from trackers",
body: "One tap helps stop companies spying on your clicks.",
link: nil,
buttons: .init(
primary: .init(title: "Get Started", action: OnboardingActions.forwardOneCard),
secondary: .init(title: "Not Now", action: OnboardingActions.forwardOneCard)
),
multipleChoiceButtons: [],
onboardingType: .freshInstall,
a11yIdRoot: "onboarding_welcome",
imageID: "trackers",
instructionsPopup: OnboardingInstructionsPopupInfoModel(
title: "Set as Default Browser",
instructionSteps: [
"Open Settings",
"Find Default Apps",
"Select Firefox"
],
buttonTitle: "Open Settings",
buttonAction: OnboardingInstructionsPopupActions.openIosFxSettings,
a11yIdRoot: "onboarding_welcomeInstructionsPopup"
)
)
static let signToSync = PreviewModel(
cardType: .basic,
name: "signToSync",
order: 20,
title: "Sync everywhere you use Firefox",
body: "Get bookmarks, tabs, and passwords on any device. All protected with encryption.",
link: nil,
buttons: .init(
primary: .init(title: "Sign In", action: OnboardingActions.syncSignIn),
secondary: .init(title: "Skip", action: OnboardingActions.forwardOneCard)
),
multipleChoiceButtons: [],
onboardingType: .freshInstall,
a11yIdRoot: "onboarding_signToSync",
imageID: "syncWithIcons",
instructionsPopup: nil
)
static let customizationToolbar = PreviewModel(
cardType: .multipleChoice,
name: "customizationToolbar",
order: 41,
title: "Toolbar Position",
body: "Where should the toolbar appear?",
link: nil,
buttons: .init(
primary: .init(title: "Continue", action: OnboardingActions.forwardOneCard),
secondary: nil
),
multipleChoiceButtons: [
.init(title: "Top", action: OnboardingMultipleChoiceAction.toolbarTop, imageID: "toolbarTop"),
.init(title: "Bottom", action: OnboardingMultipleChoiceAction.toolbarBottom, imageID: "toolbarBottom")
],
onboardingType: .freshInstall,
a11yIdRoot: "onboarding_customizationToolbar",
imageID: "toolbar",
instructionsPopup: nil
)
}
extension PreviewModel {
/// All of the built-in preview cards
static let all: [PreviewModel] = [
.welcome,
.customizationToolbar,
.signToSync
]
}
#Preview("Onboarding Card") {
ZStack {
MilkyWayMetalView()
.edgesIgnoringSafeArea(.all)
OnboardingBasicCardView(
viewModel: PreviewModel.welcome,
windowUUID: .DefaultUITestingUUID,
themeManager: DefaultThemeManager(sharedContainerIdentifier: ""),
onBottomButtonAction: { _, _ in },
onLinkTap: { _ in }
)
}
}
#Preview("Multiple Choice Onboarding Card") {
ZStack {
MilkyWayMetalView()
.edgesIgnoringSafeArea(.all)
OnboardingMultipleChoiceCardView(
viewModel: PreviewModel.customizationToolbar,
windowUUID: .DefaultUITestingUUID,
themeManager: DefaultThemeManager(sharedContainerIdentifier: ""),
onBottomButtonAction: { _, _ in },
onMultipleChoiceAction: { _, _ in },
onLinkTap: { _ in }
)
}
}
#Preview("Onboarding Flow") {
OnboardingView<PreviewModel>(
windowUUID: .DefaultUITestingUUID,
themeManager: DefaultThemeManager(sharedContainerIdentifier: ""),
viewModel: OnboardingFlowViewModel(
onboardingCards: PreviewModel.all,
onComplete: { }
)
)
}
#endif