Skip to content

Latest commit

 

History

History
35 lines (30 loc) · 1.29 KB

README.md

File metadata and controls

35 lines (30 loc) · 1.29 KB

Loading Screen Package

Create loading screen with custom description & background image

Usage

<LoadingScreen
	isVisible={true}
	message="Your message"
	bgColor="#000"
	bgImage="../path-to-your-background-image"
	color="#FFF"
	fontFamily="HVD"
	fontSize="2rem"
	logo="../path-to-you-logo"
	spinnerColor="#000"
	landscapeGame={true}
/>

Options

Required Parameter Type Example Description
✓ isVisible boolean true Determine if the component is load or not
✓ message string Chargement ... Loading message
✓ bgColor string #FFF Set the background color
✓ bgImage string ../path-to-your-background-image Set the background image
✓ color string #000 Set the descritpion's color
✓ fontFamily string HVD Set the font family
✓ fontSize string 2rem Set the font size
✓ logo string ../path-to-your-logo Set the logo
✓ spinnerColor string #FFF Set the spinner color
✓ landscapeGame bool true Determine if a rotation is necessary on mobile device