Add the Use Case selection screen to the onboarding flow.

2026-05-03 06:36:58 +02:00 · 2022-02-02 12:24:22 +00:00
parent ad7c8dfa1b
commit 2cef1a7398
48 changed files with 1178 additions and 134 deletions
@@ -0,0 +1,60 @@
+//
+// Copyright 2021 New Vector Ltd
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+import SwiftUI
+
+final class OnboardingUseCaseCoordinator: Coordinator, Presentable {
+    
+    // MARK: - Properties
+    
+    // MARK: Private
+    
+    private let onboardingUseCaseHostingController: UIViewController
+    private var onboardingUseCaseViewModel: OnboardingUseCaseViewModelProtocol
+    
+    // MARK: Public
+
+    // Must be used only internally
+    var childCoordinators: [Coordinator] = []
+    var completion: ((OnboardingUseCaseViewModelResult) -> Void)?
+    
+    // MARK: - Setup
+    
+    @available(iOS 14.0, *)
+    init() {
+        let viewModel = OnboardingUseCaseViewModel()
+        let view = OnboardingUseCase(viewModel: viewModel.context)
+        onboardingUseCaseViewModel = viewModel
+        
+        let hostingController = VectorHostingController(rootView: view)
+        hostingController.vc_removeBackTitle()
+        onboardingUseCaseHostingController = hostingController
+    }
+    
+    // MARK: - Public
+    func start() {
+        MXLog.debug("[OnboardingUseCaseCoordinator] did start.")
+        onboardingUseCaseViewModel.completion = { [weak self] result in
+            MXLog.debug("[OnboardingUseCaseCoordinator] OnboardingUseCaseViewModel did complete with result: \(result).")
+            guard let self = self else { return }
+            self.completion?(result)
+        }
+    }
+    
+    func toPresentable() -> UIViewController {
+        return self.onboardingUseCaseHostingController
+    }
+}
@@ -0,0 +1,52 @@
+// 
+// Copyright 2021 New Vector Ltd
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+import Foundation
+import SwiftUI
+
+/// Using an enum for the screen allows you define the different state cases with
+/// the relevant associated data for each case.
+@available(iOS 14.0, *)
+enum MockOnboardingUseCaseScreenState: MockScreenState, CaseIterable {
+    // A case for each state you want to represent
+    // with specific, minimal associated data that will allow you
+    // mock that screen.
+    case `default`
+    
+    /// The associated screen
+    var screenType: Any.Type {
+        OnboardingUseCase.self
+    }
+    
+    /// A list of screen state definitions
+    static var allCases: [MockOnboardingUseCaseScreenState] {
+        // Each of the presence statuses
+        [.default]
+    }
+    
+    /// Generate the view struct for the screen state.
+    var screenView: ([Any], AnyView)  {
+        let viewModel = OnboardingUseCaseViewModel()
+        
+        // can simulate service and viewModel actions here if needs be.
+        
+        return (
+            [self, viewModel],
+            AnyView(OnboardingUseCase(viewModel: viewModel.context)
+                .addDependency(MockAvatarService.example))
+        )
+    }
+}
@@ -0,0 +1,41 @@
+// 
+// Copyright 2021 New Vector Ltd
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+import Foundation
+
+// MARK: - Coordinator
+
+// MARK: View model
+
+enum OnboardingUseCaseStateAction {
+    case viewAction(OnboardingUseCaseViewAction)
+}
+
+enum OnboardingUseCaseViewModelResult {
+    case personalMessaging
+    case workMessaging
+    case communityMessaging
+    case skipped
+    case customServer
+}
+
+// MARK: View
+
+struct OnboardingUseCaseViewState: BindableState { }
+
+enum OnboardingUseCaseViewAction {
+    case answer(OnboardingUseCaseViewModelResult)
+}
@@ -0,0 +1,52 @@
+//
+// Copyright 2021 New Vector Ltd
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+import SwiftUI
+
+@available(iOS 14, *)
+typealias OnboardingUseCaseViewModelType = StateStoreViewModel<OnboardingUseCaseViewState,
+                                                                 OnboardingUseCaseStateAction,
+                                                                 OnboardingUseCaseViewAction>
+@available(iOS 14, *)
+class OnboardingUseCaseViewModel: OnboardingUseCaseViewModelType, OnboardingUseCaseViewModelProtocol {
+
+    // MARK: - Properties
+
+    // MARK: Private
+
+    // MARK: Public
+
+    var completion: ((OnboardingUseCaseViewModelResult) -> Void)?
+
+    // MARK: - Setup
+
+    init() {
+        super.init(initialViewState: OnboardingUseCaseViewState())
+    }
+
+    // MARK: - Public
+
+    override func process(viewAction: OnboardingUseCaseViewAction) {
+        switch viewAction {
+        case .answer(let result):
+            completion?(result)
+        }
+    }
+
+    override class func reducer(state: inout OnboardingUseCaseViewState, action: OnboardingUseCaseStateAction) {
+        // There is no mutable state to reduce :)
+    }
+}
@@ -0,0 +1,24 @@
+// 
+// Copyright 2021 New Vector Ltd
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+import Foundation
+
+protocol OnboardingUseCaseViewModelProtocol {
+    
+    var completion: ((OnboardingUseCaseViewModelResult) -> Void)? { get set }
+    @available(iOS 14, *)
+    var context: OnboardingUseCaseViewModelType.Context { get }
+}
@@ -0,0 +1,23 @@
+//
+// Copyright 2021 New Vector Ltd
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+import XCTest
+import RiotSwiftUI
+
+@available(iOS 14.0, *)
+class OnboardingUseCaseUITests: MockScreenTest {
+    // The view has no parameters or changing state to test.
+}
@@ -0,0 +1,24 @@
+// 
+// Copyright 2021 New Vector Ltd
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+import XCTest
+
+@testable import RiotSwiftUI
+
+@available(iOS 14.0, *)
+class OnboardingUseCaseViewModelTests: XCTestCase {
+    // The view model has nothing to test.
+}
@@ -0,0 +1,132 @@
+// 
+// Copyright 2021 New Vector Ltd
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+import SwiftUI
+
+@available(iOS 14.0, *)
+/// The screen shown to a new user to select their use case for the app.
+struct OnboardingUseCase: View {
+
+    // MARK: - Properties
+    
+    // MARK: Private
+    
+    @Environment(\.theme) private var theme
+    @Environment(\.horizontalSizeClass) private var horizontalSizeClass
+    
+    // MARK: Public
+    
+    @ObservedObject var viewModel: OnboardingUseCaseViewModel.Context
+    
+    /// The screen's title and instructions.
+    var titleContent: some View {
+        VStack(spacing: 8) {
+            Image(Asset.Images.onboardingUseCaseIcon.name)
+                .padding(.bottom, 8)
+            
+            Text(VectorL10n.onboardingUseCaseTitle)
+                .font(theme.fonts.title2B)
+                .foregroundColor(theme.colors.primaryContent)
+            
+            Text(VectorL10n.onboardingUseCaseMessage)
+                .font(theme.fonts.body)
+                .foregroundColor(theme.colors.secondaryContent)
+        }
+    }
+    
+    /// The buttons used to select a use case for the app.
+    var useCaseButtons: some View {
+        VStack(spacing: 8) {
+            OnboardingUseCaseButton(title: VectorL10n.onboardingUseCasePersonalMessaging,
+                                    image: theme.isDark ? Asset.Images.onboardingUseCasePersonalDark : Asset.Images.onboardingUseCasePersonal) {
+                viewModel.send(viewAction: .answer(.personalMessaging))
+            }
+            
+            OnboardingUseCaseButton(title: VectorL10n.onboardingUseCaseWorkMessaging,
+                                    image: theme.isDark ? Asset.Images.onboardingUseCaseWorkDark : Asset.Images.onboardingUseCaseWork) {
+                viewModel.send(viewAction: .answer(.workMessaging))
+            }
+            
+            OnboardingUseCaseButton(title: VectorL10n.onboardingUseCaseCommunityMessaging,
+                                    image: theme.isDark ? Asset.Images.onboardingUseCaseCommunityDark : Asset.Images.onboardingUseCaseCommunity) {
+                viewModel.send(viewAction: .answer(.communityMessaging))
+            }
+            
+            InlineTextButton(VectorL10n.onboardingUseCaseNotSureYet("%@"),
+                             tappableText: VectorL10n.onboardingUseCaseSkipButton) {
+                viewModel.send(viewAction: .answer(.skipped))
+            }
+            .font(theme.fonts.subheadline)
+            .foregroundColor(theme.colors.tertiaryContent)
+            .padding(.top, 8)
+        }
+    }
+    
+    /// A footer showing a button to connect to a server.
+    var serverFooter: some View {
+        VStack(spacing: 14) {
+            Text(VectorL10n.onboardingUseCaseExistingServerMessage)
+                .font(theme.fonts.subheadline)
+                .foregroundColor(theme.colors.tertiaryContent)
+            
+            Button { viewModel.send(viewAction: .answer(.customServer)) } label: {
+                Text(VectorL10n.onboardingUseCaseExistingServerButton)
+                    .font(theme.fonts.body)
+            }
+        }
+    }
+    
+    var body: some View {
+        GeometryReader { geometry in
+            VStack {
+                ScrollView {
+                    VStack(spacing: 0) {
+                        titleContent
+                            .padding(.bottom, 36)
+                        
+                        useCaseButtons
+                    }
+                    .frame(maxWidth: OnboardingConstants.maxContentWidth,
+                           maxHeight: OnboardingConstants.maxContentHeight)
+                    .padding(.horizontal, 16)
+                    .padding(.top, 48)
+                    .padding(.bottom, 16)
+                }
+                .frame(maxWidth: .infinity)
+                
+                serverFooter
+                    .padding(.horizontal, 16)
+                    .padding(.bottom, geometry.safeAreaInsets.bottom > 0 ? 20 : 36)
+            }
+        }
+        .background(theme.colors.background.ignoresSafeArea())
+        .accentColor(theme.colors.accent)
+    }
+}
+
+// MARK: - Previews
+
+@available(iOS 14.0, *)
+struct OnboardingUseCase_Previews: PreviewProvider {
+    static let stateRenderer = MockOnboardingUseCaseScreenState.stateRenderer
+    static var previews: some View {
+        NavigationView {
+            stateRenderer.screenGroup()
+                .navigationBarTitleDisplayMode(.inline)
+        }
+        .navigationViewStyle(StackNavigationViewStyle())
+    }
+}
@@ -0,0 +1,59 @@
+// 
+// Copyright 2021 New Vector Ltd
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+import SwiftUI
+
+@available(iOS 14.0, *)
+/// A button used for the Use Case selection.
+struct OnboardingUseCaseButton: View {
+    
+    // MARK: Private
+    
+    @Environment(\.theme) private var theme
+    
+    // MARK: Public
+    
+    /// The button's title.
+    let title: String
+    /// The button's image.
+    let image: ImageAsset
+    
+    /// The button's action when tapped.
+    let action: () -> Void
+    
+    var body: some View {
+        Button(action: action) {
+            HStack(spacing: 16) {
+                Image(image.name)
+                Text(title)
+                    .font(theme.fonts.bodySB)
+                    .foregroundColor(theme.colors.primaryContent)
+            }
+            .padding(16)
+        }
+        .buttonStyle(OnboardingButtonStyle())
+    }
+}
+
+@available(iOS 14.0, *)
+struct Previews_OnboardingUseCaseButton_Previews: PreviewProvider {
+    static var previews: some View {
+        OnboardingUseCaseButton(title: VectorL10n.onboardingUseCaseWorkMessaging,
+                                image: Asset.Images.onboardingUseCaseWork,
+                                action: { })
+            .padding(16)
+    }
+}