@oieduardorabelo/use-navigator-online
v6.2.2
Published
React Hooks to detect when your browser is online/offline.
Downloads
2,173
Maintainers
Readme
@oieduardorabelo/use-navigator-online
React Hooks to detect when your browser is online/offline using window.navigator.onLine
API.
To install it:
yarn add @oieduardorabelo/use-navigator-online
Example
An online demo is available at CodeSandbox:
- Live demo: https://codesandbox.io/s/live-demo-use-navigator-online-1xy56
If you've any issues, open an issue with a CodeSandbox link with your issue
API Explained
In your app, you can add:
import { useNavigatorOnline } from '@oieduardorabelo/use-navigator-online';
function App() {
let details = useNavigatorOnline(options)
...
}
details
object is composed of:
details.isOnline
: It is aBoolean
value,true
when onlinedetails.isOffline
: It is aBoolean
value,true
when offlinedetails.status
: Returns a defaultString
, when online it is"online"
and when offline it is"offline"
. You can customize it usingoptions
param
options
object is composed of:
options.whenOnline
: Can be any valid React children. It will replace theString
returned indetails.status
when online.options.whenOffline
: Can be any valid React children. It will replace theString
returned indetails.status
when offline.options.startOnline
: To support SSR, you can control the initial rendering mode using this option. It is a boolean value to determine which state your application should use first:true
for "online-first" orfalse
for "offline-first". Defaults totrue
/online-first. The value will be synced withwindow.navigator.onLine
inside anuseEffect
when your application is rendered in the browser.
Examples
Using isOnline
and isOffline
flags:
import { useNavigatorOnline } from '@oieduardorabelo/use-navigator-online';
function App() {
let { isOnline, isOffline } = useNavigatorOnline();
return (
<div>
{isOnline && <span>We are online!</span>}
{isOffline && <span>We are offline!</span>}
</div>
);
}
Using default status
:
import { useNavigatorOnline } from '@oieduardorabelo/use-navigator-online';
function App() {
// will toggle between "online" and "offline"
let { status } = useNavigatorOnline();
return <div>Browser now is {status}!</div>;
}
Custom values for status
with whenOnline
and whenOffline
:
import { useNavigatorOnline } from '@oieduardorabelo/use-navigator-online';
function App() {
// you can pass any React children in "whenOnline" and "whenOffline"
let { status } = useNavigatorOnline({
whenOnline: <h1>WE ARE ONLINE!</h1>,
whenOffline: <h4>Damn, offline :(</h4>,
});
return <div>{status}</div>;
}
No extra configuration is needed to use it on SSR:
import { useNavigatorOnline } from '@oieduardorabelo/use-navigator-online';
function App() {
let { status } = useNavigatorOnline();
return <div>{status}</div>;
}
You can initialize your application offline-first. This will sync with window.navigator.onLine
when your application starts, using a useEffect
. Trigerring a re-render of your application.
import { useNavigatorOnline } from '@oieduardorabelo/use-navigator-online';
function App() {
let { status } = useNavigatorOnline({
startOnline: false
});
return <div>{status}</div>;
}