Styled Easy MQ

Easy media query in backticks

Install

npm install styled-easy-mq

or

yarn add styled-easy-mq

Usage

Create a media query function, By default the breakpoints are [576, 768, 992, 1200]

import { createMediaQuery } from 'styled-easy-mq';

const mq = createMediaQuery()

You can pass your own breakpoints

const br = [500, 700, 900, 1100] // or ["20em", "30em", "50em", "70em"]

const mq = createMediaQuery(br)

Use media query

Passing an array with values for each breakpoint (mobile first)

mq`
	width: ${[300, 600, 900]};
	color: ${["red", "blue"]};
	background-color: white;
`

I'm using facepaint to generate media query for each property that have an array value, the first value is considered a default value and is not a child of a media query, learn more about facepaint

Example

With emotion (also work with styled-components)

import { createMediaQuery } from "styled-easy-mq"
import { css } from "emotion"

const mq = createMediaQuery()

const style = mq`
	display: flex;
	flex-direction: ${["column", "row"]};
	padding: ${[10, 20, 30, 40]};
`

<div className={css(style)}>Example</div>

Create Css function

You can create your own css function, so you don't need to wrap every style with css

import { createCss } from "styled-easy-mq"
import { css as emotion } from "emotion"

const css = createCss(emotion)

const className = css`
	display: flex;
	flex-direction: ${["row", "column"]};
	margin: ${[10, 30]};
`

<div className={className}>CSS</div>

API

createMediaQuery function

createMediaQuery = (breakpoints?: number[]) => (style: StyleObject) => DynamicStyle[]

createCss function

createCss = (css: (...args: any[]) => string, breakpoints?: number[]) => (style: TemplateStringsArray) => string

You can also use it as an object

mq({
	width: [300, 600, 900];
	color: ["red", "blue"];
	backgroundColor: "white"
})

it's the default way of how facepaint work, this library was intended to make the using of media query in string much easier, so if you only will use the object syntax you don't need this library, facepaint is enough

Syntax Highlighting

If you didn't get any syntax highlighting that's because styled-components plugin support these alises (styled, css)

• One option is to change the var name from mq to styled, css or even xstyled
• Another option is to use es6-string-css it's VS Code plugin, learn more

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Abdalhadi Abdallah - Initial work - hadiab

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details