-
Notifications
You must be signed in to change notification settings - Fork 22.4k
/
index.md
81 lines (60 loc) · 2.55 KB
/
index.md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
---
title: "Navigator: onLine property"
short-title: onLine
slug: Web/API/Navigator/onLine
page-type: web-api-instance-property
browser-compat: api.Navigator.onLine
---
{{ApiRef("HTML DOM")}}
Returns the online status of the browser. The property returns a boolean value, with
`true` meaning online and `false` meaning offline. The property
sends updates whenever the browser's ability to connect to the network changes. The
update occurs when the user follows links or when a script requests a remote page. For
example, the property should return `false` when users click links soon after
they lose internet connection.
Browsers implement this property differently.
In Chrome and Safari, if the browser is not able to connect to a local area network
(LAN) or a router, it is offline; all other conditions return `true`. So
while you can assume that the browser is offline when it returns a `false`
value, you cannot assume that a true value necessarily means that the browser can access
the internet. You could be getting false positives, such as in cases where the computer
is running a virtualization software that has virtual ethernet adapters that are always
"connected." Therefore, if you really want to determine the online status of the
browser, you should develop additional means for checking.
In Firefox, switching the browser to offline mode sends a `false` value. Until Firefox
41, all other conditions returned a `true` value; testing actual behavior on Nightly 68 on
Windows shows that it only looks for LAN connection like Chrome and Safari giving false
positives.
You can see changes in the network state by listening to the [`online`](/en-US/docs/Web/API/Window/online_event) and [`offline`](/en-US/docs/Web/API/Window/offline_event) events.
## Value
A boolean.
## Examples
### Basic usage
To check if you are online, query `window.navigator.onLine`, as in the
following example:
```js
if (navigator.onLine) {
console.log("online");
} else {
console.log("offline");
}
```
If the browser doesn't support `navigator.onLine` the above example will
always come out as `false`/`undefined`.
### Listening for changes in network status
To see changes in the network state, use
[`addEventListener`](/en-US/docs/Web/API/EventTarget/addEventListener) to
listen for the events on `window.online` and `window.offline`, as
in the following example:
```js
window.addEventListener("offline", (e) => {
console.log("offline");
});
window.addEventListener("online", (e) => {
console.log("online");
});
```
## Specifications
{{Specifications}}
## Browser compatibility
{{Compat}}