facetat - a 1.5kb library for writing responsive styles for CSS-in-Js framework

If you're a user of styled-component, emotion, or other CSS-in-Js frameworks, you probably have written tons of media queries in JavaScript. You may have even used facepaint for organizing and simplifying your media queries.

However, facepaint has its own limitations. For example, there is no explicit name for each media query, which reduces the readability of your code. Also, you need to write styles for all media sizes, even if you want to apply a style only to say, desktop device.

Here comes facetat - a neater and more efficient way to write responsive styles for CSS-in-Js libraries.

Installation

npm install facetat // or
yarn add facetat

Usage

Initialization

import facetat from 'facetat';

// Initialize
const mq = facetat(
  // A breakpoint map from string to number that can be of any size.
  // You can name them anything as your want.
  // e.g. { mobile: 1, phablet: 2, tablet: 3, laptop: 5, desktop: 6 }
  { XS: 1, SM: 2, MD: 3, LG: 5, XL: 6 },
  // The default unit when a unitless number is specified.
  // Accept rem, em, px, or other valid css units
  { unit: 'rem' }
);

Single-media Form

// Expected Result:
//
// @media (min-width: 1rem) {
//   [className] {
//     width: 100rem;
//   }
// }

// Usage:
//
// CSS function from any CSS-in-Js libraries, for example, emotion
import { css } from '@emotion/core';

const style = mq.XS(
  css`
    width: 100rem;
  `
);

// Shortcut of the above
const style = mq.XS`width: 100rem;`;

// Plain Javascript object
const style = mq.XS({ width: 100 });

Single-property Form

// Expected Result:
//
// @media (min-width: 1rem) {
//   [className] {
//     width: 100rem;
//   }
// }
// @media (min-width: 1rem) and (max-width: 2rem) {
//   [className] {
//     width: 200rem;
//   }
// }

// Usage:
//
// Plain Javascript object
const style = mq.width(null, 100, '200rem');

Chaining Form

// Expected Result:
//
// [className] {
//   width: 50px;
// }
// @media (min-width: 1rem) {
//   [className] {
//     width: 100rem;
//   }
// }
// @media (min-width: 1rem) and (max-width: 2rem) {
//   [className] {
//     width: 200rem;
//   }
// }

// Usage:
//
// Emotion css object
const style = mq(
  css`
    width: 50px;
  `,
  css`
    width: 100rem;
  `,
  css`
    width: 200rem;
  `
);

// Plain Javascript object
const style = mq({ width: '50px' }, { width: 100 }, { width: '200rem' });

Compact Form

// Expected Result:
//
// [className] {
//   width: 50px;
// }
// @media (min-width: 1rem) {
//   [className] {
//     width: 100rem;
//   }
// }
// @media (min-width: 1rem) and (max-width: 2rem) {
//   [className] {
//     width: 200rem;
//   }
// }

// Usage:
//
const style = mq({ width: ['50px', 100, '200rem'] });

Editor Support

VSCode

When used with typescript-styled-plugin, please add mq to the list of formatting-eligible tagged template literals.

{
  "compilerOptions": {
    "plugins": [
      {
        "name": "typescript-styled-plugin",
        "tags": ["styled", "css", "mq"]
      }
    ]
  }
}

Support

This library has been continuously used in many of my personal projects, and is regarded as production-ready. In the foreseeable future, I will continuously maintain and support this library.

Issues and Feedback

Please voice your opinion and report bugs in the issues sections of this GitHub project.

Contributing

You are more than welcome to add more functionalities, improve documentation, fix bugs, and anything you think is needed. The build step is pretty self-explanatory. Please refer to CONTRIBUTING.md for more details.

License

MIT

Project Homepage

https://github.com/billykwok/facetat