@solid-primitives/connectivity


A navigator.onLine signal that tells you when the browser _thinks_ you're online. Connectivity is determined by your browser, which is a best-effort process.

- makeConnectivityListener - Attaches event listeners and fires callback whenever window.onLine changes.
- createConnectivitySignal - A signal representing the browser's interpretation of whether it is on- or offline.

Installation

``bash
npm install @solid-primitives/connectivity


or


yarn add @solid-primitives/connectivity
`

makeConnectivityListener

Attaches event listeners and fires callback whenever window.onLine changes.

`ts
import { makeConnectivityListener } from "@solid-primitives/connectivity";

const clear = makeConnectivityListener(isOnline => {
console.log(isOnline); // T: booelan
});
// remove event listeners (happens also on cleanup)
clear();
`

$3

`ts
function makeConnectivityListener(callback: (isOnline: boolean) => void): VoidFunction;
`

createConnectivitySignal

A signal representing the browser's interpretation of whether it is on- or offline.

`ts
import { createConnectivitySignal } from "@solid-primitives/connectivity";

const isOnline = createConnectivitySignal();
isOnline(); // T: boolean
`

$3

This primitive provides a singleton root variant that will reuse event listeners and signals across dependents.

It's behavior is the same as createConnectivitySignal.

`ts
import { useConnectivitySignal } from "@solid-primitives/connectivity";

const isOnline = useConnectivitySignal();
isOnline(); // T: boolean
`

$3

`ts
function createConnectivitySignal(): Accessor;
``

Demo

https://codesandbox.io/s/solid-primitives-connectivity-demo-2m76q?file=/index.tsx

Changelog

See CHANGELOG.md