useIsMobile() — ui Function Reference

Architecture documentation for the useIsMobile() function in use-mobile.ts from the ui codebase.

Function typescript DocumentationAtlas Changelog

Entity Profile

DocumentationAtlas→ Changelog→ useIsMobile() — ui Function Reference

Dependency Diagram

graph TD
  44bced75_36a4_1c02_c35d_cd9e1f4f68f4["useIsMobile()"]
  e80c5e72_45e0_4456_ae4f_11c6734d40c3["use-mobile.ts"]
  44bced75_36a4_1c02_c35d_cd9e1f4f68f4 -->|defined in| e80c5e72_45e0_4456_ae4f_11c6734d40c3
  style 44bced75_36a4_1c02_c35d_cd9e1f4f68f4 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

apps/v4/hooks/use-mobile.ts lines 3–17

export function useIsMobile(mobileBreakpoint = 768) {
  const [isMobile, setIsMobile] = React.useState<boolean | undefined>(undefined)

  React.useEffect(() => {
    const mql = window.matchMedia(`(max-width: ${mobileBreakpoint - 1}px)`)
    const onChange = () => {
      setIsMobile(window.innerWidth < mobileBreakpoint)
    }
    mql.addEventListener("change", onChange)
    setIsMobile(window.innerWidth < mobileBreakpoint)
    return () => mql.removeEventListener("change", onChange)
  }, [mobileBreakpoint])

  return !!isMobile
}