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 is useful to do tasks that will happen behind the scenes such as making API calls, pre-loading fonts, animating the splash screen and so on.

Installation

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

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

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

Reinstall dependencies using npm install command.

Examples

You need to create top-level directory and there you need to place zip named SplashScreenImages.zip with desc.txt file (example content below) and _loop folder with splash.png file. Folder structure:

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

Example content of 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

Check out the dedicated documentation page for info about this library, API reference and more: Official Expo documentation for expo-splash-screen.

Methods

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

Implementation details

Splash screen doesn’t work on the Vega Virtual Device.

Supported versions

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

Additional resources

For information on additional libraries, see Supported Third-Party Libraries and Services.

​Installation

​Examples

​API reference

​Methods

​Implementation details

​Supported versions

​Additional resources