expo-splash-screen - Amazon Vega Docs

The @amazon-devices/expo-splash-screen library is used to tell the splash screen to remain visible until it has been explicitly told to hide. This feature is useful for tasks that happen behind the scenes, such as making API calls, pre-loading fonts, or animating the splash screen.

Installation

Add the JavaScript library dependency in the package.json file:

"dependencies": {
    ...
    "@amazon-devices/expo-splash-screen": "~2.0.1",
    "@amazon-devices/keplerscript-turbomodule-api": "~1.0.0",
    ...
        }

"overrides": {
    "@amazon-devices/react-native-kepler": "~2.0.0"
    },

Reinstall dependencies using the npm install command.

Examples

Create a top-level directory. Place the zip file named SplashScreenImages.zip with the desc.txt file (see the example) and the _loop folder with the splash.png file. Folder structure:

├── assets/
├──── raw/
├────── SplashScreenImages.zip
...
├── src/
...
├── manifest.toml

Example content of the desc.txt file:

1920 1080 30
c 0 0 _loop

Splash screen example

import {hideAsync, preventAutoHideAsync} from '@amazon-devices/expo-splash-screen';
import React from 'react';
import {useEffect} from 'react';
import {StyleSheet, Text, View} from 'react-native';

preventAutoHideAsync();

export const App = () => {
  useEffect(() => {
    // perform your operations before calling hide async
    setTimeout(() => {
      hideAsync();
    }, 2000);
  }, []);

  return (
    <View style={styles.container}>
      <Text style={styles.text}>SplashScreen Demo! 👋</Text>
    </View>
  );
};

const styles = StyleSheet.create({
  container: {
    flex: 1,
    backgroundColor: 'white',
    alignItems: 'center',
    justifyContent: 'center',
  },
  text: {
    color: 'black',
    fontSize: 32,
  },
});

API reference

See the documentation page for information about this library and API reference: Official Expo documentation for expo-splash-screen.

Methods

Method	Description
`hideAsync`	Hides the native splash screen immediately. Make sure your app has content ready to display when you hide the splash screen, or you may see a blank screen, briefly. See the Examples section for an example.
`preventAutoHideAsync`	Makes the native splash screen remain visible until `hideAsync` is called.

Known issues and limitations

The splash screen doesn’t work on a Vega Virtual Device.

Supported versions

Package Version	Based On	@amazon-devices/react-native-kepler version
2.0.x	0.24.0	2.0.x

Supported Third-Party Libraries and Services.

​Installation

​Examples

​Splash screen example

​API reference

​Methods

​Known issues and limitations

​Supported versions

​Related topics