use-visibility-percentage v1.0.2

useVisibilityPercentage

A react hook to measure percentage of element inside the window height (window.innerHeight).

Features

• TypeScript support 🧔
• Lightweight 🐔

Installation

npm i use-visibilty-perctange --save

Or

yarn add use-visibility-percentage

Usage

const [percent, position] = useVisibiltyPercentage(ref, \ * { options } * \)

Basic usage:

import React from 'react'
import useVisibiltyPercentage from 'use-visibilty-percentage'

const Percent = () => {
  const ref = useRef()
  const [percent] = useVisibiltyPercentage(ref)

  return (
    <div
      ref={ref}
      className='box'
      style={{ opacity: percent.toPrecision(2) }}
    />
  )
}

Using optional options:

import React from 'react'
import useVisibiltyPercentage from 'use-visibilty-percentage'

const Percent = () => {
  const ref = useRef()
  const [percent] = useVisibiltyPercentage(ref, {
    offsetTop: 20,
    offsetBottom: 20,
    throttle: 30,
  })

  return (
    <div
      ref={ref}
      className='box'
      style={{ opacity: percent.toPrecision(2) }}
    />
  )
}

Options

Provide these as second argument to hook ( useVisibiltyPerctange(ref, { options }) ).