Code Monkey home page Code Monkey logo

simple-react-responsive's Introduction

Simple Responsive React

A simple React component for media query breakpoints.

Install

NPM

$ npm i simple-responsive-react

Yarn

$ yarn add simple-responsive-react

Usage

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

Example

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

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

export default App

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

Example

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

import Responsive from 'simple-responsive-react'

...

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

Custom Breakpoints

You can define your own breakpoints when you use the "ResponsiveBreakpointsProvider" like this :

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 "Responsive" component :

Name Expected values Default
type "below", "only" or "above" "above"
screen "mobile", "tablet", "desktop", "largeScreen", "wideScreen" "mobile"

Please star the repo if it helped you!

simple-react-responsive's People

Contributors

webdevavi 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.