Allow customizable icon size for splash screen on Wear OS [256678037]

Fixed

Feature Request

Status Update

No update yet.

Description

ks...@google.com

created issue #1

Oct 31, 2022 09:10PM

Description

Currently it's not possible to specify smaller dimensions for the icon (as per https://developer.android.com/reference/kotlin/androidx/core/splashscreen/SplashScreen#specs), so the recommended implementation using androidx.splashscreen library doesn't work on Wear OS. Wear OS splash icon must be 48x48dp.

Future Wear OS platform releases that will be based on Android12+ will need to comply with our Splash Screen changes and ideally follow our recommendations for mobile as desctibed at https://developer.android.com/develop/ui/views/launch/splash-screen/migrate

So it's important to understand if this feature request is feasible, and if not what other options do we have for Wear developers.

Versions used

Component used: androidx.core:core-splashscreen

Version used: 1.0.0-beta02

Devices/Android versions reproduced on: Wear OS emulator API 30 (Pixel watch)

Other details

Sample project to trigger the issue: see https://github.com/android/wear-os-samples/pull/573 for discussion and code, it's a part of public samples for Wear OS.
A screenrecord or screenshots showing the issue (if UI related): attached video demonstrating issue, it corresponds to following theme definition:

    <style name="SplashTheme" parent="Theme.SplashScreen.IconBackground">
        <item name="windowSplashScreenBackground">@android:color/black</item>
        <item name="windowSplashScreenAnimatedIcon">@drawable/ic_launcher_round</item>
        <item name="postSplashScreenTheme">@style/MainTheme</item>
    </style>

device-2022-10-31-205939.webm

837 KB

Download

Comments

wi...@google.com <wi...@google.com> #2Nov 1, 2022 02:22AM

Reassigned to ma...@google.com.

Or when changing to textView.textMetricsParamsCompat still crash.

private fun setAsyncText(textView: AppCompatTextView, text: String?) {
if (!text.isNullOrEmpty()) {
val textFuture = PrecomputedTextCompat.getTextFuture(text!!, textView.textMetricsParamsCompat, null)
textView.setTextFuture(textFuture) //Crash
}
}

re...@google.com <re...@google.com> #3Nov 1, 2022 01:57PM

add this line :
textView.setLayoutDirection(ViewCompat.getLayoutDirection(textView));
before :
setTextFuture(....)

Message last modified on Nov 1, 2022 01:59PM

ma...@google.com <ma...@google.com> #4Nov 1, 2022 02:18PM

Thanks, #3. It worked.

But I think it is better when set before this line
val textFuture = PrecomputedTextCompat.getTextFuture(text!!, textView.textMetricsParamsCompat, null)

Set android:layoutDirection="locale" or android:layoutDirection="inherit" for AppCompatTextView in the XML layout didn't this problem.

The new method btw re-set layoutDirector. Weird! This should handle in the AppcompatTextView.

private fun setAsyncText(textView: AppCompatTextView, text: String?) {
if (!text.isNullOrEmpty()) {
textView.layoutDirection = textView.layoutDirection
val textFuture = PrecomputedTextCompat.getTextFuture(text!!, textView.textMetricsParamsCompat, null)
textView.setTextFuture(textFuture) //Crash
}
}

wi...@google.com <wi...@google.com> #5Nov 2, 2022 03:32AM

Reassigned to wi...@google.com.

Sorry. I forgot the info.

minSdk 21
targetSdk 28

Thanks #3 again.

fe...@gmail.com <fe...@gmail.com> #6Dec 17, 2022 04:24PM

App Crash at
TextViewCompat.java:889
if (!param.equals(precomputed.getParams())) {
throw new IllegalArgumentException("Given text can not be applied to TextView.");
}
PrecomputedTextCompat.class:334
with : this.mTextDir != other.getTextDirection() == true
So,
TextDirection on TextView and TextDirection on Param is difference
maybe, it handled wrong or missing conditional on getTextDirectionHeuristic of TextViewCompat

ks...@google.com <ks...@google.com> #7Feb 17, 2023 06:27PM

With reference to

comment #4

, issue is resolved by implementing suggested changes in

comment #3

. Can you please confirm if we need to still investigate this issue ?

wi...@google.com <wi...@google.com> #8Feb 20, 2023 02:19AM

Reassigned to ma...@google.com.

Yes. textView.layoutDirection = textView.layoutDirection(>= API17) or ViewCompat.setLayoutDirection(textView, ViewCompat.getLayoutDirection(textView)) will resolve this bug.

But I think you should handle it in the AppcompatTextView. It is better. If a developer forgets testing with RTL. I think this is the nightmare(it is difficult to determine the bug) when they update their app on the Play Store.

I read this article, in the part databing he noted about set the direction

https://medium.com/google-developers/prefetch-text-layout-in-recyclerview-4acf9103f438'

fun asyncText
..........
// first, set all measurement affecting properties of the text
// (size, locale, typeface, direction, etc)

But in the offical document isn't good (lack direction)

https://developer.android.com/reference/androidx/appcompat/widget/AppCompatTextView.html#setTextFuture(java.util.concurrent.Future%3Candroidx.core.text.PrecomputedTextCompat%3E)

Anything layout related property changes, text size, typeface, letter spacing, etc after this method call will causes IllegalArgumentException during View measurement.

My view: Handling this in the AppcompatTextView is the best choice if you can do it.

Thanks!

ma...@google.com <ma...@google.com> #9Feb 20, 2023 12:36PM

Reassigned to wi...@google.com.

I think should handle setLayoutDirection in the AppcompatTextView when setTextFuture, it will simpler for dev when implement TextFuture.

Message last modified on Feb 20, 2023 12:49PM

deleted

0 B

ma...@google.com <ma...@google.com> #10Feb 20, 2023 12:50PM

We have passed this to the development team and will update this issue with more information as it becomes available.

Wear splash screen dimensions base 48dp.png

49 KB

View

Download

ys...@google.com <ys...@google.com> #11Feb 20, 2023 01:48PM

Fix released with appCompat 1.0.2, core 1.0.1

le...@google.com <le...@google.com> #12Feb 20, 2023 03:38PM

Similar request has been raised in another bug in Android AOSP external tracker in

b/123131632

.

Description shared by an external reporter:
================================
1.
Version used: androidx.appcompat:appcompat:1.1.0-alpha1

AppCompatTextView.setTextFuture

http://crashes.to/s/a9335204277

i found

https://issuetracker.google.com/issues/113070424 say version 1.0.2 fixed, But it still exists。

2.
Non-fatal Exception: java.lang.IllegalArgumentException: Given text can not be applied to TextView.
at androidx.core.widget.TextViewCompat.retrieveField(Unknown Source:22)
at androidx.appcompat.widget.AppCompatTextView.consumeTextFutureAndSetBlocking(Unknown Source:15)
at androidx.appcompat.widget.AppCompatTextView.onMeasure(Unknown Source)
at com.bilibili.magicasakura.widgets.AppCompatTintTextView.onMeasure(Unknown Source)
at android.view.View.measure(View.java:22145)
at android.view.ViewGroup.measureChildWithMargins(ViewGroup.java:6602)
at android.widget.LinearLayout.measureChildBeforeLayout(LinearLayout.java:1514)
at android.widget.LinearLayout.measureVertical(LinearLayout.java:806)
at android.widget.LinearLayout.onMeasure(LinearLayout.java:685)
at android.view.View.measure(View.java:22145)
at android.view.ViewGroup.measureChildWithMargins(ViewGroup.java:6602)
at android.widget.FrameLayout.onMeasure(FrameLayout.java:185)
at androidx.cardview.widget.CardView.onMeasure(Unknown Source:80)
at android.view.View.measure(View.java:22145)
at androidx.recyclerview.widget.RecyclerView$LayoutManager.measureChildWithMargins(Unknown Source:98)
at androidx.recyclerview.widget.LinearLayoutManager.generateDefaultLayoutParams(Unknown Source:60)
at androidx.recyclerview.widget.LinearLayoutManager.generateDefaultLayoutParams(Unknown Source:44)
at androidx.recyclerview.widget.LinearLayoutManager.findViewByPosition(Unknown Source:36)
at androidx.recyclerview.widget.LinearLayoutManager.setOrientation(Unknown Source:6)
at androidx.recyclerview.widget.RecyclerView.exceptionLabel(Unknown Source:39)
at androidx.recyclerview.widget.RecyclerView$ViewFlinger.run(Unknown Source:91)
at android.view.Choreographer$CallbackRecord.run(Choreographer.java:979)
at android.view.Choreographer.doCallbacks(Choreographer.java:791)
at android.view.Choreographer.doFrame(Choreographer.java:723)
at android.view.Choreographer$FrameDisplayEventReceiver.run(Choreographer.java:965)
at android.os.Handler.handleCallback(Handler.java:790)
at android.os.Handler.dispatchMessage(Handler.java:99)
at android.os.Looper.loop(Looper.java:164)
at android.app.ActivityThread.main(ActivityThread.java:6707)
at java.lang.reflect.Method.invoke(Method.java)
at com.android.internal.os.RuntimeInit$MethodAndArgsCaller.run(RuntimeInit.java:438)
at com.android.internal.os.ZygoteInit.main(ZygoteInit.java:886)
at de.robv.android.xposed.XposedBridge.main(XposedBridge.java:108)

device: meizu, Android 7 and 8
And you can see fabric detail

http://crashes.to/s/a9335204277
===========================================

Requesting team for initial inputs. Please let us know if this can be handled as a part of this bug else we will create a separate bug for this.

le...@google.com <le...@google.com> #13Feb 22, 2023 02:43PM

Please ignore

comment #12

ma...@google.com <ma...@google.com> #14Feb 22, 2023 05:32PM

Thanks Todd.
It does not yet align with UX expectations.
The desired behavior is similar as the one of Handset, but adapted for Wear.

Launch transition uses Wear task launch transition.
↪ On the video: no transition visible
The app icon should not move (position animation) within the app view.
↪ On the video: the icon animates up on the Y axis when fading in
The app icon can be animated via AVD following the same guidelines
↪ Not able to verify
We use the exit animation to gracefully reveal the app once loaded
↪ On the video: the icon animates down on Y axis and the reveal/fade isn't as polished as the one on Handset/the guidelines above.

For the last one specifically, I would like the possibility to explore a different reveal that is more suited to the form factor if there are opportunities to customize it for Wear.

le...@google.com <le...@google.com> #15Feb 22, 2023 05:36PM

Thanks for the feedback Max - sorry, I should have specified the scope of the proposed change. This appears to be addressing only the size (allowing for smaller icon sizes - i.e. compare at the clip from comment#1: https://android-build.googleplex.com/builds/bug_tool?source=openFromExtension&sourceType=buganizer&issue=256678037&attachments=39574167)

ma...@google.com <ma...@google.com> #16Feb 22, 2023 05:56PM

App icon size is correct! Thanks

ap...@google.com <ap...@google.com> #17Feb 23, 2023 02:51AM

Project: platform/frameworks/support
Branch: androidx-main

commit 0f66a201003d4f9f1d74830376744d43ede0900d
Author: wilsonshih <wilsonshih@google.com>
Date: Wed Feb 22 16:47:48 2023

Provide default dimens for wear device.

Provide default dimensions for wear device

Bug: 256678037
Test: run test on wear device.
Relnote: Provide default dimensions for wear device with 48x48dp icon
Change-Id: Ib8de8f78ea1d1dbe67cbc2d8de0388f5cfeb6c7e

A core/core-splashscreen/src/main/res/values-watch/dimens.xml

https://android-review.googlesource.com/2450245

ys...@google.com <ys...@google.com> #18Feb 23, 2023 09:42AM

Tiny nit. Can we also change the default background to black? When we use @android:style/Theme.DeviceDefault it has a black background. But we need to override the background in the splash theme when using Theme.SplashScreen as a parent.

It seems like it goes

Theme.SplashScreen > Theme.SplashScreen.Common > Base.Theme.SplashScreen.DayNight > Base.Theme.SplashScreen.Light

Or maybe I'm reading it wrong? I know it's part of the docs to override, but I got the impression on mobile, apps could omit setting the background and it would take the right one from the dark/light theme default?

dl...@gmail.com <dl...@gmail.com> #19Mar 15, 2023 05:59PM

Comment has been deleted.

Message last modified on Mar 17, 2023 10:35AM

dl...@gmail.com <dl...@gmail.com> #20Mar 16, 2023 09:46AM

I've just tested the solution suggested above and it works brilliantly for WearOS .. try adding the below to your dimens.xml file

<dimen name="splashscreen_icon_size_no_background" tools:override="true">288dp</dimen>
<dimen name="splashscreen_icon_mask_size_no_background" tools:override="true">410dp</dimen>
<dimen name="splashscreen_icon_mask_stroke_no_background" tools:override="true">109dp</dimen>

<dimen name="splashscreen_icon_size_with_background" tools:override="true">48dp</dimen> <!-- icon size directive -->
<dimen name="splashscreen_icon_mask_size_with_background" tools:override="true">72dp</dimen>
<dimen name="splashscreen_icon_mask_stroke_with_background" tools:override="true">64dp</dimen>

wi...@google.com <wi...@google.com> #21Apr 14, 2023 02:24AM

Reassigned to rg...@google.com.

Re comment#18, seems the theme for wear need to override with res folder:
res/values-watch

rg...@google.com <rg...@google.com> #22Apr 19, 2023 02:42PM

Reassigned to le...@google.com.

Todd, could your team prepare a CL for the background and test that it works the way you want?

le...@google.com <le...@google.com> #23Apr 19, 2023 08:12PM

Reassigned to rg...@google.com.

ack - we actually resolved the dark background for wear here:

https://googleplex-android-review.git.corp.google.com/c/platform/frameworks/base/+/22185623.

Based on the work already done to adjust the sizing here:

https://android-review.git.corp.google.com/c/platform/frameworks/support/+/2450245/1/core/core-splashscreen/src/main/res/values-watch/dimens.xml

Shall we mark this closed?

Message last modified on Apr 19, 2023 08:13PM

rg...@google.com <rg...@google.com> #24Apr 19, 2023 09:11PM

Marked as fixed.

Yes, that looks done... Wei Sheng, please reopen and let us know if you had something beyond that in mind.

pr...@google.com <pr...@google.com> #25Sep 6, 2023 07:56PM

The following release(s) address this bug.It is possible this bug has only been partially addressed:

androidx.core:core-splashscreen:1.1.0-alpha02

wi...@google.com <wi...@google.com> #26Sep 8, 2023 01:14AM

The version 1.1.0-alpha02 update the core-splashscreen library to latest verson against SDK 34, what do you mean "partially addressed"?

ys...@google.com <ys...@google.com> #27Sep 8, 2023 07:27AM

That's a template message for these automated updates. A commit was included in a release towards this fix, but without promising it is the final change.

But you can now use both 1.1.0-alpha02 and 1.0.1 on Wear.

ys...@google.com <ys...@google.com> #28Mar 11, 2024 09:39AM

What does the minimal correct implementation of a Splashscreen for Wear 3 look like? Is it customised theme + dimens.xml + splashscreen.xml drawable? I'm wondering why it isn't just providing an icon?

Does the androidx codebase have a sample/demo/test showing how to use this on Wear. Following the docs gets the right results, but honestly there is way more setup than I would expect.

https://github.com/android/wear-os-samples/pull/1028

pa...@gmail.com <pa...@gmail.com> #29Mar 11, 2024 06:08PM

What is the right solution to change the icon size of Splash Screen using: implementation 'androidx.core:core-splashscreen:1.1.0-alpha02' on wear OS?

Thanks!

na...@google.com <na...@google.com> #30Apr 17, 2024 05:17PM

The following release(s) address this bug.It is possible this bug has only been partially addressed:

androidx.core:core-splashscreen:1.2.0-alpha01

Issue 256678037

Description

Description

Versions used

Other details

Issue summary

Comments

wi...@google.com <wi...@google.com> #2Nov 1, 2022 02:22AM

re...@google.com <re...@google.com> #3Nov 1, 2022 01:57PM

ma...@google.com <ma...@google.com> #4Nov 1, 2022 02:18PM

wi...@google.com <wi...@google.com> #5Nov 2, 2022 03:32AM

fe...@gmail.com <fe...@gmail.com> #6Dec 17, 2022 04:24PM

ks...@google.com <ks...@google.com> #7Feb 17, 2023 06:27PM

wi...@google.com <wi...@google.com> #8Feb 20, 2023 02:19AM

ma...@google.com <ma...@google.com> #9Feb 20, 2023 12:36PM

ma...@google.com <ma...@google.com> #10Feb 20, 2023 12:50PM

ys...@google.com <ys...@google.com> #11Feb 20, 2023 01:48PM

le...@google.com <le...@google.com> #12Feb 20, 2023 03:38PM

le...@google.com <le...@google.com> #13Feb 22, 2023 02:43PM

ma...@google.com <ma...@google.com> #14Feb 22, 2023 05:32PM

le...@google.com <le...@google.com> #15Feb 22, 2023 05:36PM

ma...@google.com <ma...@google.com> #16Feb 22, 2023 05:56PM

ap...@google.com <ap...@google.com> #17Feb 23, 2023 02:51AM

ys...@google.com <ys...@google.com> #18Feb 23, 2023 09:42AM

dl...@gmail.com <dl...@gmail.com> #19Mar 15, 2023 05:59PM

dl...@gmail.com <dl...@gmail.com> #20Mar 16, 2023 09:46AM

wi...@google.com <wi...@google.com> #21Apr 14, 2023 02:24AM

rg...@google.com <rg...@google.com> #22Apr 19, 2023 02:42PM

le...@google.com <le...@google.com> #23Apr 19, 2023 08:12PM

rg...@google.com <rg...@google.com> #24Apr 19, 2023 09:11PM

pr...@google.com <pr...@google.com> #25Sep 6, 2023 07:56PM

wi...@google.com <wi...@google.com> #26Sep 8, 2023 01:14AM

ys...@google.com <ys...@google.com> #27Sep 8, 2023 07:27AM

ys...@google.com <ys...@google.com> #28Mar 11, 2024 09:39AM

pa...@gmail.com <pa...@gmail.com> #29Mar 11, 2024 06:08PM

na...@google.com <na...@google.com> #30Apr 17, 2024 05:17PM

Add comment

Issue metadata