README.md

PostCSS Retina

PostCSS plugin for transform retina border by scale-box on mobile.

• Automatically transform your border in retina without change anything.
• support border-radius and color.
• it's easy to remove it to use other way such as lib-flexible

How It Works

use a ::before element to create a scale border and replace the origin.

Example

a simple page to show the document structure

before:

.foo {
  color: white;
  border: 1px solid red;
}

after:

.foo {
  color: white;
  /* in v1.2.0+ `position` will add/update at origin  */
  position: relative; 
}

.foo::before {
  border: 1px solid red;
}

.foo::before {
  content: ' ';
  position: absolute;
  width: 100%;
  height: 100%;
  top: 0;
  left: 0;
  pointer-events: none;
  box-sizing: border-box;
  font-size: 100px;
}

/* dpr is 2 */

@media only screen and (-webkit-min-device-pixel-ratio: 2), 
only screen and (min-device-pixel-ratio: 2) {
  .foo::before {
    transform: scale(0.5);
    transform-origin: 0 0;
    width: 200%;
    height: 200%;
    font-size: 200px;
  }
}

/* dpr is 3 */

@media only screen and (-webkit-min-device-pixel-ratio: 3), 
only screen and (min-device-pixel-ratio: 3) {
  .foo::before {
    transform: scale(0.333333);
    transform-origin: 0 0;
    width: 300%;
    height: 300%;
    font-size: 300px;
  }
}

Install

npm install --save-dev postcss-retina

Usage

postcss([ require('postcss-retina') ])

Notice

• make sure your box is not a pseudo-class.

/* WILL NOT to be transformed */
.wrong::before {
  border: 1em;
}
/* WILL NOT to be transformed */
.wrong::after {
  border: 1em;
}

• make sure your border and border-radius use px unit.

/* WILL be transformed */
.right {
  border: 1px;
}
/* WILL NOT be transformed */
.wrong {
  border: 1em;
}

• border-radius will not be transformed if there is not a border declare in same rule.

.foo {
  border: 1px solid red;
}
.bar {
  /* radius WILL NOT to be transformed */
  border-radius: 2px;
}

.foo {
  border: 1px solid red;
  /* radius WILL to be transformed */
  border-radius: 2px;
}

In v1.1.0+ you can comment /*retina*/ to mark it need to be transformed.

<div class="foo bar1"><div>
<div class="foo bar2"><div>

.foo {
  border: 1px solid red;
}
.bar1 {
  border-radius: 2px; /*retina*/
}
.bar2 {
  border-radius: 4px; /*retina*/
}

• if your don't need transform any border, try to do like:

.foo {  
  border: 1px solid red; /*no*/ 
}

See PostCSS docs for examples for your environment.