0.1.0 • Published 6 years ago

react-you-are-offline v0.1.0

Weekly downloads
2
License
ISC
Repository
-
Last release
6 years ago

You Are Offline element for ReactJS

npm gzip size badges

ReactJS library to output a text when browser is offline (real offline as no wifi or throttled offline).

By default it renders green 'online' when online and red 'offline', when offline. But it is possible to override styles, classes and the messages. See "Configuration examples" lower.

Installation

    yarn add react-you-are-offline
    // or
    npm i react-you-are-offline

Usage

import { YouAreOffline } from 'react-you-are-offline';

class MyComponent extends React.Component {
    render(){
        return (
            <YouAreOffline />
        )
    }
}

export default MyComponent;

Configuration examples

Customize online status

    let message = 'You are online';
    let customStyle = { color: 'limegreen', backgroundColor: '#333333' };
    let customClass = 'alert alert-success'
    <YouAreOffline whenOnline={customMessage} onlineStyle={customStyle} onlineClass={customClass}/>

Customize offline status

    let message = 'You are OFFLINE!';
    let customStyle = { color: 'orange', backgroundColor: '#333333' };
    let customClass = 'alert alert-danger'
    <YouAreOffline whenOffline={customMessage} offlineStyle={customStyle} offlineClass={customClass}/>

Licence

This software is released under ISC licence