Skip to content

useNetworkStatus

Interface

ts
function useNetworkStatus(): NetworkStatus;

Parameters

Return Value

  • NetworkStatus

    status information

    • effectiveType

      Connection quality
      : 'slow-2g' | '2g' | '3g' | '4g' - type - Physical connection
      : 'wifi' | 'cellular' | 'ethernet' | etc. - downlink - Downlink speed in Mbps - rtt - Round-trip time in milliseconds - saveData - User's data saver preference.

Example

tsx
```tsxp
function AdaptiveImage() {
  const { effectiveType, saveData } = useNetworkStatus();

  // Determine quality based on your app's needs
  const useHighQuality = effectiveType === '4g' && !saveData;

  return (
    <img
      src={useHighQuality ? 'high-res.jpg' : 'low-res.jpg'}
      alt="Content"
    />
  );
}

Released under the MIT License.