Skip to content

Commit

Permalink
init
Browse files Browse the repository at this point in the history
  • Loading branch information
SassNinja committed Jun 21, 2018
0 parents commit c76adbe
Show file tree
Hide file tree
Showing 11 changed files with 485 additions and 0 deletions.
9 changes: 9 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# general
.DS_Store
node_modules

# prefer npm
yarn.lock

# exclude unit testing output
test/output
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2018

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
159 changes: 159 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,159 @@
# Media Query Plugin

Have you ever thought about extracting your media queries from your CSS so a mobile user doesn't have to load desktop specific CSS?
If so this plugin is what you need!

When writing CSS with the help of a framework (such as [Bootstrap](https://getbootstrap.com/) or [Foundation](https://foundation.zurb.com/sites.html)) and with a modular design pattern you'll mostly end up with CSS that contains all media queries. Using this plugin lets you easily extract the media queries from your CSS and load it async.

So instead of forcing the user to load this

```css
.foo { color: red }
@media print, screen and (min-width: 75em) {
.foo { color: blue }
}
.bar { font-size: 1rem }
```

he only has to load this always

```css
.foo { color: red }
.bar { font-size: 1rem }
```

and on desktop viewport size this in addition

```css
@media print, screen and (min-width: 75em) {
.foo { color: blue }
}
```


## Prerequisites

You should already have a working webpack configuration before you try to use this plugin. If you haven't used webpack yet please go through the [webpack guide](https://webpack.js.org/guides/) first and start using this awesome tool for your assets mangement!

## Installation

Simply install the package with your prefered package manager.

- npm
```bash
npm install media-query-plugin --save-dev
```

- yarn
```bash
yarn add media-query-plugin --dev
```

## Let's get started

### 1. Loader

The plugin comes together with a loader which takes care of the CSS extraction from the source and provides it for the injection afterwards. You are able to override the plugin options via the loader options. But usually this shouldn't be necessary and can be left empty.

**Important:** make sure the loader receives plain CSS so place it between the css-loader and the sass-loader/less-loader.

```javascript
const MediaQueryPlugin = require('media-query-plugin');

module.exports = {
module: {
rules: [
{
test: /\.scss$/,
use: [
MiniCssExtractPlugin.loader,
'css-loader',
MediaQueryPlugin.loader,
'postcss-loader',
'sass-loader'
]
}
]
}
};
```

### 2. Plugin

Add the plugin to your webpack config. It will inject the extracted CSS of the loader after the compilation.
The two options `include` and `queries` are required for the plugin to work and get explained later.

```javascript
const MediaQueryPlugin = require('./plugins/media-query-plugin');

module.exports = {
plugins: [
new MediaQueryPlugin({
include: [
'example'
],
queries: {
'print, screen and (min-width: 75em)': 'desktop'
}
})
]
};
```

### 3. Extracted Files

If you use dynamic imports, webpack will try to resolve that import and throw an error if the file does not exist. Thus you have to create those empty files manually in the same folder(s) as the source file which generates the CSS.

**Important:** the names of those files must follow the pattern `[source name]-[query name]` so an example file could be `example-desktop.scss`. If you don't do this the plugin will extract the specified media queries from the source file but not inject them anywhere.

Afterwards you can simply do this in your JavaScript and webpack will take care of the rest for you

```javascript
import(/* webpackChunkName: 'example' */ './example.scss');

if (window.innerWidth >= 1200) {
import(/* webpackChunkName: 'example-desktop' */ './example-desktop.scss');
}
```

## Options

As mentioned earlier there are two options required (either via plugin or via loader options)

### include

Each chunk (which uses the loader) gets checked if its name matches this option. In case of a match each query specified in the `queries` options gets extracted from the chunk.

Possible types
- array (e.g. `[example]`)
- regex (e.g. `/example/`)
- boolean (e.g. `true`)

### queries

This option tells the plugin which media queries are supposed to get extracted. If a media query doesn't match it'll stay untouched. Otherwise it gets extracted and afterwards injected into the chunk with the name `[source name]-[query name]`.

**Important:** make sure the keys match 100% the source CSS excl the `@media`.

**Tip:** you can use the same name for different media queries to concatenate them (e.g. desktop portrait and desktop landscape)

```javasript
queries: {
'print, screen and (max-width: 60em) and (orientation: portrait)': 'desktop',
'print, screen and (max-width: 60em) and (orientation: landscape)': 'desktop'
}
```

## Not using webpack?

This plugin is built for webpack only and can't be used with other module bundlers (such as [FuseBox](https://fuse-box.org/)) or task runners (such as [Gulp](https://gulpjs.com/)). However if you can't or don't want to use webpack but nevertheless want to extract media queries you should check out my [PostCSS plugin](https://github.com/SassNinja/postcss-extract-media-query) which supports much more tools.

However it also breaks out of the bundler/runner and emits files within the PostCSS plugin which will ignore all other pipes in your task.
So it's highly recommended to use this webpack plugin instead of the PostCSS alternative!

## Contribution

This plugin has been built because I wasn't able to find a webpack solution for such a trivial task of loading media queries async. It works for my use cases by I'm pretty sure it can get more improved. So if you miss any feature don't hesitate to create an issue as feature request or to create a PR to do the job.

**And last but not least, if you like this plugin please give it a star on github and share it!**

97 changes: 97 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

29 changes: 29 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
{
"name": "media-query-plugin",
"version": "0.0.1",
"description": "Webpack plugin for media query extraction.",
"author": "Kai Falkowski",
"license": "MIT",
"main": "src/index.js",
"scripts": {
"test": "mocha"
},
"keywords": [
"webpack",
"plugin",
"loader",
"mediaquery",
"extract",
"split",
"css"
],
"dependencies": {
"loader-utils": "^1.1.0",
"postcss": "^6.0.22"
},
"devDependencies": {},
"repository": {
"type": "git",
"url": "https://github.com/SassNinja/media-query-plugin.git"
}
}
9 changes: 9 additions & 0 deletions src/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@

const loader = require('./loader');
const plugin = require('./plugin');

// provide easy access to the loader
plugin.loader = require.resolve('./loader');

// export default webpack plugin
module.exports = plugin;
39 changes: 39 additions & 0 deletions src/loader.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@

const { getOptions, interpolateName } = require('loader-utils');
const postcss = require('postcss');
const store = require('./store');
const plugin = require('./postcss');

module.exports = function(source) {

// make loader async
const cb = this.async();

// merge loader's options with plugin's options from store
const options = Object.assign(store.options, getOptions(this));

// basename gets used later for key in media query store
options.basename = interpolateName(this, '[name]', { content: '' });

let isIncluded = false;

// check if current file should be affected
if (typeof options.include === 'object' && options.include.indexOf(options.basename) > -1) {
isIncluded = true;
} else if (options.include instanceof RegExp && options.basename.match(options.include)) {
isIncluded = true;
} else if (options.include === true) {
isIncluded = true;
}

// return (either modified or not) source
if (isIncluded === true) {
postcss([ plugin(options) ])
.process(source, { from: options.basename })
.then(result => {
cb(null, result.toString())
});
} else {
cb(null, source);
}
};
Loading

0 comments on commit c76adbe

Please sign in to comment.