Skip to content

useOnline

Category
Export Size
900 B
Last Changed
7 months ago

Reactive online state. A wrapper of useNetwork.

Demo

Disconnect your network to see changes
Status: Online

Usage

js
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

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

Source

SourceDemoDocs

Contributors

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

Changelog

v12.0.0-beta.1 on
0a9ed - feat!: drop Vue 2 support, optimize bundles and clean up (#4349)

Released under the MIT License.