Convergence asset update #282

squarepaul · 2025-02-26T17:13:03Z

Summary of Changes

Introduces the concept of a migrated Brand to CashAppAfterpay using isCashAppAfterpayRegion
Creates a new set of ColorPalettes and maps the existing and new color configurations to them
Creates a new set of assets for both Mono and Poly chrome to match for a new enCashAppAfterpay locale
Logic to fail if a merchant in a migrated regions tries to use a badge or compact-badge (lockups only)
Logic to use the right color scheme and asset dependent on if in the migrated region or not
Default everything to "default" scheme
https://docs.google.com/document/d/1SZYkcTyi5Y5NyclJJu6wHWEZAT6oHFyGZVgX5MhhTI8/edit?tab=t.0

Items of Note

Submission Checklist

Tests are included.
Documentation is changed or added.

squarepaul · 2025-02-27T14:55:03Z

Legacy Views:

squarepaul · 2025-02-27T14:55:39Z

CashAppAfterpay Branding:

mmroz

Couple of thoughts:

If we go with this approach to silently swap views then we will need to communicate these changes to avoid merchant confusion
This changes public API so it will be a breaking change. Have we considered a non-breaking approach and deprecating then removing no longer supported views?

mmroz · 2025-02-27T16:24:46Z

Sources/Afterpay/Resources/ColorScheme.swift

 public enum ColorPalette {
-  case blackOnMint
-  case mintOnBlack
-  case whiteOnBlack
-  case blackOnWhite


Is this a breaking change?

yes but that was intentional to get the US merchants to update the UI since it is new. Also we're not marketing non-US partners to update but we should have good documentation on how the new values map to the old ones just in case they do end up updating for some reason

mmroz · 2025-02-27T16:26:33Z

...ssets.xcassets/images/lockupv2/lockup-cashappafterpay-lightMono.imageset/monochromeLight.svg

Every other asset is a PNG, is there a reason we are moving to SVG?

SVG is better for static images like logos since it scales better, but tbh I didn't think it would make a difference and wanted to use the same assets as Android, was there a reason why PNG or PDF was used before?

mmroz · 2025-02-27T16:29:46Z

Sources/Afterpay/Views/LayeredImageView.swift

+    foregroundImageView.tintColor = color.foreground
+  }
+
+  private func resolveColorScheme(palette: ColorPalette?) -> (foreground: UIColor?, background: UIColor?) {


Does palette need to be optional here?

mmroz · 2025-02-27T16:30:43Z

Sources/Afterpay/Views/LockupView.swift

+    if Afterpay.isCashAppAfterpayRegion {
+      var color = colorScheme.lightPalette.foregroundCashAppAfterpay
+      if traitCollection.userInterfaceStyle == .dark {
+        color = colorScheme.darkPalette.foregroundCashAppAfterpay
+      }
+      return color
+    }


Maybe this can be cleaned up with a guard?

mmroz · 2025-02-27T16:39:21Z

Sources/Afterpay/Afterpay.swift

@@ -416,6 +416,10 @@ internal var brand: Brand {
  Brand.forLocale(locale: getLocale())
 }

+public var isCashAppAfterpayRegion: Bool {
+  Brand.forLocale(locale: getLocale()).isCashAppAfterpayRegion


I'm not completely sure but you might want to double check that getLocale() works with getV3Configuration

I think it's ok? it looks like the v3 endpoint ends up calling setConfiguration which is required to have a locale.

Also that same exact code is used in several other places:

https://github.com/afterpay/sdk-ios/blob/master/Sources/Afterpay/Views/LogoView.swift#L68

https://github.com/afterpay/sdk-ios/blob/master/Sources/Afterpay/Afterpay.swift#L416

I've updated to just use the brand computed property

I think this is ok here - correct me if I'm wrong @mmroz, but my understanding is that for any of the assets to work anyway the Brand needs to be set which is done by having a locale set through via setConfiguration. Configuration also contains things like min/max amounts for SDK consumers so that they can show the Pay with ${brand} messaging.

So I believe if consumers of the SDK want to use v3 + the assets, they need to set Configuration and CheckoutV3Configuration.

squarepaul · 2025-02-27T20:39:38Z

Couple of thoughts:

If we go with this approach to silently swap views then we will need to communicate these changes to avoid merchant confusion
If the merchant updates it wouldn't silently swap but the API would break and it would force them to select the UI assets that make sense for them, which is the behavior that we want since the assets are markedly different from the legacy ones. There is one scenario where a non-US user updates and they would need documentation to see how the new values map to the old ones which we're working on.

This changes public API so it will be a breaking change. Have we considered a non-breaking approach and deprecating then removing no longer supported views?
We can't deprecate the old ones since they are still being used in certain regions. I do think we need to think about how to re-structure the selection and treatment of UI since now there are many dimensions that go into that decisioning

alanjzhang · 2025-02-27T21:40:18Z

Example/Example/Purchase/CartViewController.swift

@@ -70,7 +70,7 @@ final class CartViewController: UIViewController, UITableViewDataSource {

    if Afterpay.enabled {
      let payButton: UIButton = PaymentButton(
-        colorScheme: .dynamic(lightPalette: .blackOnMint, darkPalette: .mintOnBlack),
+        colorScheme: .dynamic(lightPalette: .default, darkPalette: .lightMono),


did you mean to change the colors here? i thought the updated mappings were:
.blackOnMint → .alt
.mintOnBlack → .default

yea that's true, I'm actually going to overhaul this entire view to include more permutations and ability to select region

alanjzhang · 2025-02-27T21:44:26Z

Sources/Afterpay/Resources/Drawables.swift

@@ -12,7 +12,7 @@ private let localeLanguages: [Locale: Drawables] = [
  Locales.enAU: .enAfterpay,
  Locales.enGB: .enClearpay,
  Locales.enNZ: .enAfterpay,
-  Locales.enUS: .enAfterpay,
+  Locales.enUS: .enCashAppAfterpay,
  Locales.enUSposix: .enAfterpay,


should Locales.enUSposix be changed to .enCashAppAfterpay too, since it's now a Cash App Afterpay locale according to Brand.swift?

Yes, thank you for the catch!

alanjzhang · 2025-02-27T21:48:28Z

Sources/Afterpay/Views/BadgeView.swift

-  override public init(colorScheme: ColorScheme = .static(.blackOnMint)) {
+  override public init(colorScheme: ColorScheme = .static(.default)) {
+    if Afterpay.isCashAppAfterpayRegion {
+      assertionFailure("Cash App Afterpay badge is not supported")


what's the context behind not supporting BadgeView and CompactBadgeView? what happens if a merchant was previously using them in a Cash App Afterpay region?

It would crash, which is what we would want since there are no assets associated with them in the CashAppAfterpay branding. We should include in the documentation to use the Lockup assets

add resources

0983f1a

squarepaul requested review from benfterpay and ScottAntonacAP as code owners February 26, 2025 17:13

squarepaul requested a review from mmroz February 26, 2025 17:40

squarepaul requested a review from alanjzhang February 27, 2025 14:55

mmroz reviewed Feb 27, 2025

View reviewed changes

squarepaul force-pushed the convergence-asset-update branch from 59030fa to 7663874 Compare February 27, 2025 20:09

squarepaul requested a review from mmroz February 27, 2025 20:22

update to convergance branding for US_en

dfe6f3b

squarepaul force-pushed the convergence-asset-update branch from 7663874 to dfe6f3b Compare February 27, 2025 20:34

mmroz approved these changes Feb 27, 2025

View reviewed changes

squarepaul merged commit 7c26aca into master Feb 27, 2025
3 checks passed

squarepaul deleted the convergence-asset-update branch February 27, 2025 21:43

alanjzhang reviewed Feb 27, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Convergence asset update #282

Convergence asset update #282

squarepaul commented Feb 26, 2025 •

edited

Loading

squarepaul commented Feb 27, 2025

squarepaul commented Feb 27, 2025

mmroz left a comment

mmroz Feb 27, 2025

squarepaul Feb 27, 2025

mmroz Feb 27, 2025

squarepaul Feb 27, 2025

mmroz Feb 27, 2025

mmroz Feb 27, 2025

mmroz Feb 27, 2025

squarepaul Feb 27, 2025

ScottAntonacAP Feb 27, 2025

squarepaul commented Feb 27, 2025

alanjzhang Feb 27, 2025

squarepaul Feb 27, 2025

alanjzhang Feb 27, 2025

squarepaul Feb 27, 2025

alanjzhang Feb 27, 2025

squarepaul Feb 27, 2025

Convergence asset update #282

Convergence asset update #282

Conversation

squarepaul commented Feb 26, 2025 • edited Loading

Summary of Changes

Items of Note

Submission Checklist

squarepaul commented Feb 27, 2025

squarepaul commented Feb 27, 2025

mmroz left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

squarepaul commented Feb 27, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

squarepaul commented Feb 26, 2025 •

edited

Loading