Skip to content

useOnline

Category
Export Size
979 B
Last Changed
3 weeks ago

Reactive online state. A wrapper of useNetwork.

Demo

Disconnect your network to see changes
Status: Online

Usage

ts
import { 
useOnline
} from '@vueuse/core'
const
online
=
useOnline
()

Component Usage

This function also provides a renderless component version via the @vueuse/components package. Learn more about the usage.

vue
<template>
  <UseOnline v-slot="{ 
isOnline
}">
Is Online: {{
isOnline
}}
</UseOnline> </template>

Type Declarations

ts
/**
 * Reactive online state.
 *
 * @see https://vueuse.org/useOnline
 * @param options
 *
 * @__NO_SIDE_EFFECTS__
 */
export declare function 
useOnline
(
options
?:
ConfigurableWindow
,
):
Readonly
<
ShallowRef
<boolean>>

Source

SourceDemoDocs

Contributors

Anthony Fu
SerKo
Anthony Fu
vaakian X
Mike Jules
wheat
Alex Kozack
Antério Vieira

Changelog

v13.6.0 on
d32f8 - refactor: add @__NO_SIDE_EFFECTS__ annotations to all pure functions (#4907)
v12.0.0-beta.1 on
0a9ed - feat!: drop Vue 2 support, optimize bundles and clean up (#4349)

Released under the MIT License.

FREE WEEKEND
48 Hours of Unlimited Official Vue.js Certification Training
Reserve Your Spot
23-24 August