0.1.0 • Published 12 months ago

use-connection-state v0.1.0

Weekly downloads
-
License
ISC
Repository
github
Last release
12 months ago

Connection state hook npm npm type definitions

React hook to detect online and offline network state.

You can play with it yourself here filipchalupa.cz/use-connection-state.

Installation

npm install use-connection-state

Usage

import { useConnectionState } from 'use-connection-state'

const App = () => {
	const connection = useConnectionState()

	return (
		<main>
			<h1>Connection state</h1>
			<p>Online: {connection === 'online' ? 'yes' : 'no'}</p>
		</main>
	)
}

Endpoints

import { createUseConnectionStateHook } from 'use-connection-state'

// Add endpoints to detect connection state. The library will try to fetch these endpoints.
const useConnectionStateWithEndpoints = createUseConnectionStateHook({
	endpoints: [location.href, 'https://www.google.com'],
})

const App = () => {
	const connection = useConnectionStateWithEndpoints()

	return (
		<main>
			<h1>Connection state</h1>
			<p>Online: {connection === 'online' ? 'yes' : 'no'}</p>
		</main>
	)
}

Development

  • Install dependencies: npm ci
  • Run: npm run dev
0.1.0

12 months ago

0.0.2

12 months ago

0.0.1

12 months ago