svelte-connection-status v1.1.0

svelte-connection-status

Basic Svelte component and stores to detect offline & online changes.

Uses navigator.onLine API and makes ping requests (if page is visible) to be sure of the connection status. You can disable pinging or chage its settings: interval, url.

• svelte-connection-status
  • Installation
  • Usage
    • component
    • stores
  • Settings
    • default
    • disable ping
    • ping params

Installation

yarn add svelte-connection-status -T
# or:
npm i svelte-connection-status -E

Usage

component

<script>
  import { ConnectionStatus } from 'svelte-connection-status';

  function handleChange({ detail }) {
    if (detail.isOffline) {
      console.log('>>> you are offline');
    }

    if (detail.isOnline) {
      console.log('>>> you are online');
    }
  }
</script>

<p>
  you are
  <ConnectionStatus on:change={handleChange}>
    <span slot="offline">offline :(</span>
    <span slot="online">online :)</span>
  </ConnectionStatus>
</p>

stores

<script>
  import { isOffline } from 'svelte-connection-status';
</script>

<p>you are {$isOffline ? 'offline :(' : 'online :)'}</p>

<script>
  import { isOnline } from 'svelte-connection-status';
</script>

{#if !$isOnline}
  <p>check your network settings...</p>
{:else}
  <p>hello there</p>
{/if}

Settings

default

{
  usePing: true,
  interval: 7000,
  url: 'https://github.com/sveltejs/svelte/blob/master/package.json',
}

disable ping

import { setSettings } from 'svelte-connection-status';
import App from './App.svelte';

setSettings({
  usePing: false;
});

const app = new App({
  target: document.body,
});

export default app;

ping params

import { setSettings } from 'svelte-connection-status';
import App from './App.svelte';

setSettings({
  interval: 5000,
  url: 'https://www.google.com',
});

const app = new App({
  target: document.body,
});

export default app;