https://github.com/codewithreelofficial/react-native-splash-screen-mask
A splash screen for react-native, It hide when application loaded. It works on iOS, Android and Window.
https://github.com/codewithreelofficial/react-native-splash-screen-mask
android ios launch-screen launchimage launchscreen react react-native reactjs splash-screen splashscreen
Last synced: about 1 month ago
JSON representation
A splash screen for react-native, It hide when application loaded. It works on iOS, Android and Window.
- Host: GitHub
- URL: https://github.com/codewithreelofficial/react-native-splash-screen-mask
- Owner: codewithreelofficial
- License: mit
- Created: 2018-11-09T14:57:35.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-11-13T09:18:18.000Z (over 6 years ago)
- Last Synced: 2024-11-03T21:06:34.786Z (7 months ago)
- Topics: android, ios, launch-screen, launchimage, launchscreen, react, react-native, reactjs, splash-screen, splashscreen
- Language: JavaScript
- Homepage:
- Size: 398 KB
- Stars: 10
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# react-native-splash-screen-mask
[](https://www.npmjs.com/package/react-native-splash-screen-mask) [](https://www.npmjs.com/package/react-native-splash-screen-mask) [](http://opensource.org/licenses/MIT).
A splash screen for react-native, It hide when application loaded. It works on iOS, Android and Window.
## Content
- [Examples](#examples)
- [Installation](#installation)
- [Props](#props)
- [Wrap Up](#wrap-up)
- [Contribution](#contribution)
## Examples
[Examples](./examples "react-native-splash-screen-mask")
## Installation
`$ npm install react-native-splash-screen-mask --save`
## Usage
Use like so:
```javascript
import React, { Component } from 'react';
import { StyleSheet } from 'react-native';
import SplashScreenMask from 'react-native-splash-screen-mask';
import { Actions } from 'react-native-router-flux';
import IMAGE from '../assets/react.png';
export default class SplashScreen extends Component {
render() {
return (
Actions.homeScene()}
backgroundStyle={styles.backgroundStyle}
duration={3000}
/>
);
}
}
const styles = StyleSheet.create({
backgroundStyle: {
backgroundColor: '#fff',
},
});
```
## Props
| props | Type | Optional | Default | Description |
|--------|--------|--------|--------|--------|
| imageSource | any | no | | The image (png, jpg, jpeg, gif) splash screen. |
| navigationAction | any | no | | Redirect callback function (can be used `react-native-router-flux` or anything else). |
| backgroundStyle | any | yes | `{ backgroundColor: '#fff' }` | The style of splash screen background. |
| duration | number | yes | 3000 (3 seconds) | Duration for loading the splash screen. |
## Wrap Up
If you think any of the `react-native-splash-screen-mask` can be improved, please do open a PR with any updates and submit any issues. Also, I will continue to improve this, so you might want to watch/star this repository to revisit.
## Contribution
We'd love to have your helping hand on contributions to `react-native-splash-screen-mask` by forking and sending a pull request.
Your contributions are heartily ♡ welcome, recognized and appreciated.
How to contribute:
- Open pull request with improvements
- Discuss ideas in issues
- Spread the word
- Reach out with any feedback
## License
The MIT License [](https://opensource.org/licenses/MIT)