1.0.0 • Published 4 years ago

simple-react-responsive v1.0.0

Weekly downloads
-
License
ISC
Repository
github
Last release
4 years ago

Simple React Responsive

A simple React component for media query breakpoints.

Install

NPM

$ npm i simple-react-responsive

Yarn

$ yarn add simple-react-responsive

Usage

After installing, Wrap the root component in . This will provide the default breakpoints inside your app.

Example

import React from 'react'
import { ResponsiveBreakpointsProvider } from 'simple-react-responsive'

const App = () => {
    return (
        <ResponsiveBreakpointsProvider>
        // ...all your other components here
        </ResponsiveBreakpointsProvider>
    )
}

export default App

Then use component to wrap any component to make it responsive.

Example

The following code will render the only in devices with screen size larger than mobile devices.

<Responsive
    type="above"
    screen="mobile"
>
    <MyComponent>
</Responsive>

Custom Breakpoints

You can define your own breakpoints when you use the like

const customBreakpoints = {
    mobile: 0,
    tablet: 768,
    desktop: 992,
    largeScreen: 1200,
    wideScreen: 1920
}

return (
    <ResponsiveBreakpointsProvider breakpoints={customBreakpoints}>
    // ...all your other components here
    </ResponsiveBreakpointsProvider>
)

Props

You can pass the following props in the component

NameExpected valuesDefault
type"below", "only" or "above""above"
screen"mobile", "tablet", "desktop", "largeScreen", "wideScreen""mobile"
1.0.0

4 years ago