react-responsive

A distinct way to make your React app responsive. Fast, simple syntax, lightweight and keep your code easy-to-read are the things what its aim for.

Table of content

1. Features
2. Installation
3. Usage
   1. Basic Use
   2. Advanced Use
   3. Caution
4. Props
   1. Wrapper
   2. Breakpoints
5. License

Features

• ✅ Hide components on some devices and show it up on another devices.

• 😎 No need CSS to show/hide component, everything now works automatically. So...say 👋 to display: none and visibility: hidden CSS properties.

• 😱 Create custom screen breakpoints.

Installation

Using NPM:

npm i @dattr/react-responsive

Using Yarn:

yarn add @dattr/react-responsive

Usage

Basic Use

Wrap all Element in App.js file (like provide a Context) and you're good to go:

// App.js 
import React from 'react';
import Responsive from "@dattr/react-responsive";

export default function App(props) {
  return (
    <Responsive>
      ...
    </Responsive>
  );
}

in Component file:

// some-component.jsx
import { Mobile, Tablet } from '@dattr/react-responsive';

export default function Component (props) {
  return (
    <div className='some-classname'>
      <Mobile>
        <h3>This is display on Mobile screen only and not display on larger screen</h3>
      </Mobile>
      
      <Tablet>
        <h3>This is display on Tablet and smaller screen. But not display on larger screen.</h3>
      </Tablet>
      
      <Tablet only>
        <h3>This is display on Tablet screen only and not display on larger screen or smaller screen</h3>
      </Tablet>
      
      <Tablet only andUp>
        <h3>This is display on Tablet and larger screen (opposite to using Tablet with no props), but not display on smaller screen like Mobile</h3>
      </Tablet>
    </div>
  )
}

Advanced Use

Isn't that enough for you? Relax, just use createCustom function and you'll have any screen you want.

The custom components which created by this function have same props as other Breakpoints import from this library.

Create multi Breakpoints:

// some-component.jsx
import { createCustom } from '@dattr/react-responsive';

function Component(props) {
   const [FourK, EightK] = createCustom([
    { minWidth: 3840, maxWidth: 7680 - 1 },
    { minWidth: 7680, maxWidth: Infinity } // Infinity equal andUp prop by default
   ])
   
  return (
    <h3 className='large-screen-text'>
      <FourK only>This is text of h3 tag which display on 4K screen only</FourK>
      <EightK only>This is text of h3 tag which display 8K screen only and up</EightK>
    </h3>
  )
}

export default Component

Create only one Breakpoint:

// some-component.jsx
import { createCustom } from '@dattr/react-responsive';

function Component(props) {
   const [FourK] = createCustom({ minWidth: 3840, maxWidth: 7680 - 1 })
   
  return (
    <h3 className='large-screen-text'>
      <FourK only>This is text of h3 tag which display on 4K screen only</FourK>
    </h3>
  )
}

export default Component

Caution

Do not:

⚠️ Use andUp prop without only prop:

<Tablet andUp>
  <h3>This will display on any screen</h3>
</Tablet>

solution:

✅ Unwrap it instead:

 <h3>This will display on any screen</h3>

✅ Use Any breakpoint for more scene:

<Any>
  <h3>This will display on any screen</h3>
</Any>

Props

Wrapper

Object you import as default from this library.

children?: (any) Take the JSX elements, string, number,... and the Breakpoints (Mobile, Tablet, Laptop,...) that you import from this library.

Breakpoints

Mobile, Tablet, Laptop,... you import as named.

children?: (any) Same as in Wrapper.

only?: (boolean=false) Prevent elements show on screen has width is smaller than breakpoint's min-width. (default breakpoint's min-width: mobile=0px, Tablet=321px, Laptop=769px,...)

andUp?: (boolean=false) Ignore breakpoint's max-width limit. Useful to allow render elements on screens larger than breakpoint limits. (default breakpoint's limits (max-width): Mobile=320px, Tablet=768px, Laptop=1024px,...) Reccommend use with only to avoid elements render on all screen (see the Caution).

AndUpTo?: (number|string)=null Override breakpoint's max-width limit. Take number respresent screen width in pixels (e.g: 1024px), or a string match one of ("mobileS" | "mobileM" | "mobile" | "tablet" | "laptop" | "laptopL"). Example in Basic Use.

License

MIT © dattran1232003