Skip to Content
APIReactuseOnConnectivityChange

useOnConnectivityChange

Hook that fires callbacks on connectivity state transitions.

Signature

function useOnConnectivityChange(handlers: ConnectivityChangeHandlers): void;
 
type ConnectivityChangeHandlers = Partial<
  Record<'online' | 'offline' | 'unknown', (transition: ConnectivityTransition) => void>
>;
 
interface ConnectivityTransition {
  from: ConnectivityStatus;
  to: ConnectivityStatus;
  duration: number; // ms the previous state lasted
};

Parameters

FieldTypeDescription
online(transition) => voidCalled on transition to online
offline(transition) => voidCalled on transition to offline
unknown(transition) => voidCalled on transition to unknown

All handlers are optional. Inline functions are safe — no re-subscription (ref pattern).

Example

useOnConnectivityChange({
  offline: () => toast.warning('Connection lost'),
  online: (transition) => {
    if (transition.duration > 60_000) {
      dialog.open(ReconnectedNotice);
      return;
    }
    toast.success('Back online');
  },
});

Not called on initial mount — only on actual state transitions.

Last updated on
useConnectivityuseAction