Skip to content

fix!: extended-splashscreen not working on skia-mobile #1435

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix!: extended-splashscreen not working on skia-mobile #1435

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 2 additions & 38 deletions doc/controls/ExtendedSplashScreen.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ uid: Toolkit.Controls.ExtendedSplashScreen
---
# ExtendedSplashScreen

Represents a control, derived from [`LoadingView`](xref:Toolkit.Controls.LoadingView) that displays a view that replicates the appearance and behavior of the target platform's native application loading screen.
Represents a control, derived from [`LoadingView`](xref:Toolkit.Controls.LoadingView) that displays a view that simulates the appearance and behavior of the target platform's native application loading screen.

Refer to [`LoadingView`](xref:Toolkit.Controls.LoadingView) for a list of inherited members.

Expand All @@ -20,30 +20,8 @@ A common use case for this control is to display an application loading element
>
> [!Video https://www.youtube-nocookie.com/embed/jMI4E2e9gYE]

## Properties

| Property | Type | Description | Value |
|----------|------|-------------|---------------|
| **Platforms** | `SplashScreenPlatform` | Gets or sets the platform(s) where extended splash screen should be used. This is a flag enumeration, which allows for combining multiple values eg: `"Android,iOS"` | Default value is **All**. Other possible values include **Android**, **iOS**, **Windows**, **WebAssembly**, **Skia**, and **None**. |
| **SplashIsEnabled** | `bool` | Gets a value representing whether the current environment is to display this splash screen. | **True** if the current platform is included in the **Platforms** property, otherwise **false**. |

## Methods

| Method | Return Type | Description |
|--------|-------------|-------------|
| **Init** | `void` | Initializes the splash screen for the provided `Activity` instance. This static method should be invoked from the **OnCreate** override in `MainActivity`.<br/>**Note: This method only needs to be called on Android** |

## Usage

### Specify platforms to display splash screen

The following code snippet will only display the splash screen on Android and iOS by specifying a `SplashScreenPlatform` value for the `Platforms` property.

```xml
<utu:ExtendedSplashScreen x:Name="Splash"
Platforms="Android,iOS" />
```

### Setup the splash screen

The following code snippet demonstrates a suggested pattern for using the `ExtendedSplashScreen`. The first step is to define a custom `UserControl` that will be used as the main shell for the application content. This control will be used to host the `ExtendedSplashScreen` and the main application content.
Expand Down Expand Up @@ -96,7 +74,7 @@ Next, the `Shell` control should be used as the root visual for the `Window` in
```csharp
protected override async void OnLaunched(LaunchActivatedEventArgs args)
{
// Code ommited for brevity
// Boilerplate code omitted for brevity

if (MainWindow.Content is not Shell shell)
{
Expand All @@ -119,17 +97,3 @@ protected override async void OnLaunched(LaunchActivatedEventArgs args)
With these changes, the splash screen will be displayed when the application first launches and the main application content will be displayed once the loading state is complete.

In order to prolong the splash screen display, you can set the `Source` property of the `ExtendedSplashScreen` control to any custom implementation of the `ILoadable` interface. More information on how to use the `ILoadable` interface can be found in the [`LoadingView`](xref:Toolkit.Controls.LoadingView#iloadable) documentation.

## Setup on Android

To use the `ExtendedSplashScreen` on Android, you need to add the following to your `MainActivity`:

```csharp
protected override void OnCreate(Bundle bundle)
{
// Handle the splash screen transition.
Uno.Toolkit.UI.ExtendedSplashScreen.Init(this);

base.OnCreate(bundle);
}
```
9 changes: 1 addition & 8 deletions src/Uno.Toolkit.RuntimeTests/Tests/ExtendedSplashScreenTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,29 +19,22 @@ namespace Uno.Toolkit.RuntimeTests.Tests;
public class ExtendedSplashScreenTests
{
[TestMethod]
#if __ANDROID__ || __IOS__
[Ignore]
#endif
public async Task Smoke_Test()
{
var host = await ExtendedSplashScreen.GetNativeSplashScreen().ConfigureAwait(false) ?? throw new Exception("Failed to load native splash screen");
var host = await ExtendedSplashScreen.GetSplashScreen().ConfigureAwait(false) ?? throw new Exception("Failed to load native splash screen");

#if !__MOBILE__ // ignore native platforms impl: ios,droid,macos
var sut = host.GetFirstDescendant<Image>() ?? throw new Exception("Failed to find splash image control");
var tcs = new TaskCompletionSource<(bool Success, string? Message)>();

sut.ImageOpened += (s, e) => tcs.SetResult((Success: true, null));
sut.ImageFailed += (s, e) => tcs.SetResult((Success: false, e.ErrorMessage));
#endif

await UnitTestUIContentHelperEx.SetContentAndWait(host);

#if !__MOBILE__
if (await Task.WhenAny(tcs.Task, Task.Delay(2000)) != tcs.Task)
throw new TimeoutException("Timed out waiting on image to load");

if ((await tcs.Task) is { Success: false, Message: var message })
throw new Exception($"Failed to load image: {message}");
#endif
}
}
Loading
Loading