react-wifi-status-indicator
Version:
A simple wifi status indicator for react applications
54 lines (35 loc) • 1.99 kB
Markdown
# React Wifi Status Indicator
[](https://raw.githubusercontent.com/rahulretnan/react-wifi-status-indicator/main/LICENSE)
A simple wifi status indicator for react applications
## Demo
[Demo / Storybook](https://rahulretnan.github.io/react-wifi-status-indicator)
## Installation
Install **react-wifi-status-indicator** with **npm**
```bash
npm install react-wifi-status-indicator
```
Install **react-wifi-status-indicator** with **yarn**
```bash
yarn add react-wifi-status-indicator
```
## API Reference
| Parameter | Type | Description |
| :---------------- | :--------------- | :------------------------------------------------------------------------- |
| `status` | `WifiStatusType` | "Excellent", "Good", "Fair", "Poor", "Unavailable", "Error", "Searching" |
| `color` | `string` | Set to color for wifi status levels |
| `errorColor` | `string` | Set to color for wifi status when error occurs |
| `offlineColor` | `string` | Set to color for wifi status when offline |
| `width` | `string / number`| Set to width for wifi status icon, By default takes the parent width |
## Usage/Examples
```javascript
// ES6 or TypeScript:
import {WifiStatus, WifiStatusType} from 'react-wifi-status-indicator';
const WifiStatusExample = () =>{
return <WifiStatus status={WifiStatusType.Fair} width={100}>
}
export default WifiStatusExample;
```
## License
[MIT](https://raw.githubusercontent.com/rahulretnan/react-wifi-status-indicator/main/LICENSE)