bofeiw / minimum-window-size

Minimum Window Size library is a React library that prevents users with small window size from using your React app and visually hints users to adjust window size.

Home Page:https://www.npmjs.com/package/minimum-window-size

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Minimum Window Size library is a React library that prevents users with small window size from using your React app and visually hints users to adjust window size.

Demo

demo gif It hides the content when window size is small and shows the content when the window resizes to required size.

Install

npm i minimum-window-size

or

yarn add minimum-window-size

Usage

import React from 'react'

import MinimumWindowSize from "minimum-window-size";

const App = () => {
    return <MinimumWindowSize width={1200} height={768}>
        <YourComponent/>
    </MinimumWindowSize>
}

export default App

Simply import the library and wrap your components. Index should be the out-most component. width and height attributes describes the breakpoints at where your component should display. You can omit one or both of the attribute and by default they are set to 0.

Run example locally

npm i
cd example
yarn install
yarn start

An example React project is provided in the example/ folder if you want to see the exapmle usage.

About

Minimum Window Size library is a React library that prevents users with small window size from using your React app and visually hints users to adjust window size.

https://www.npmjs.com/package/minimum-window-size


Languages

Language:JavaScript 59.7%Language:HTML 22.6%Language:CSS 17.7%