Paywalls: Support custom fonts through FontProvider by tonidero · Pull Request #1328 · RevenueCat/purchases-android

tonidero · 2023-10-10T07:50:42Z

Description

This adds a way for devs to give us a FontProvider, which will be used to override the font family in our views when a font family is provided. If it's not provided, the current material3 theme's font will be used.

tonidero · 2023-10-10T07:51:59Z

Unfortunately, we can't use this for the PaywallActivity wrapper, since FontFamily is not parcelable. This will only work when launching the paywall through compose.

Maybe add a comment mentioning that, and referencing FontResourceProvider?

tonidero · 2023-10-10T07:52:41Z

Android doesn't expose the text styles in the typography, so we are forced to mimick them with a new enum.

codecov · 2023-10-10T08:43:43Z

Codecov Report

All modified lines are covered by tests ✅

Comparison is base (1ca3aff) 84.53% compared to head (d1d3842) 84.54%.

❗ Current head d1d3842 differs from pull request most recent head d83c25b. Consider uploading reports for the commit d83c25b to get more accurate results

Additional details and impacted files

@@            Coverage Diff            @@
##           paywalls    #1328   +/-   ##
=========================================
  Coverage     84.53%   84.54%           
=========================================
  Files           194      194           
  Lines          6538     6535    -3     
  Branches        952      950    -2     
=========================================
- Hits           5527     5525    -2     
  Misses          643      643           
+ Partials        368      367    -1

see 1 file with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

tonidero · 2023-10-10T08:51:44Z

Since FontFamily is not parcelizable/serializable, we can't pass it to the PaywallActivity so we can't use FontProvider. Instead, I'm adding this that will allow to set the font as long as it's bundled. It will not work for downloaded fonts though, but I was thinking we can add support for that later if needed.

I'm slightly concerned about confusion between this and FontProvider... But since FontProvider can only be used through composables and this FontResourceProvider can only be used for the activities I think it should be ok?

NachoSoto · 2023-10-10T16:08:57Z

I just realized that we need to handle this. Just made a Linear

NachoSoto

This approach makes sense to me 👍🏻

NachoSoto · 2023-10-10T16:11:29Z

NachoSoto · 2023-10-10T16:12:06Z

Maybe add a comment mentioning that, and referencing FontResourceProvider?

NachoSoto · 2023-10-10T16:12:17Z

These names are very clear 👍🏻

NachoSoto

This is great!

What do you think about adding examples of these in PaywallsScreen with a custom font?

NachoSoto · 2023-10-16T16:13:21Z

NachoSoto · 2023-10-16T16:14:37Z

Nit: maybe extract this to be an extension method on Typography that takes a fontProvider?

tonidero · 2023-10-17T07:33:39Z

What do you think about adding examples of these in PaywallsScreen with a custom font?

I have some in #1325 but will make a new PR with some actual sample usage 👍

…1338) ### Description Followup to #1328 This PR adds support for Google fonts when launching the paywall as an activity and modifies the API to better support both these and bundled fonts and font families with multiple fonts.

### Description This adds a way for devs to give us a `FontProvider`, which will be used to override the font family in our views when a font family is provided. If it's not provided, the current material3 theme's font will be used.

…1338) ### Description Followup to #1328 This PR adds support for Google fonts when launching the paywall as an activity and modifies the API to better support both these and bundled fonts and font families with multiple fonts.

@tonidero

### New Features #### ✨📱 Introducing Android Paywalls 🐾🧱 RevenueCat's Paywalls allow you to remotely configure your entire paywall view without any code changes or app updates. Our paywall templates use native code to deliver smooth, intuitive experiences to your customers when you’re ready to deliver them an Offering; and you can use our Dashboard to pick the right template and configuration to meet your needs. To use RevenueCat Paywalls on Android, simply: 1. Create a Paywall on the Dashboard for the `Offering` you intend to serve to your customers 2. Add the `RevenueCatUI` dependency to your project: ```groovy build.gradle implementation 'com.revenuecat.purchases:purchases:7.1.0' implementation 'com.revenuecat.purchases:purchases-ui:7.1.0' ``` 3. Display a paywall: ```kotlin @OptIn(ExperimentalPreviewRevenueCatUIPurchasesAPI::class) @composable private fun LockedScreen() { YourContent() PaywallDialog( PaywallDialogOptions.Builder() .setRequiredEntitlementIdentifier(Constants.ENTITLEMENT_ID) .build() ) } ``` > **Note** > Android paywalls is currently behind an experimental flag: `ExperimentalPreviewRevenueCatUIPurchasesAPI`. > It is safe to release app updates with it. We guarantee that paywalls will continue to work and any changes will always be backwards compatible. > They are stable, but migration steps may be required in the future. We'll do our best to minimize any changes you have to make. You can find more information in [our documentation](https://rev.cat/paywalls). <details> <summary>List of changes</summary> * `Paywalls`: Improve PaywallDialog look on tablets (#1419) via Toni Rico (@tonidero) * `Paywalls`: disallow Markdown links in PurchaseButton (#1421) via NachoSoto (@NachoSoto) * `Paywalls`: implemented template 5 (#1412) via NachoSoto (@NachoSoto) * `Paywalls`: Fix wrong view model data after configuration changes (#1417) via Toni Rico (@tonidero) * `Paywalls`: update template 4 colors (#1410) via NachoSoto (@NachoSoto) * `Paywalls`: Add bundled font to paywall tester (#1415) via Toni Rico (@tonidero) * `Paywalls`: Fix purchase button text flashing when changing selected package (#1416) via Toni Rico (@tonidero) * `Paywalls`: support text3 and accent3 colors (#1409) via NachoSoto (@NachoSoto) * `Paywalls`: PaywallData errors shouldn't make Offerings fail to decode (#1402) via NachoSoto (@NachoSoto) * `Paywalls`: convert empty strings to null via NachoSoto (@NachoSoto) * `Paywalls`: footer view should not render background image via NachoSoto (@NachoSoto) * `Paywalls`: improve template 4 A11y support via NachoSoto (@NachoSoto) * `Paywalls`: Add close button option (#1390) via Toni Rico (@tonidero) * `Paywalls`: fix MarkdownText stealing touches from package buttons (#1411) via NachoSoto (@NachoSoto) * Fix onDismiss getting called twice in PaywallDialogs (#1408) via Cesar de la Vega (@vegaro) * `Paywalls`: ignore URL deserialization errors (#1399) via NachoSoto (@NachoSoto) * Animate transition between loading and loaded paywall (#1404) via Cesar de la Vega (@vegaro) * Fix button padding in Loading paywall (#1405) via Cesar de la Vega (@vegaro) * Add test for `packageInfo.localizedDiscount` (#1407) via Cesar de la Vega (@vegaro) * `Paywalls`: RemoteImage always renders a placeholder on previews via NachoSoto (@NachoSoto) * `Paywalls`: decode empty images as null via NachoSoto (@NachoSoto) * `Paywalls`: Allow trigger manual paywall tester release (#1406) via Toni Rico (@tonidero) * Fix navigation after closing paywall in Paywalls screen (#1403) via Cesar de la Vega (@vegaro) * `Paywalls`: Add experimental annotation to all public APIs in RevenueCat UI (#1400) via Toni Rico (@tonidero) * `Paywalls`: improve template 2 layout (#1396) via NachoSoto (@NachoSoto) * `Paywalls`: template 4 (#1349) via NachoSoto (@NachoSoto) * `Paywalls`: fix template 3 offer details color (#1394) via NachoSoto (@NachoSoto) * `Paywalls`: PaywallDialogOptions no longer requires dismissRequest (#1386) via NachoSoto (@NachoSoto) * `Paywalls`: fixed accessibility across templates (#1392) via NachoSoto (@NachoSoto) * `Paywalls`: increase PaywallBackground blur radius to match iOS via NachoSoto (@NachoSoto) * `Paywalls`: use LocalUriHandler for opening links (#1388) via NachoSoto (@NachoSoto) * `Paywalls`: support for Markdown links (#1387) via NachoSoto (@NachoSoto) * `Paywalls`: display purchase/restore errors (#1384) via NachoSoto (@NachoSoto) * `Paywalls`: improve error handling (#1383) via NachoSoto (@NachoSoto) * `Paywalls`: fixed incorrect background on footer (#1382) via NachoSoto (@NachoSoto) * `Paywalls`: fix backwards-compatible blurring of default paywall background (#1380) via NachoSoto (@NachoSoto) * `Paywalls`: polish template 2 spacing (#1381) via NachoSoto (@NachoSoto) * `Paywalls`: optimize backwards compatible blurring (#1379) via NachoSoto (@NachoSoto) * `Paywalls`: Predownload offering images if paywalls sdk exists (#1372) via Toni Rico (@tonidero) * `Paywalls`: PurchaseButton supports gradients (#1378) via NachoSoto (@NachoSoto) * `Paywalls`: optimize AdaptiveComposable (#1377) via NachoSoto (@NachoSoto) * `Paywalls`: improve FooterDialog corner radius (#1374) via NachoSoto (@NachoSoto) * `Paywalls`: optimize PurchaseButton (#1376) via NachoSoto (@NachoSoto) * `Paywalls`: Enable footer modes in paywall tester paywalls tab (#1368) via Toni Rico (@tonidero) * `Paywalls`: Support footer in template 3 (#1367) via Toni Rico (@tonidero) * `Paywalls`: calculate discountRelativeToMostExpensivePerMonth (#1370) via NachoSoto (@NachoSoto) * `Paywalls`: Add offer details in template 2 when in condensed form (#1371) via Toni Rico (@tonidero) * `Paywalls`: improve handling of lifetime/custom packages (#1363) via NachoSoto (@NachoSoto) * `Paywalls`: Support footer in template 1 (#1366) via Toni Rico (@tonidero) * Add `StoreProduct.pricePerMonth` (#1369) via NachoSoto (@NachoSoto) * `Paywalls`: Support condensed footer presentation in template 2 (#1365) via Toni Rico (@tonidero) * `Paywalls`: finished localization support (#1362) via NachoSoto (@NachoSoto) * `Paywalls`: backwards compatible blurring (#1327) via Andy Boedo (@AndyBoedo) * `Paywalls`: PaywallViewModel tests (#1357) via NachoSoto (@NachoSoto) * `Paywalls`: improve LoadingPaywall (#1364) via NachoSoto (@NachoSoto) * `Paywalls`: Fix paywall compose previews (#1360) via Toni Rico (@tonidero) * `Paywalls`: Fix proguard rules kotlinx serialization (#1356) via Toni Rico (@tonidero) * `Paywalls`: Add custom font example to paywalls screen (#1358) via Toni Rico (@tonidero) * `Paywalls`: Support Google fonts and font families with multiple fonts (#1338) via Toni Rico (@tonidero) * `Paywalls`: Support custom fonts through FontProvider (#1328) via Toni Rico (@tonidero) * `Paywalls`: fixed Footer padding (#1354) via NachoSoto (@NachoSoto) * `Paywalls`: Rename PaywallView to Paywall (#1351) via Toni Rico (@tonidero) * `Paywalls`: disable PurchaseButton during purchases (#1352) via NachoSoto (@NachoSoto) * `Paywalls`: enable library publishing (#1353) via NachoSoto (@NachoSoto) * `Paywalls`: handle "action in progress" state (#1346) via NachoSoto (@NachoSoto) * `Paywalls`: support {{ sub_duration_in_months }} (#1348) via NachoSoto (@NachoSoto) * `Paywalls`: disallow purchasing currently subscribed products (#1334) via NachoSoto (@NachoSoto) * `Paywalls`: new PaywallActivityLauncher.launchIfNeeded methods (#1335) via NachoSoto (@NachoSoto) * `Paywalls`: PaywallColor supports RGBA (#1332) via NachoSoto (@NachoSoto) * `Paywalls`: Make DialogScaffold private (#1329) via Toni Rico (@tonidero) * Add `revenuecatui` `gradle.properties` to specify name of dependency (#1324) via Toni Rico (@tonidero) * `Paywalls`: log error when failing to load images (#1321) via NachoSoto (@NachoSoto) * Log errors when displaying default paywall (#1318) via Cesar de la Vega (@vegaro) * Rename packages to packageIds in `PaywallData` (#1309) via Cesar de la Vega (@vegaro) * Add support for multiple intro offers in `IntroEligibilityStateView` (#1319) via Cesar de la Vega (@vegaro) * Fix material theme references to use Material3 versions (#1326) via Toni Rico (@tonidero) * `Paywalls`: Add support to launch paywall as activity (#1317) via Toni Rico (@tonidero) * Parse `{{ sub_offer_price_2 }}` and `{{ sub_offer_duration_2 }}` variables (#1313) via Cesar de la Vega (@vegaro) * `Paywalls`: changed PaywallsTester app icon (#1323) via NachoSoto (@NachoSoto) * `Paywalls`: fixed PaywallDialog.setRequiredEntitlementIdentifier (#1322) via NachoSoto (@NachoSoto) * `Paywalls`: Markdown support (#1312) via NachoSoto (@NachoSoto) * `PaywallsTester`: added template name to offerings list (#1316) via NachoSoto (@NachoSoto) * `Paywalls`: Update paywall tester to be able to display paywall footer (#1315) via Toni Rico (@tonidero) * `Paywalls`: Add PaywallFooter composable to present a minified paywall UI that allows for custom paywalls (#1314) via Toni Rico (@tonidero) * `Paywalls`: use IntroEligibilityStateView (#1311) via NachoSoto (@NachoSoto) * `PaywallData` validation tests (#1310) via Cesar de la Vega (@vegaro) * `Paywalls`: implemented LoadingPaywallView with placeholder (#1284) via NachoSoto (@NachoSoto) * `Paywalls`: created LoadingPaywallView (#1282) via NachoSoto (@NachoSoto) * Fix template test data (#1308) via Cesar de la Vega (@vegaro) </details> ### Other Changes Add `purchases.setOnesignalUserID` (#1304) via Raquel Diez (@Raquel10-RevenueCat) --------- Co-authored-by: revenuecat-ops <ops@revenuecat.com> Co-authored-by: NachoSoto <ignaciosoto90@gmail.com>

tonidero added pr:feat A new feature pr:RevenueCatUI labels Oct 10, 2023

tonidero commented Oct 10, 2023

View reviewed changes

tonidero marked this pull request as ready for review October 10, 2023 09:01

tonidero requested a review from a team October 10, 2023 09:01

NachoSoto reviewed Oct 10, 2023

View reviewed changes

tonidero mentioned this pull request Oct 11, 2023

Paywalls: Support Google fonts and font families with multiple fonts #1338

Merged

vegaro reviewed Oct 11, 2023

View reviewed changes

Comment thread ...uecatui/src/main/kotlin/com/revenuecat/purchases/ui/revenuecatui/activity/PaywallActivity.kt Outdated

vegaro reviewed Oct 11, 2023

View reviewed changes

Comment thread ...tui/src/main/kotlin/com/revenuecat/purchases/ui/revenuecatui/activity/PaywallActivityArgs.kt Outdated

tonidero force-pushed the toniricodiez/pwl-206-support-custom-fonts-through-a-fontprovider branch from 22992ca to d1d3842 Compare October 16, 2023 11:40

tonidero requested review from NachoSoto and vegaro October 16, 2023 11:41

NachoSoto approved these changes Oct 16, 2023

View reviewed changes

tonidero added 8 commits October 17, 2023 09:39

Add FontProvider to support passing custom font families

429844f

Fix text style in IntroEligibilityStateView

4e3de09

Add support to set fonts in activity

b6efe83

Small optimization

86c9c15

Address PR comments

2160c2f

Rename to fontProvider

9e967ba

Small refactor

a455cbb

Move typography copy to extension

d83c25b

tonidero force-pushed the toniricodiez/pwl-206-support-custom-fonts-through-a-fontprovider branch from d1d3842 to d83c25b Compare October 17, 2023 07:52

tonidero enabled auto-merge (squash) October 17, 2023 07:53

tonidero merged commit 39ab56c into paywalls Oct 17, 2023

tonidero deleted the toniricodiez/pwl-206-support-custom-fonts-through-a-fontprovider branch October 17, 2023 08:08

NachoSoto mentioned this pull request Oct 19, 2023

[DO NOT MERGE] Release/7.1.0-beta.2 #1373

Closed

NachoSoto mentioned this pull request Oct 31, 2023

[AUTOMATIC] Release/7.1.0 #1423

Merged

Conversation

tonidero commented Oct 10, 2023

Description

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

codecov Bot commented Oct 10, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

tonidero Oct 10, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

NachoSoto left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

NachoSoto left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tonidero commented Oct 17, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

codecov Bot commented Oct 10, 2023 •

edited

Loading

tonidero Oct 10, 2023 •

edited

Loading