openmrs-esm-core

O3 Framework / useConnectivity

Function: useConnectivity()

useConnectivity(): boolean

Defined in: packages/framework/esm-react-utils/src/useConnectivity.ts:22

A React hook that returns the current online/offline status and automatically updates when connectivity changes. Useful for showing offline indicators or conditionally rendering UI based on network availability.

Returns

boolean

true if the browser is online, false if offline.

Example

import { useConnectivity } from '@openmrs/esm-framework';
function NetworkStatus() {
  const isOnline = useConnectivity();
  return <span>{isOnline ? 'Online' : 'Offline'}</span>;
}