useConnectionStatus

import { useConnectionStatus } from '@bbc/front-end-kit/vue'

Composable that provides reactive properties to know if the user is connected to the internet or not.

Tips

This composable is a wrapper around the Connections Status utility.

Warning

At this moment the composable is limited to 1 url for the whole codebase.

Should not be an issue in most cases.

Getting started

import { useConnectionStatus } from '@bbc/front-end-kit/vue'

const connectionStatus = useConnectionStatus();

API

Init

useConnectionStatus(url, options)

Parameters

url (optional): The URL to ping for the connection test. Defaults to null — the underlying utility determines the fallback URL.
options (optional): Configuration options
- interval (optional): Time in ms between connection checks. Defaults to 5000.
- timeout (optional): Maximum time in ms to wait for a ping response. Defaults to 3000.
- supressWarnings (optional): Suppress console warnings when the URL has already been set by a previous call. Defaults to false. Note: supress is a known typo in the source — use single p to match.

Single instance

The URL and interval are set on the first call and ignored on all subsequent calls. If a different URL is passed later, a warning is logged (unless supressWarnings is true).