@zimi/hooks v0.18.4

@zimi/hooks

install

yarn add  @zimi/hooks

examples

useCombinedRefs
useElementRect
useListen
useLoading
useRafLoop
useSimulateClick
useWarnBeforeUnload
useWindowSize

useCombinedRefs

see https://itnext.io/reusing-the-ref-from-forwardref-with-react-hooks-4ce9df693dd

const MeaturedInput = forwardRef<HTMLInputElement>((props, ref) => {
  const innerRef = useCombinedRefs(ref)

  useEffect(() => {
    console.log(innerRef.current?.getBoundingClientRect())
  }, [innerRef])

  return <input ref={innerRef} />
})

↑ all examples ↑

useElementRect

function Test() {
  const ref = useRef<HTMLElement>(null)
  const rect = useElementRect(ref)

  return <div ref={ref}>
    hello world
  </div>
}

// or

// out of component
const element = document.querySelector('xxx')

function Test() {
  const rect = useElementRect(element)
}

↑ all examples ↑

useListen

function Test() {
  const [count, setCount] = useState(0)

  // will be triggered when count changed
  useListen(count, (prev, next) => {
    console.log(prev, next)
  })
}

↑ all examples ↑

useLoading

function Test() {
  const [loading, withLoading] = useLoading()

  const { data } = useSWR('xxx', withLoading(asyncTask1))

  return <>
    <Spin spinning={loading} />

    <Button
      onClick={withLoading(asyncTask2)}
    >
      async task
    </Button>
  </>
}

↑ all examples ↑

useRafLoop

import { useRafLoop } from '@zimi/hooks'

function Test() {
  const now = useRafLoop(() => Date.now())

  return <>{now}</>
}

// or

function Test() {
  const [visibility, setVisibility] = useState(true)

  useRafLoop(() => {
    console.log('rendering...')
  }, {
    enable: visibility,
  })

  return <>
    <p>visibility: {visibility}</p>
    <button onClick={() => {
      setVisibility((prev) => !prev)
    }}>
      toggle visibility
    </button>
  </>
}

↑ all examples ↑

useSimulateClick

function Test() {
  const setClickElem = useSimulateClick({
    onClick: () => {
      console.log('strictly clicked.')
    },
  })

  return (
    <Button ref={setClickElem}>
      Click Me
    </Button>
  )
}

↑ all examples ↑

useWarnBeforeUnload

function Test() {
  // show a confirmation dialog before page unload (beforeunload event, NOT component unload)
  // https://developer.mozilla.org/en-US/docs/Web/API/Window/beforeunload_event
  useWarnBeforeUnload()
}

↑ all examples ↑

useWindowSize

function Test() {
  const innerSize = useWindowSize('inner')
  const outerSize = useWindowSize('outer')
}

↑ all examples ↑