Giter Club home page Giter Club logo

react-page-fitter's Introduction

react-page-fitter

Release Status Minzip Size License: MIT

This is a React hooks that observe HTML element fits within the current viewport or element.
It's the for building more complex UI.

Installation

npm install react-page-fitter

Usage

import useFitter from 'react-page-fitter'

function MyComponent() {
  const isFit = useFitter('.style')

  return (
    <div>
      {isFit && <CustomComponents />}
    </div>
  )
}

API

useFitter (argument, options)
return value boolean | undefined.

Returns undefined if an invalid argument is passed.

Argument

Parameter Meaning
target (required) The judgement target element by tag, className or id

Options(object)

Field Key
offsetX Horizontal viewport offsetX number when not using parentBox, The default value is 0
offsetY Vertical viewport offsetY number when not using parentBox, The default value is 0
parentBox The judgement parentBox element by tag, className or id is judged in place of the viewport, default undefined

License

The MIT License.

react-page-fitter's People

Contributors

refirst11 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.