Logoreact-pre-hooks
DocumentationDocumentationContributionContribution (opens in a new tab)
GitHubGitHub (opens in a new tab)
  • Getting Started
    • useAnimationFrame
    • useArray
    • useAsyncCallback
    • useAudioAnalyser
    • useBoolean
    • useClickAway
    • useClipboard
    • useClock
    • useCounter
    • useDebouncedState
    • useDragAndDrop
    • useEventListener
    • useFileDropArea
    • useForceUpdate
    • useFullscreen
    • useGamepad
    • useGeolocation
    • useGridLayout
    • useIntersectionObserver
    • useInterval
    • useInView
    • useIsomorphicEffect
    • useKeyboard
    • useLocalStorage
    • useMediaDevices
    • useMediaQuery
    • useMousePosition
    • useMutationObserver
    • useNetworkState
    • useOrientation
    • usePageVisibility
    • usePointers
    • usePreferredLanguage
    • useRect
    • useResizeObserver
    • useScreenCapture
    • useScrollDirection
    • useScrollPosition
    • useScrollThreshold
    • useSelection
    • useSessionStorage
    • useSwiping
    • useTimeout
    • useToggle
    • useViewport
    • useWorker

On This Page

  • Type Definitions
Question? Give us feedback → (opens in a new tab)Edit this page on GitHub →View source code
Documentation
Hooks
useNetworkState

useNetworkState

Handle the NetworkInformation (opens in a new tab) API and the user network connection changes.

Status

Online

warning

Some network informations may not supported in other browsers. checkout Browser compatibility (opens in a new tab)

Type Definitions

type NetworkInformation = {
    type?: 'bluetooth' | 'cellular' | 'ethernet' | 'none' | 'wifi' | 'wimax' | 'other' | 'unknown';
    rtt?: number;
    downlink?: number;
    downlinkMax?: number;
    effectiveType?: 'slow-2g' | '2g' | '3g' | '4g';
    saveData?: boolean;
};
 
const useNetworkState: () => NetworkInformation & {
    isOnline: boolean;
};
useMutationObserveruseOrientation

© Copyright 2023-2024 Malki Abderrahmane