#106: Add Analytics UI

2026-11-02 21:33:26 +00:00 · 2022-09-02 10:49:59 +01:00
parent df68174a32
commit 8e46d0e3d6
26 changed files with 1437 additions and 85 deletions
@@ -0,0 +1,130 @@
+//
+// 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
+
+/// A prompt that asks the user whether they would like to enable Analytics or not.
+struct AnalyticsPrompt: View {
+    // MARK: - Properties
+    
+    // MARK: Private
+    
+    private let horizontalPadding: CGFloat = 16
+    
+    // MARK: Public
+    
+    @ObservedObject var context: AnalyticsPromptViewModel.Context
+    
+    // MARK: Views
+    
+    var body: some View {
+        GeometryReader { geometry in
+            ScrollView {
+                Spacer()
+                    .frame(height: UIConstants.spacerHeight(in: geometry))
+                
+                mainContent
+                    .readableFrame()
+                    .padding(.horizontal, horizontalPadding)
+                    .padding(.top, UIConstants.onboardingBreakerScreenTopPadding)
+                    .padding(.bottom, 8)
+            }
+            .safeAreaInset(edge: .bottom) {
+                VStack {
+                    buttons
+                        .readableFrame()
+                        .padding(.horizontal, horizontalPadding)
+                        .padding(.bottom, UIConstants.actionButtonBottomPadding)
+                    
+                    Spacer()
+                        .frame(height: UIConstants.spacerHeight(in: geometry))
+                }
+                .padding(.top, 8)
+                .background(Color.element.background.ignoresSafeArea())
+            }
+            .background(Color.element.background.ignoresSafeArea())
+        }
+        .navigationBarHidden(true)
+        .navigationBarBackButtonHidden(true)
+    }
+    
+    /// The main content of the screen that is shown inside the scroll view.
+    private var mainContent: some View {
+        VStack {
+            Image(uiImage: Asset.Images.analyticsLogo.image)
+                .padding(.bottom, 25)
+            
+            Text(ElementL10n.analyticsOptInTitle(ElementInfoPlist.cfBundleName))
+                .font(.element.title2B)
+                .multilineTextAlignment(.center)
+                .foregroundColor(.element.primaryContent)
+                .padding(.bottom, 2)
+            
+            Text(context.viewState.strings.optInContent)
+                .font(.element.body)
+                .multilineTextAlignment(.center)
+                .foregroundColor(.element.secondaryContent)
+            
+            Divider()
+                .background(Color.element.quinaryContent)
+                .padding(.vertical, 28)
+            
+            checkmarkList
+        }
+    }
+    
+    /// The list of re-assurances about analytics.
+    private var checkmarkList: some View {
+        VStack(alignment: .leading) {
+            AnalyticsPromptCheckmarkItem(attributedString: context.viewState.strings.point1)
+            AnalyticsPromptCheckmarkItem(attributedString: context.viewState.strings.point1)
+            AnalyticsPromptCheckmarkItem(string: ElementL10n.analyticsOptInListItem3)
+        }
+        .fixedSize(horizontal: false, vertical: true)
+        .font(.element.body)
+        .foregroundColor(.element.secondaryContent)
+        .frame(maxWidth: .infinity)
+    }
+    
+    /// The stack of enable/disable buttons.
+    private var buttons: some View {
+        VStack {
+            Button { context.send(viewAction: .enable) } label: {
+                Text(ElementL10n.actionEnable)
+                    .font(.element.bodySB)
+            }
+            .buttonStyle(.elementAction(.xLarge))
+            .accessibilityIdentifier("enableButton")
+            
+            Button { context.send(viewAction: .disable) } label: {
+                Text(ElementL10n.actionNotNow)
+                    .font(.element.bodySB)
+                    .padding(12)
+            }
+            .accessibilityIdentifier("disableButton")
+        }
+    }
+}
+
+// MARK: - Previews
+
+struct AnalyticsPrompt_Previews: PreviewProvider {
+    static let viewModel = AnalyticsPromptViewModel(termsURL: BuildSettings.analyticsConfiguration.termsURL)
+    static var previews: some View {
+        AnalyticsPrompt(context: viewModel.context)
+            .tint(.element.accent)
+    }
+}
@@ -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
+
+struct AnalyticsPromptCheckmarkItem: View {
+    // MARK: - Properties
+    
+    // MARK: Private
+    
+    private let attributedString: AttributedString
+    
+    // MARK: - Setup
+    
+    init(attributedString: AttributedString) {
+        self.attributedString = attributedString
+    }
+    
+    init(string: String) {
+        attributedString = AttributedString(string)
+    }
+    
+    // MARK: - Views
+    
+    var body: some View {
+        Label { Text(attributedString) } icon: {
+            Image(uiImage: Asset.Images.analyticsCheckmark.image)
+                .foregroundColor(.element.accent)
+        }
+    }
+}
+
+// MARK: - Previews
+
+struct AnalyticsPromptCheckmarkItem_Previews: PreviewProvider {
+    static let strings = AnalyticsPromptStrings()
+    
+    static var previews: some View {
+        VStack(alignment: .leading) {
+            AnalyticsPromptCheckmarkItem(attributedString: strings.point1)
+            AnalyticsPromptCheckmarkItem(attributedString: strings.point2)
+            AnalyticsPromptCheckmarkItem(attributedString: AttributedString("This is a short string."))
+            AnalyticsPromptCheckmarkItem(attributedString: AttributedString("This is a very long string that will be used to test the layout over multiple lines of text to ensure everything is correct."))
+        }
+        .padding()
+    }
+}