Paywalls: rename card to footer (#3049)

Rename "card" to "footer" to because that is how we expect developers to use the current implementation of the non-fullscreen modes as a footer to their custom paywalls. - Renamed `card` to `footer` - Renamed `condensedCard` to `condensedFooter` --------- Co-authored-by: NachoSoto <ignaciosoto90@gmail.com>
RevenueCat · Aug 31, 2023 · de2e1ed · de2e1ed
1 parent 5b92c64
commit de2e1ed
Show file tree

Hide file tree

Showing 19 changed files with 91 additions and 91 deletions.
diff --git a/RevenueCatUI/Data/PaywallViewMode+Extensions.swift b/RevenueCatUI/Data/PaywallViewMode+Extensions.swift
@@ -12,37 +12,37 @@ extension PaywallViewMode {
     var displayAllPlansByDefault: Bool {
         switch self {
         case .fullScreen: return true
-        case .card: return true
-        case .condensedCard: return false
+        case .footer: return true
+        case .condensedFooter: return false
         }
     }
 
     var displayAllPlansButton: Bool {
         switch self {
         case .fullScreen: return false
-        case .card: return false
-        case .condensedCard: return true
+        case .footer: return false
+        case .condensedFooter: return true
         }
     }
 
     var shouldDisplayIcon: Bool {
         switch self {
         case .fullScreen: return true
-        case .card, .condensedCard: return false
+        case .footer, .condensedFooter: return false
         }
     }
 
     var shouldDisplayText: Bool {
         switch self {
         case .fullScreen: return true
-        case .card, .condensedCard: return false
+        case .footer, .condensedFooter: return false
         }
     }
 
     var shouldDisplayFeatures: Bool {
         switch self {
         case .fullScreen: return true
-        case .card, .condensedCard: return false
+        case .footer, .condensedFooter: return false
         }
     }
 

diff --git a/RevenueCatUI/Helpers/PreviewHelpers.swift b/RevenueCatUI/Helpers/PreviewHelpers.swift
@@ -112,8 +112,8 @@ private extension PaywallViewMode {
     var layout: PreviewLayout {
         switch self {
         case .fullScreen: return .device
-        case .card: return .fixed(width: 400, height: 280)
-        case .condensedCard: return .fixed(width: 400, height: 150)
+        case .footer: return .fixed(width: 400, height: 280)
+        case .condensedFooter: return .fixed(width: 400, height: 150)
         }
     }
 

diff --git a/...eCatUI/Modifiers/CardHidingModifier.swift → ...atUI/Modifiers/FooterHidingModifier.swift b/...eCatUI/Modifiers/CardHidingModifier.swift → ...atUI/Modifiers/FooterHidingModifier.swift
@@ -1,5 +1,5 @@
 //
-//  CardHidingModifier.swift
+//  FooterHidingModifier.swift
 //
 //
 //  Created by Nacho Soto on 8/9/23.
@@ -11,20 +11,20 @@ import SwiftUI
 @available(iOS 15.0, macOS 12.0, tvOS 15.0, *)
 extension View {
 
-    func hideCardContent(
+    func hideFooterContent(
         _ configuration: TemplateViewConfiguration,
         hide: Bool,
         offset: CGFloat
     ) -> some View {
-        return self.modifier(CardHidingModifier(configuration: configuration,
-                                                hide: hide,
-                                                offset: offset))
+        return self.modifier(FooterHidingModifier(configuration: configuration,
+                                                  hide: hide,
+                                                  offset: offset))
     }
 
 }
 
 @available(iOS 15.0, macOS 12.0, tvOS 15.0, *)
-private struct CardHidingModifier: ViewModifier {
+private struct FooterHidingModifier: ViewModifier {
 
     @State
     private var height: CGFloat = 10
@@ -35,12 +35,12 @@ private struct CardHidingModifier: ViewModifier {
 
     func body(content: Content) -> some View {
         switch self.configuration.mode {
-        case .fullScreen, .card:
+        case .fullScreen, .footer:
             // These modes don't support hiding the content
             content
                 .padding(.vertical)
 
-        case .condensedCard:
+        case .condensedFooter:
             // "Hidden view" so it doesn't contribute to size calculation
             Rectangle()
                 .frame(height: VersionDetector.iOS15 ? 1 : 0) // Note: height "0" breaks iOS 15

diff --git a/RevenueCatUI/PaywallView.swift b/RevenueCatUI/PaywallView.swift
@@ -206,7 +206,7 @@ struct LoadedOfferingPaywallView: View {
         case .fullScreen:
             view
 
-        case .card, .condensedCard:
+        case .footer, .condensedFooter:
             view
                 .fixedSize(horizontal: false, vertical: true)
                 .edgesIgnoringSafeArea(.bottom)
@@ -264,7 +264,7 @@ private extension PaywallViewMode {
     var layout: PreviewLayout {
         switch self {
         case .fullScreen: return .device
-        case .card, .condensedCard: return .sizeThatFits
+        case .footer, .condensedFooter: return .sizeThatFits
         }
     }
 

diff --git a/RevenueCatUI/Templates/Template2View.swift b/RevenueCatUI/Templates/Template2View.swift
@@ -89,9 +89,9 @@ struct Template2View: TemplateViewType {
             } else {
                 self.packages
                     .onSizeChange(.vertical) { if $0 > 0 { self.containerHeight = $0 } }
-                    .hideCardContent(self.configuration,
-                                     hide: !self.displayingAllPlans,
-                                     offset: self.containerHeight)
+                    .hideFooterContent(self.configuration,
+                                       hide: !self.displayingAllPlans,
+                                       offset: self.containerHeight)
             }
         }
         .frame(maxHeight: .infinity)
@@ -266,14 +266,14 @@ private extension PaywallViewMode {
     var shouldDisplayPackages: Bool {
         switch self {
         case .fullScreen: return true
-        case .card, .condensedCard: return false
+        case .footer, .condensedFooter: return false
         }
     }
 
     var shouldDisplayInlineOfferDetails: Bool {
         switch self {
         case .fullScreen: return false
-        case .card, .condensedCard: return true
+        case .footer, .condensedFooter: return true
         }
     }
 

diff --git a/RevenueCatUI/Templates/Template4View.swift b/RevenueCatUI/Templates/Template4View.swift
@@ -44,7 +44,7 @@ struct Template4View: TemplateViewType {
             ZStack(alignment: .bottom) {
                 TemplateBackgroundImageView(configuration: self.configuration)
 
-                self.cardContent
+                self.footerContent
                     .edgesIgnoringSafeArea(.bottom)
                     .frame(maxWidth: .infinity, alignment: .bottom)
                     .background(self.configuration.colors.backgroundColor)
@@ -55,13 +55,13 @@ struct Template4View: TemplateViewType {
                     #endif
             }
 
-        case .card, .condensedCard:
-            self.cardContent
+        case .footer, .condensedFooter:
+            self.footerContent
         }
     }
 
     @ViewBuilder
-    var cardContent: some View {
+    var footerContent: some View {
         VStack(spacing: Self.verticalPadding) {
             if self.configuration.mode.shouldDisplayText {
                 Text(.init(self.selectedPackage.localization.title))
@@ -75,9 +75,9 @@ struct Template4View: TemplateViewType {
                 self.packagesScrollView
             } else {
                 self.packagesScrollView
-                    .hideCardContent(self.configuration,
-                                     hide: !self.displayingAllPlans,
-                                     offset: self.packageContentHeight)
+                    .hideFooterContent(self.configuration,
+                                       hide: !self.displayingAllPlans,
+                                       offset: self.packageContentHeight)
             }
 
             IntroEligibilityStateView(
@@ -342,7 +342,7 @@ private extension PaywallViewMode {
     var shouldDisplayPackages: Bool {
         switch self {
         case .fullScreen: return true
-        case .card, .condensedCard: return false
+        case .footer, .condensedFooter: return false
         }
     }
 

diff --git a/RevenueCatUI/Templates/TemplateViewType.swift b/RevenueCatUI/Templates/TemplateViewType.swift
@@ -133,7 +133,7 @@ extension TemplateViewConfiguration {
         switch self.mode {
         case .fullScreen:
             self.backgroundContent
-        case .card, .condensedCard:
+        case .footer, .condensedFooter:
             self.backgroundContent
             #if canImport(UIKit)
                 .roundedCorner(

diff --git a/RevenueCatUI/Views/PurchaseButton.swift b/RevenueCatUI/Views/PurchaseButton.swift
@@ -99,26 +99,26 @@ private extension PaywallViewMode {
 
     var buttonFont: Font.TextStyle {
         switch self {
-        case .fullScreen, .card, .condensedCard: return .title3
+        case .fullScreen, .footer, .condensedFooter: return .title3
         }
     }
 
     var fullWidthButton: Bool {
         switch self {
-        case .fullScreen, .card, .condensedCard: return true
+        case .fullScreen, .footer, .condensedFooter: return true
         }
     }
 
     @available(tvOS, unavailable)
     var buttonSize: ControlSize {
         switch self {
-        case .fullScreen, .card, .condensedCard: return .large
+        case .fullScreen, .footer, .condensedFooter: return .large
         }
     }
 
     var buttonBorderShape: ButtonBorderShape {
         switch self {
-        case .fullScreen, .card, .condensedCard:
+        case .fullScreen, .footer, .condensedFooter:
             #if os(macOS) || os(tvOS)
             return .roundedRectangle
             #else

diff --git a/RevenueCatUI/Views/TemplateBackgroundImageView.swift b/RevenueCatUI/Views/TemplateBackgroundImageView.swift
@@ -41,7 +41,7 @@ private extension PaywallViewMode {
     var shouldDisplayBackground: Bool {
         switch self {
         case .fullScreen: return true
-        case .card, .condensedCard: return false
+        case .footer, .condensedFooter: return false
         }
     }
 

diff --git a/Sources/Paywalls/PaywallViewMode.swift b/Sources/Paywalls/PaywallViewMode.swift
@@ -21,11 +21,11 @@ public enum PaywallViewMode {
 
     /// Paywall can be displayed as an overlay on top of your own content.
     /// Multi-package templates will display the package selection.
-    case card
+    case footer
 
     /// Paywall can be displayed as an overlay on top of your own content.
     /// Multi-package templates will include a button to make the package selection visible.
-    case condensedCard
+    case condensedFooter
 
     /// The default ``PaywallViewMode``: ``PaywallViewMode/fullScreen``.
     public static let `default`: Self = .fullScreen
@@ -38,7 +38,7 @@ extension PaywallViewMode {
     public var isFullScreen: Bool {
         switch self {
         case .fullScreen: return true
-        case .card, .condensedCard: return false
+        case .footer, .condensedFooter: return false
         }
     }
 
@@ -49,8 +49,8 @@ extension PaywallViewMode {
     var identifier: String {
         switch self {
         case .fullScreen: return "full_screen"
-        case .card: return "card"
-        case .condensedCard: return "condensed_card"
+        case .footer: return "footer"
+        case .condensedFooter: return "condensed_footer"
         }
     }
 

diff --git a/Tests/APITesters/SwiftAPITester/SwiftAPITester/PaywallAPI.swift b/Tests/APITesters/SwiftAPITester/SwiftAPITester/PaywallAPI.swift
@@ -147,9 +147,9 @@ func checkPaywallViewMode(_ mode: PaywallViewMode) {
     switch mode {
     case .fullScreen:
         break
-    case .card:
+    case .footer:
         break
-    case .condensedCard:
+    case .condensedFooter:
         break
     @unknown default:
         break

diff --git a/Tests/RevenueCatUITests/BaseSnapshotTest.swift b/Tests/RevenueCatUITests/BaseSnapshotTest.swift
@@ -31,7 +31,7 @@ extension BaseSnapshotTest {
     static let fonts: PaywallFontProvider = CustomPaywallFontProvider(fontName: "Papyrus")
 
     static let fullScreenSize: CGSize = .init(width: 460, height: 950)
-    static let cardSize: CGSize = .init(width: 460, height: 460)
+    static let footerSize: CGSize = .init(width: 460, height: 460)
 
 }
 

diff --git a/Tests/RevenueCatUITests/Templates/OtherPaywallViewTests.swift b/Tests/RevenueCatUITests/Templates/OtherPaywallViewTests.swift
@@ -37,14 +37,14 @@ class OtherPaywallViewTests: BaseSnapshotTest {
             .snapshot(size: Self.fullScreenSize)
     }
 
-    func testLoadingCardPaywallView() {
-        LoadingPaywallView(mode: .card)
-            .snapshot(size: Self.cardSize)
+    func testLoadingFooterPaywallView() {
+        LoadingPaywallView(mode: .footer)
+            .snapshot(size: Self.footerSize)
     }
 
-    func testLoadingCondensedCardPaywallView() {
-        LoadingPaywallView(mode: .condensedCard)
-            .snapshot(size: Self.cardSize)
+    func testLoadingCondensedFooterPaywallView() {
+        LoadingPaywallView(mode: .condensedFooter)
+            .snapshot(size: Self.footerSize)
     }
 
 }

diff --git a/Tests/RevenueCatUITests/Templates/Template1ViewTests.swift b/Tests/RevenueCatUITests/Templates/Template1ViewTests.swift
@@ -24,20 +24,20 @@ class Template1ViewTests: BaseSnapshotTest {
         .snapshot(size: Self.fullScreenSize)
     }
 
-    func testCardPaywall() {
+    func testFooterPaywall() {
         PaywallView(offering: Self.offeringWithNoIntroOffer,
-                    mode: .card,
+                    mode: .footer,
                     introEligibility: Self.eligibleChecker,
                     purchaseHandler: Self.purchaseHandler)
-        .snapshot(size: Self.cardSize)
+        .snapshot(size: Self.footerSize)
     }
 
-    func testCondensedCardPaywall() {
+    func testCondensedFooterPaywall() {
         PaywallView(offering: Self.offeringWithNoIntroOffer,
-                    mode: .condensedCard,
+                    mode: .condensedFooter,
                     introEligibility: Self.eligibleChecker,
                     purchaseHandler: Self.purchaseHandler)
-        .snapshot(size: Self.cardSize)
+        .snapshot(size: Self.footerSize)
     }
 
     func testSamplePaywallWithIntroOffer() {

diff --git a/Tests/RevenueCatUITests/Templates/Template2ViewTests.swift b/Tests/RevenueCatUITests/Templates/Template2ViewTests.swift
@@ -23,20 +23,20 @@ class Template2ViewTests: BaseSnapshotTest {
         .snapshot(size: Self.fullScreenSize)
     }
 
-    func testCardPaywall() {
+    func testFooterPaywall() {
         PaywallView(offering: Self.offering.withLocalImages,
-                    mode: .card,
+                    mode: .footer,
                     introEligibility: Self.eligibleChecker,
                     purchaseHandler: Self.purchaseHandler)
-        .snapshot(size: Self.cardSize)
+        .snapshot(size: Self.footerSize)
     }
 
-    func testCondensedCardPaywall() {
+    func testCondensedFooterPaywall() {
         PaywallView(offering: Self.offering.withLocalImages,
-                    mode: .condensedCard,
+                    mode: .condensedFooter,
                     introEligibility: Self.eligibleChecker,
                     purchaseHandler: Self.purchaseHandler)
-        .snapshot(size: Self.cardSize)
+        .snapshot(size: Self.footerSize)
     }
 
     func testPurchasingState() {