moeka-project/.agents/skills/vueuse-functions/references/useOnline.md

category

category
Sensors

useOnline

Reactive online state. A wrapper of useNetwork.

Usage

import { useOnline } from '@vueuse/core'

const online = useOnline()

Component Usage

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

Type Declarations

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