Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gnestor/react-native-statusbar-alert
A status bar alert (e.g. in-call, recording, navigating) for React Native
https://github.com/gnestor/react-native-statusbar-alert
alert android ios react-native statusbar
Last synced: 11 days ago
JSON representation
A status bar alert (e.g. in-call, recording, navigating) for React Native
- Host: GitHub
- URL: https://github.com/gnestor/react-native-statusbar-alert
- Owner: gnestor
- Created: 2016-05-04T19:56:03.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2022-12-07T17:20:04.000Z (almost 2 years ago)
- Last Synced: 2024-10-14T02:12:33.590Z (about 1 month ago)
- Topics: alert, android, ios, react-native, statusbar
- Language: JavaScript
- Size: 2.93 MB
- Stars: 231
- Watchers: 8
- Forks: 30
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# React Native Statusbar Alert
A status bar alert (e.g. in-call, recording, navigating) for React Native
## Install
`npm install react-native-statusbar-alert --save` or `yarn add react-native-statusbar-alert`
## Usage
### Basic
```js
```
### Pulse
```js
```
### Press
```js
this.navigator.push({id: 'SilentAlert'})}
/>
```
### Children
```js
```
## Props
| Name | Description | Required | Type | Default
| :------------- | :------------------------------ | :---------- | :------------------------ | :------
| visible | `true` to show, `false` to hide | true | bool | `false`
| message | message to display in alert | true | string | `''`
| onPress | callback on press event | false | func | `null`
| pulse | animate the text or background | false | enum('text','background') | `false`
| backgroundColor | background color | false | [color][1] | `'#3DD84C'`
| highlightColor | color on press and pulse | false | [color][1] | `darken(this.props.backgroundColor, 0.9)`
| color | text color | false | [color][1] | `'white'`
| height | height of children container | false | int | 20
| statusbarHeight | [custom status bar height][2] | false | int | 20
| style | styles for children container | false | [style object][3] | `{}`
[1]: https://facebook.github.io/react-native/docs/colors.html "React Native Colors"
[2]: https://github.com/brentvatne/react-native-status-bar-size "react-native-status-bar-size"
[3]: https://facebook.github.io/react-native/docs/style.html "React Native Style"
## Usage with react-navigation
Create a navigation element using reat-navigation:
```js
import { StackNavigator } from 'react-navigation';
```
```js
const NavigationStack = StackNavigator({
Home: {
screen: HomeScreen
},
Child: {
screen: ChildScreen
}
});
```
Render `StatusBarAlert` adjacent with `StatusBar` and `NavigationStack`:
```js
```
See the [ReactNativeStatusBarAlert](/ReactNativeStatusBarAlert) directory for a complete example.
## Alert stack example
Much like a route stack, you can keep an alert stack as an array of alert objects in your component's state. The StatusBarAlert will render the first alert in the stack, so that as new alerts are pushed into the stack, it will render the most recent alert. If an alert is popped from the stack, StatusBarAlert will render any remaining alerts and when the stack is empty, StatusBarAlert will hide itself. Additionally, the object spread operator (`{...this.state.alerts[0]}`) allows you to declare the default props for alerts in `render()` (e.g. `backgroundColor="#3CC29E"`) and override those props in the alert object (e.g. `backgroundColor="#FF6245"`).
```js
render() {
return (
0}
{...this.state.alerts[0]}
/>
}
/>
)
}
showSilentAlert() {
this.setState({
alerts: [{
message: 'Silent Switch ON',
onPress: () => this.navigator.push({id: 'SilentAlert'}),
backgroundColor="#FF6245"
}, ...this.state.alerts]
})
}
hideSilentAlert() {
this.setState({
alerts: this.state.alerts.filter(alert => alert.message !== 'Silent Switch ON')
})
}
```
## Example app
See the [ReactNativeStatusBarAlertExample](https://github.com/gnestor/react-native-statusbar-alert/tree/master/ReactNativeStatusBarAlertExample) directory for an example React Native app using react-native-statusbar-alert.