Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/guybedford/require-css
A RequireJS CSS loader plugin to allow CSS requires and optimization
https://github.com/guybedford/require-css
Last synced: about 2 months ago
JSON representation
A RequireJS CSS loader plugin to allow CSS requires and optimization
- Host: GitHub
- URL: https://github.com/guybedford/require-css
- Owner: guybedford
- License: mit
- Created: 2012-05-21T14:53:37.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2020-10-20T21:34:29.000Z (almost 4 years ago)
- Last Synced: 2024-07-19T01:17:26.741Z (2 months ago)
- Language: JavaScript
- Homepage:
- Size: 347 KB
- Stars: 983
- Watchers: 57
- Forks: 364
- Open Issues: 50
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
require-css
===========
RequireJS CSS requiring and optimization, with almond support.
Useful for writing modular CSS dependencies alongside scripts.
For LESS inclusion, use [require-less](https://github.com/guybedford/require-less), which behaves and builds the css exactly like this module apart from the preprocessing step.
Overview
--------
Allows the construction of scripts that can require CSS, using the simple RequireJS syntax:
```javascript
define(['css!styles/main'], function() {
//code that requires the stylesheet: styles/main.css
});
```
Fully compatible in IE 6+, Chrome 3+, Firefox 3.5+, Opera 10+, iOS.
* **CSS builds** When run as part of a build with the RequireJS optimizer, `css!` dependencies are automatically inlined into the built layer within the JavaScript, fully compatible with layering. CSS injection is performed as soon as the layer is loaded.
* **Option to build separate layer CSS files** A `separateCSS` build parameter allows for built layers to output their css files separately, instead of inline with the JavaScript, for manual inclusion.
* **CSS compression** CSS redundancy compression is supported through the external library, [csso](https://github.com/css/csso).
Installation and Setup
----------------------
Download the require-css folder manually or use Bower:
```bash
bower install require-css
```
To allow the direct `css!` usage, add the following [map configuration](http://requirejs.org/docs/api.html#config-map) in RequireJS:
```javascript
map: {
'*': {
'css': 'require-css/css' // or whatever the path to require-css is
}
}
```
Use Cases and Benefits
----------------------
### Motivation
The use case for RequireCSS came out of a need to manage templates and their CSS together.
The idea being that a CSS require can be a dependency of the code that dynamically renders a template.
When writing a large dynamic application, with templates being rendered on the client-side, it can be beneficial to inject the CSS as templates are required instead
of dumping all the CSS together separately. The added benefit of this is then being able to build the CSS naturally with the RequireJS optimizer,
which also supports [separate build layers](http://requirejs.org/docs/1.0/docs/faq-optimization.html#priority) as needed.
### Script-inlined CSS Benefits
By default, during the build CSS is compressed and inlined as a string within the layer that injects the CSS when run.
If the layer is included as a `` tag, only one browser request is needed instead of many separate CSS requests with `<link>` tags.
Even better than including a layer as a `<script>` tag is to include the layer dynamically with a non-blocking require.
Then the page can be displayed while the layer is still loading asynchronously in the background.
In this case, the CSS that goes with a template being dynamically rendered is loaded with that same script asynchronously.
No longer does it need to sit in a `<link>` tag that blocks the page display unnecessarily.
Modular CSS
-----------
RequireCSS implies a CSS modularisation where styles can be scoped directly to the render code that they are bundled with.
Just like JS requires, the order of CSS injection can't be guaranteed. The idea here is that whenever there are style overrides, they should
be based on using a more specific selector with an extra id or class at the base, and not assuming a CSS load order. Reset and global styles are a repeated dependency of all
modular styles that build on top of them.
Optimizer Configuration
-----------------------
### Basic Usage
Optimizer configuration:
```javascript
{
modules: [
{
name: 'mymodule',
exclude: ['css/normalize']
}
]
}
```
If the contents of 'mymodule' are:
```javascript
define(['css!style', 'css!page'], function(css) {
//...
});
```
Then the optimizer output would be:
-mymodule.js containing:
style.css and page.css which will be dynamically injected
The `css/normalize` exclude is needed due to [r.js issue #289](https://github.com/jrburke/r.js/issues/289)
### Separate File Output
To output the CSS to a separate file, use the configuration:
```javascript
{
separateCSS: true,
modules: [
{
name: 'mymodule'
}
]
}
```
This will then output all the css to the file `mymodule.css`. This configuration can also be placed on the module object itself for layer-specific settings.
Optimization is fully compatible with exclude and include.
### IE8 and 9 Selector Limit
In IE9 and below, there is a maximum limit of 4095 selectors per stylesheet.
In order to avoid this limit, CSS concatenation can be disabled entirely with the `IESelectorLimit` option.
```javascript
{
IESelectorLimit: true,
modules: [
{
name: 'mymodule'
}
]
}
```
Ideally build layers would avoid this limit entirely by naturally being designed to not reach it. This option is really only as a fix when nothing else
is possible as it will degrade injection performance.
This option is also not compatible with the `separateCSS` option.
### Excluding the CSS Module in Production
When dynamic CSS requires are not going to be made in production, a minimal version of RequireCSS can be written by setting a pragma for the build:
```javascript
{
pragmasOnSave: {
excludeRequireCss: true
}
}
```
### siteRoot Configuration
When building the CSS, all URIs are renormalized relative to the site root.
It assumed that the siteRoot matches the build directory in this case.
If this is different, then specify the server path of the siteRoot relative to the baseURL in the configuration.
For example, if the site root is `www` and we are building the directory `www/lib`, we would use the configuration:
```javascript
{
appDir: 'lib',
dir: 'lib-built',
siteRoot: '../',
modules: [
{
name: 'mymodule'
}
]
}
```
### Almond Configuration
Almond doesn't support the `packages` configuration option. When using Almond, rather configuration RequireCSS with map configuration instead, by including the following configuration in the production app:
```javascript
requirejs.config({
map: {
'*': {
css: 'require-css/css'
}
}
});
```
### Disabling the Build
To disable any CSS build entirely, use the configuration option `buildCSS`:
```javascript
{
buildCSS: false,
modules: [
{
name: 'mymodule'
}
]
}
```
CSS requires will then be left in the source "as is". This shouldn't be used with `stubModules`.
CSS Compression
---------------
CSS compression is supported with [csso](https://github.com/css/csso).
To enable the CSS compression, install csso with npm:
```
npm install csso -g
```
The build log will display the compression results.
When running the r.js optimizer through NodeJS, sometimes the global module isn't found. In this case install csso as a local node module so it can be found.
Injection methods
-----------------
When loading a CSS file or external CSS file, a `<link>` tag is used. Cross-browser support comes through a number of careful browser conditions for this.
If CSS resources such as images are important to be loaded first, these can be added to the require through a loader plugin that can act as a preloader such as [image](https://github.com/millermedeiros/requirejs-plugins) or [font](https://github.com/millermedeiros/requirejs-plugins). Then a require can be written of the form:
```javascript
require(['css!my-css', 'image!preload-background-image.jpg', 'font!google,families:[Tangerine]']);
```
License
---
MIT