1.0.1 • Published 3 years ago

use-responsive-react v1.0.1

Weekly downloads
-
License
MIT
Repository
github
Last release
3 years ago

use-responsive-react

React hook for responsive design

NPM JavaScript Style Guide

Install

npm install --save use-responsive-react
yarn add use-responsive-react

Usage

import { useResponsive } from 'use-responsive-react'

const Example = () => {
    const { width, screenSize } = useResponsive

    return (
        <div>
            <h1>Render responsive</h1>
            // Get screenSize
            {screenSize === 'md'
                ? <MdComponent />
                : <LgComponent />
            }
            // Get Width
            {width < 800
                ? <MdComponent />
                : <LgComponent />
            }
        </div>
    )
}

Documentation

PropsTypeDesription
widthIntScreen width
heightIntScreen height
orientationStringScreen orientation
screenSizeStringLargest screen size
screenSizesArrayAll screen sizes
defineBreakpointsFuncDefine your custom breakpoints
breakpointsShapeDefined breakpoints

Define your own breakpoints

import { useResponsive } from 'use-responsive-react'

const Example = () => {
    const { defineBreakpoints } = useResponsive
    
    defineBreakpoints({
        xs: 0,
        sm: 600,
        md: 960,
        lg: 1280,
        xl: 1920
    })
}

License

MIT © maximegouin