A Stylus loader for webpack. Compiles Styl to CSS.
To begin, you'll need to install stylus
and stylus-loader
:
$ npm install stylus stylus-loader --save-dev
Then add the loader to your webpack
config. For example:
webpack.config.js
module.exports = {
module: {
rules: [
{
test: /\.styl$/,
loader: 'stylus-loader', // compiles Styl to CSS
},
],
},
};
And run webpack
via your preferred method.
Name | Type | Default | Description |
---|---|---|---|
stylusOptions |
{Object|Function} |
{} |
Options for Stylus. |
sourceMap |
{Boolean} |
compiler.devtool |
Enables/Disables generation of source maps. |
webpackImporter |
{Boolean} |
true |
Enables/Disables the default Webpack importer. |
Type: Object|Function
Default: {}
You can pass any Stylus specific options to the stylus-loader
through the stylusOptions
property in the loader options.
See the Stylus documentation.
Options in dash-case should use camelCase.
Use an object to pass options through to Stylus.
webpack.config.js
module.exports = {
module: {
rules: [
{
test: /\.styl$/,
use: [
{
loader: 'style-loader',
},
{
loader: 'css-loader',
},
{
loader: 'stylus-loader',
options: {
stylusOptions: {
use: ['nib'],
include: [path.join(__dirname, 'src/styl/config')],
import: ['nib', path.join(__dirname, 'src/styl/mixins')],
define: [
// [key, value, raw]
['$development', process.env.NODE_ENV === 'development'],
['rawVar', 42, true],
],
includeCSS: false,
resolveUrl: false,
},
},
},
],
},
],
},
};
Allows setting the options passed through to Stylus based off of the loader context.
module.exports = {
module: {
rules: [
{
test: /\.styl/,
use: [
'style-loader',
'css-loader',
{
loader: 'stylus-loader',
options: {
stylusOptions: (loaderContext) => {
// More information about available properties https://webpack.js.org/api/loaders/
const { resourcePath, rootContext } = loaderContext;
const relativePath = path.relative(rootContext, resourcePath);
if (relativePath === 'styles/foo.styl') {
return {
paths: ['absolute/path/c', 'absolute/path/d'],
};
}
return {
paths: ['absolute/path/a', 'absolute/path/b'],
};
},
},
},
],
},
],
},
};
Type: Boolean
webpack.config.js
module.exports = {
module: {
rules: [
{
test: /\.styl$/i,
use: [
'style-loader',
{
loader: 'css-loader',
options: {
sourceMap: true,
},
},
{
loader: 'stylus-loader',
options: {
sourceMap: true,
},
},
],
},
],
},
};
Type: Boolean
Default: true
Enables/Disables the default Webpack importer.
This can improve performance in some cases.
Use it with caution because aliases and @import
at-rules starting with ~
will not work.
webpack.config.js
module.exports = {
module: {
rules: [
{
test: /\.styl/i,
use: [
'style-loader',
'css-loader',
{
loader: 'stylus-loader',
options: {
webpackImporter: false,
},
},
],
},
],
},
};
Chain the stylus-loader
with the css-loader
and the style-loader
to immediately apply all styles to the DOM.
webpack.config.js
module.exports = {
module: {
rules: [
{
test: /\.styl$/,
use: [
{
loader: 'style-loader', // creates style nodes from JS strings
},
{
loader: 'css-loader', // translates CSS into CommonJS
},
{
loader: 'stylus-loader', // compiles Stylus to CSS
},
],
},
],
},
};
To enable sourcemaps for CSS, you'll need to pass the sourceMap
property in the loader's options. If this is not passed, the loader will respect the setting for webpack source maps, set in devtool
.
webpack.config.js
module.exports = {
devtool: 'source-map', // any "source-map"-like devtool is possible
module: {
rules: [
{
test: /\.styl$/,
use: [
'style-loader',
{
loader: 'css-loader',
options: {
sourceMap: true,
},
},
{
loader: 'stylus-loader',
options: {
sourceMap: true,
},
},
],
},
],
},
};
webpack.config.js
module.exports = {
module: {
rules: [
{
test: /\.styl$/,
use: [
{
loader: 'style-loader', // creates style nodes from JS strings
},
{
loader: 'css-loader', // translates CSS into CommonJS
},
{
loader: 'stylus-loader', // compiles Stylus to CSS
options: {
stylusOptions: {
use: [require('nib')()],
import: ['nib'],
},
},
},
],
},
],
},
};
Usually, it's recommended to extract the style sheets into a dedicated file in production using the MiniCssExtractPlugin. This way your styles are not dependent on JavaScript.
Webpack provides an advanced mechanism to resolve files.
The stylus-loader
applies the webpack resolver when processing queries.
Thus you can import your Stylus modules from node_modules
.
Just prepend them with a ~
which tells webpack to look up the modules
.
@import '~bootstrap-styl/bootstrap/index.styl';
It's important to only prepend it with ~
, because ~/
resolves to the home-directory.
Webpack needs to distinguish between bootstrap
and ~bootstrap
, because CSS and Styl files have no special syntax for importing relative files.
Writing @import "file"
is the same as @import "./file";
If you specify the paths
option, modules will be searched in the given paths
.
This is Stylus default behavior.
webpack.config.js
module.exports = {
module: {
rules: [
{
test: /\.styl/,
use: [
{
loader: 'style-loader',
},
{
loader: 'css-loader',
},
{
loader: 'stylus-loader',
options: {
stylusOptions: {
paths: [path.resolve(__dirname, 'node_modules')],
},
},
},
],
},
],
},
};
Bundling CSS with webpack has some nice advantages like referencing images and fonts with hashed urls or hot module replacement in development. In production, on the other hand, it's not a good idea to apply your style sheets depending on JS execution. Rendering may be delayed or even a FOUC might be visible. Thus it's often still better to have them as separate files in your final production build.
There are two possibilities to extract a style sheet from the bundle:
extract-loader
(simpler, but specialized on the css-loader's output)- MiniCssExtractPlugin (more complex, but works in all use-cases)
Please take a moment to read our contributing guidelines if you haven't yet done so.