https://github.com/hadiab/styled-easy-mq
Easy media query in 'backticks'
https://github.com/hadiab/styled-easy-mq
emotion media-queries mq styled styled-components
Last synced: about 1 month ago
JSON representation
Easy media query in 'backticks'
- Host: GitHub
- URL: https://github.com/hadiab/styled-easy-mq
- Owner: hadiab
- Created: 2021-07-06T15:05:12.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2021-07-11T06:44:27.000Z (almost 5 years ago)
- Last Synced: 2025-09-24T09:47:48.850Z (9 months ago)
- Topics: emotion, media-queries, mq, styled, styled-components
- Language: TypeScript
- Homepage:
- Size: 13.6 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Styled Easy MQ
Easy media query in `backticks`
[](https://www.npmjs.com/package/styled-easy-mq)
## 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]
```ts
import { createMediaQuery } from 'styled-easy-mq';
const mq = createMediaQuery()
```
You can pass your own breakpoints
```ts
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)
```tsx
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](https://github.com/emotion-js/facepaint)
## Example
With emotion (also work with styled-components)
```tsx
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]};
`
Example
```
## Create Css function
You can create your own css function, so you don't need to wrap every style with css
```tsx
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]};
`
CSS
```
## API
#### createMediaQuery `function`
```ts
createMediaQuery = (breakpoints?: number[]) => (style: StyleObject) => DynamicStyle[]
```
#### createCss `function`
```ts
createCss = (css: (...args: any[]) => string, breakpoints?: number[]) => (style: TemplateStringsArray) => string
```
### You can also use it as an object
```tsx
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](https://marketplace.visualstudio.com/items?itemName=bashmish.es6-string-css)
## Contributing
Please read [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426) for details on our code of conduct, and the process for submitting pull requests to us.
## Versioning
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/your/project/tags).
## Authors
* **Abdalhadi Abdallah** - *Initial work* - [hadiab](https://github.com/hadiab)
See also the list of [contributors](https://github.com/your/project/contributors) who participated in this project.
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details