use-online-checking 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Premanshu Ray
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,105 @@
+# useOnline
+
+A simple and lightweight custom React hook to detect browser online and offline status in real-time.
+
+---
+
+## ✨ Features
+
+- 🚀 Lightweight and dependency-free
+- ⚡ Real-time network status detection
+- 🔄 Automatic event listener cleanup
+- 🧠 Easy to use in any React project
+
+---
+
+## 📦 Installation
+
+If published to npm:
+
+```bash
+npm install use-online
+```
+
+Or clone the repository:
+
+```bash
+git clone https://github.com/your-username/use-online.git
+```
+
+---
+
+## 🚀 Usage
+
+```jsx
+import useOnline from "use-online";
+
+function App() {
+  const isOnline = useOnline();
+
+  return (
+    <div>
+      {isOnline ? (
+        <h2>✅ You are Online</h2>
+      ) : (
+        <h2>❌ You are Offline</h2>
+      )}
+    </div>
+  );
+}
+
+export default App;
+```
+
+---
+
+## 🧠 How It Works
+
+The hook listens to browser events:
+
+- `window.addEventListener("online")`
+- `window.addEventListener("offline")`
+
+When the network status changes, the state updates automatically.
+
+---
+
+## 📌 API
+
+### `useOnline()`
+
+Returns:
+
+| Name      | Type    | Description                     |
+|-----------|---------|---------------------------------|
+| isOnline  | boolean | Current internet connection status |
+
+---
+
+## 📁 Project Structure
+
+```
+use-online/
+│
+├── src/
+│   ├── useOnline.js
+│   ├── App.jsx
+│   ├── main.jsx
+│
+├── package.json
+├── README.md
+└── vite.config.js
+```
+
+---
+
+## 🤝 Contributing
+
+Contributions are welcome.  
+Feel free to open issues or submit pull requests.
+
+---
+
+## 📄 License
+
+MIT

package/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "use-online-checking",
+  "version": "1.0.0",
+  "description": "Lightweight React hook to detect online/offline network status in real time.",
+  "main": "src/index.js",
+  "keywords": [
+    "react",
+    "react-hook",
+    "custom-hook",
+    "network",
+    "online",
+    "offline"
+  ],
+  "peerDependencies": {
+    "react": ">=16.8"
+  },
+  "author": {
+    "name": "Premanshu Ray",
+    "email" : "premanshuray981@gmail.com",
+    "url": "https://github.com/Prem-Ray"
+  },
+  "license": "MIT"
+}

package/src/useOnline.js

@@ -0,0 +1,26 @@
+import { useState , useEffect} from "react"
+
+const useOnline = ()=>{
+    const [isOnline,setIsOnline] = useState(true) ;
+
+    useEffect(()=>{
+        const checkOnline = ()=>{
+            setIsOnline(true) ;
+        }
+        const checkOffline = ()=>{
+            setIsOnline(false) ;
+        }
+        window.addEventListener('online',checkOnline)
+
+        window.addEventListener('offline',checkOffline)
+
+        return ()=>{
+            window.removeEventListener("online",checkOnline) ;
+            window.removeEventListener("offline",checkOffline) ;
+        }
+    },[])
+
+    return isOnline ;
+}
+
+export default useOnline ;