Mq-styled-components NPM

npm bundle size Snyk Vulnerabilities for GitHub Repo

Mq Styled Components

Mq Styled Components is a very simple media query string generator designed to make using the CSS @media directive inside of a Styled Component's CSS rules ultra-easy.

Other similar libraries seem to have taken the approach of generating the entire media query for you, but I found that to be problematic because not only does it look unfamiliar to those who know CSS well, but you also lose the code-completion that your IDE offers.

By inserting a media query string inside of your normal CSS style rules, your code stays clean and you retain the benefits of code-completion.

Breaking in v2.0

You no longer have to include the @media in your style rules. I realized after I created this package that the javascript tagged template literal was as flexible as a regular string template literal, so the returned string from Mq Styled Components can include the entire media query. See below for usage.

Installation

Install using npm:

npm install mq-styled-components

Or yarn:

yarn add mq-styled-components

Usage

Import styled-components and 'Mq' (note the named import):

import styled from 'styled-components';
import { Mq } from 'mq-styled-components';

Then use Mq to retrieve a max-width or min-width media query string within your CSS rules, inserted into a ${...} inside the template string:

const StyledDiv = styled.div`
  display: flex;
  align-items: center;
  justify-content: center;
  ${Mq.max.md} {
    display: none;
  }
`;

The call to Mq.max.md will return the string: '@media (max-width: 768px)' (with the default 'md' breakpoint being 768px). So, for all window-widths less than or equal to 768px, the div will have a display: none css rule applied.

Retrieve max-width media query strings with Mq.max.XX, and min-width media query strings with Mq.min.XX, where 'XX' is one of:

'xs'
'sm'
'md'
'lg'
'xl'

So, for example, to apply rules for window-widths greater than or equal to 'lg' size (which has a default of 992px), you would use a min-width media query, like this:

${Mq.min.lg} {
  /*  Your CSS rules here  */
}

NOTE: All the standard rules of CSS cascading-style rules apply to styled-components. Specifically, if you are setting different rules for different window-widths, the order of your @media directives matters. But you should already know that if you're using Styled Components... right?

Default breakpoints

Mq Styled Components uses the same default breakpoints as Bootstrap.

They are (in pixels):

{
  "xs": 375,
  "sm": 576,
  "md": 768,
  "lg": 992,
  "xl": 1200
}

However, unlike Boostrap, you specify if you want a min-width or a max-width media query string, through the use of Mq.min.XX or Mq.max.XX.

Changing a single breakpoint

NOTE: If you wish to change a breakpoint, you should do so in your application's entry file (i.e. index.js/ts) before any of your component code is run. This will ensure that the breakpoint is updated first, and all subsequent calls to Mq will be using the same breakpoint data, no matter when or from where it is being called.

Changing a single breakpoint value is very easy with the use of Mq Styled Component's 'setBreakpoint' method.

Use it like this:

import { Mq } from 'mq-styled-components';

Mq.setBreakpoint('md', 800);

This changes the 'md' breakpoint to 800.

If you want to change multiple breakpoints, see 'changing multiple breakpoints' here.

Changing multiple breakpoints

NOTE: If you wish to change breakpoints, you should do so in your application's entry file (i.e. index.js/ts) before any of your component code is run. This will ensure that the breakpoints are updated first, and all subsequent calls to Mq will be using the same breakpoint data, no matter when or from where it is being called.

You may wish to change multiple breakpoints all at once. Mq Styled Components makes that easy, too, with the use of the 'setBreakpoints' method.

Use it like this:

import { Mq } from 'mq-styled-components';

Mq.setBreakpoints({  
  lg: 1050,
  xl: 1400
});

'Mq.setBreakpoints' accepts an object whose keys are the breakpoints you wish to change, and whose values are the numerical value (in pixels) you want to change each breakpoint to.
Change just one breakpoint, or change them all -- 'Mq.setBreakpoints' will apply the changes to whichever breakpoints you've specified in the keys of your breakpoints object.

Typescript

Mq Styled Components was written in Typescript, so type definitions are complete and up-to-date.

Running tests

Steps to run tests:

Clone the Github repo:
git clone https://github.com/varunj166/mq-styled-components.git
Install dependencies:
npm install
Run test suites:
npm test