0.0.6 • Published 3 months ago

react-wifi-status-indicator v0.0.6

Weekly downloads
-
License
MIT
Repository
github
Last release
3 months ago

React Wifi Status Indicator

MIT License

Tag

Open Issues

A simple wifi status indicator for react applications

Demo

Demo / Storybook

Installation

Install react-wifi-status-indicator with npm

  npm install react-wifi-status-indicator

Install react-wifi-status-indicator with yarn

  yarn add react-wifi-status-indicator

API Reference

ParameterTypeDescription
statusWifiStatusType"Excellent", "Good", "Fair", "Poor", "Unavailable", "Error", "Searching"
colorstringSet to color for wifi status levels
errorColorstringSet to color for wifi status when error occurs
offlineColorstringSet to color for wifi status when offline
widthstring / numberSet to width for wifi status icon, By default takes the parent width

Usage/Examples

// 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