1.0.2 โ€ข Published 5 months ago

@shrivastava/usestatus v1.0.2

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

useOnlineStatus

A simple and effective React hook to detect the online๐Ÿ’š/offlineโค๏ธ status of the user in real-time, with live connection indicators

๐Ÿš€ Installation

You can easily install useOnlineStatus using npm or yarn. Here's how to get started:

With npm:

npm install @shrivastava/usestatus

๐Ÿ’ก Usage

Once installed, you can start using the useOnlineStatus hook in your React components. The hook returns a boolean value indicating whether the user is online or offline, which is visually represented by colorful emojis.

Example:

  import React from 'react'; 
  import useStatus from '@shrivastava/usestatus';
  
  const App = () => {
    const isOnline = useStatus();
  
    return (
      <div style={{ padding: '20px', textAlign: 'center' }}>
      
        <h1 style={{ fontSize: '2em' }}>
          {isOnline ? ( <>๐ŸŸข You are online ๐Ÿ’š</> ) : <> ๐Ÿ”ด You are offline โค๏ธ </> )}
        </h1>
      </div>
    );
  };
  
  export default App;

๐ŸŽจ Features

  • Real-Time Monitoring: The hook automatically updates the status whenever the user's network changes (online/offline).
  • Live Connection Indicators: Emojis ๐Ÿ’šโค๏ธ give a visual cue to users based on their network status.
  • Easy to Use: Just import and call the hook in your component. No additional setup is required.

โšก Benefits

  • Seamless App Behavior: Adjust app features dynamically based on the network status.
  • Small Footprint: The hook is highly efficient and doesn't add unnecessary bloat to your project.

๐Ÿ”— Links

๐Ÿ“„ License

MIT License. Feel free to contribute or use the package in your projects.

1.0.2

5 months ago

1.0.1

5 months ago

1.0.0

5 months ago