sfcode
An Online Competing and Development Environment
|
The css-loader
interprets @import
and url()
like import/require()
and will resolve them.
To begin, you'll need to install css-loader
:
Then add the plugin to your webpack
config. For example:
file.js
webpack.config.js
Good loaders for requiring your assets are the file-loader and the url-loader which you should specify in your config (see below).
And run webpack
via your preferred method.
You can also use the css-loader results directly as a string, such as in Angular's component style.
webpack.config.js
or
If there are SourceMaps, they will also be included in the result string.
If, for one reason or another, you need to extract CSS as a plain string resource (i.e. not wrapped in a JS module) you might want to check out the extract-loader. It's useful when you, for instance, need to post process the CSS as a string.
webpack.config.js
Name | Type | Default | Description |
---|---|---|---|
**url ** | {Boolean\|Function} | true | Enables/Disables url /image-set functions handling |
**import ** | {Boolean\|Function} | true | Enables/Disables @import at-rules handling |
**modules ** | {Boolean\|String\|Object} | {auto: true} | Enables/Disables CSS Modules and their configuration |
**sourceMap ** | {Boolean} | compiler.devtool | Enables/Disables generation of source maps |
**importLoaders ** | {Number} | 0 | Enables/Disables or setups number of loaders applied before CSS loader |
**esModule ** | {Boolean} | true | Use ES modules syntax |
Type: Boolean|Function
Default: true
Enables/Disables url
/image-set
functions handling. Control url()
resolving. Absolute URLs are not resolving.
Examples resolutions:
To import assets from a node_modules
path (include resolve.modules
) and for alias
, prefix it with a ~
:
Enable/disable url()
resolving.
webpack.config.js
Allow to filter url()
. All filtered url()
will not be resolved (left in the code as they were written).
webpack.config.js
Type: Boolean|Function
Default: true
Enables/Disables @import
at-rules handling. Control @import
resolving. Absolute urls in @import
will be moved in runtime code.
Examples resolutions:
To import styles from a node_modules
path (include resolve.modules
) and for alias
, prefix it with a ~
:
Enable/disable @import
resolving.
webpack.config.js
Allow to filter @import
. All filtered @import
will not be resolved (left in the code as they were written).
webpack.config.js
Type: Boolean|String|Object
Default: based on filename, true
for all files matching /\.module\.\w+$/i.test(filename)
regular expression, more information you can read here
Enables/Disables CSS Modules and their configuration.
The modules
option enables/disables the CSS Modules specification and setup basic behaviour.
Using false
value increase performance because we avoid parsing CSS Modules features, it will be useful for developers who use vanilla css or use other technologies.
webpack.config.js
Scope
Using local
value requires you to specify :global
classes. Using global
value requires you to specify :local
classes. Using pure
value requires selectors must contain at least one local class or id.
You can find more information here.
Styles can be locally scoped to avoid globally scoping styles.
The syntax :local(.className)
can be used to declare className
in the local scope. The local identifiers are exported by the module.
With :local
(without brackets) local mode can be switched on for this selector. The :global(.className)
notation can be used to declare an explicit global selector. With :global
(without brackets) global mode can be switched on for this selector.
The loader replaces local selectors with unique identifiers. The chosen unique identifiers are exported by the module.
ℹ️ Identifiers are exported
CamelCase is recommended for local selectors. They are easier to use within the imported JS module.
You can use :local(#someId)
, but this is not recommended. Use classes instead of ids.
Composing
When declaring a local classname you can compose a local class from another local classname.
This doesn't result in any change to the CSS itself but exports multiple classnames.
Importing
To import a local classname from another module.
i We strongly recommend that you specify the extension when importing a file, since it is possible to import a file with any extension and it is not known in advance which file to use.
To import from multiple modules use multiple composes:
rules.
Values
You can use @value
to specific values to be reused throughout a document.
We recommend use prefix v-
for values, s-
for selectors and m-
for media at-rules.
Enable CSS Modules features.
webpack.config.js
Enable CSS Modules features and setup mode
.
webpack.config.js
Enable CSS Modules features and setup options for them.
webpack.config.js
compileType
Type: ‘'module’ | 'icss' Default:
'module'`
Controls the level of compilation applied to the input styles.
The module
handles class
and id
scoping and @value
values. The icss
will only compile the low level Interoperable CSS
format for declaring :import
and :export
dependencies between CSS and other languages.
ICSS underpins CSS Module support, and provides a low level syntax for other tools to implement CSS-module variations of their own.
webpack.config.js
auto
Type: Boolean|RegExp|Function
Default: ‘'true’`
Allows auto enable CSS modules based on filename.
Boolean
Possible values:
true
- enable css modules for all files for which /\.module\.\w+$/i.test(filename)
return truefalse
- disable css moduleswebpack.config.js
RegExp
Enable css modules for files based on the filename satisfying your regex check.
webpack.config.js
Function
Enable css modules for files based on the filename satisfying your filter function check.
webpack.config.js
mode
Type: String|Function
Default: ‘'local’`
Setup mode
option. You can omit the value when you want local
mode.
String
Possible values - local
, global
, and pure
.
webpack.config.js
Function
Allows set different values for the mode
option based on a filename
Possible return values - local
, global
, and pure
.
webpack.config.js
localIdentName
Type: String
Default: ‘’[hash:base64]'`
Allows to configure the generated local ident name. See loader-utils's documentation for more information on options.
Recommendations:
for development
use
'[hash:base64]'` for productionThe [local]
placeholder contains original class.
Note: all reserved (<>:"/|?*
) and control filesystem characters (excluding characters in the [local]
placeholder) will be converted to -
.
webpack.config.js
localIdentContext
Type: String
Default: compiler.context
Allows to redefine basic loader context for local ident name.
webpack.config.js
localIdentHashPrefix
Type: String
Default: undefined
Allows to add custom hash to generate more unique classes.
webpack.config.js
localIdentRegExp
Type: String|RegExp
Default: undefined
webpack.config.js
getLocalIdent
Type: Function
Default: undefined
Allows to specify a function to generate the classname. By default we use built-in function to generate a classname.
webpack.config.js
namedExport
Type: Boolean
Default: false
Enables/disables ES modules named export for locals.
⚠ Names of locals are converted to camelcase, i.e. the
exportLocalsConvention
option hascamelCaseOnly
value by default.
⚠ It is not allowed to use JavaScript reserved words in css class names.
styles.css
index.js
You can enable a ES module named export using:
webpack.config.js
exportGlobals
Type: Boolean
Default: false
Allow css-loader
to export names from global class or id, so you can use that as local name.
webpack.config.js
exportLocalsConvention
Type: String
Default: based on the modules.namedExport
option value, if true
- camelCaseOnly
, otherwise asIs
Style of exported class names.
By default, the exported JSON keys mirror the class names (i.e asIs
value).
⚠ Only
camelCaseOnly
value allowed if you set thenamedExport
value totrue
.
Name | Type | Description |
---|---|---|
**‘'asIs’** \ilinebr </td> <td class="markdownTableBodyCenter"> {String}\ilinebr </td> <td class="markdownTableBodyLeft"> Class names will be exported as is. \ilinebr </td> </tr> <tr class="markdownTableRowEven"> <td class="markdownTableBodyCenter"> ** 'camelCase'** \ilinebr </td> <td class="markdownTableBodyCenter"> {String}\ilinebr </td> <td class="markdownTableBodyLeft"> Class names will be camelized, the original class name will not to be removed from the locals \ilinebr </td> </tr> <tr class="markdownTableRowOdd"> <td class="markdownTableBodyCenter"> ** 'camelCaseOnly'** \ilinebr </td> <td class="markdownTableBodyCenter"> {String}\ilinebr </td> <td class="markdownTableBodyLeft"> Class names will be camelized, the original class name will be removed from the locals \ilinebr </td> </tr> <tr class="markdownTableRowEven"> <td class="markdownTableBodyCenter"> ** 'dashes'** \ilinebr </td> <td class="markdownTableBodyCenter"> {String}\ilinebr </td> <td class="markdownTableBodyLeft"> Only dashes in class names will be camelized \ilinebr </td> </tr> <tr class="markdownTableRowOdd"> <td class="markdownTableBodyCenter"> ** 'dashesOnly'** \ilinebr </td> <td class="markdownTableBodyCenter"> {String}` | Dashes in class names will be camelized, the original class name will be removed from the locals |
file.css
file.js
webpack.config.js
exportOnlyLocals
Type: Boolean
Default: false
Export only locals.
Useful when you use css modules for pre-rendering (for example SSR). For pre-rendering with mini-css-extract-plugin
you should use this option instead of style-loader!css-loader
in the pre-rendering bundle. It doesn't embed CSS but only exports the identifier mappings.
webpack.config.js
Type: Boolean
Default: depends on the compiler.devtool
value
By default generation of source maps depends on the devtool
option. All values enable source map generation except eval
and false
value.
webpack.config.js
Type: Number
Default: 0
Enables/Disables or setups number of loaders applied before CSS loader.
The option importLoaders
allows you to configure how many loaders before css-loader
should be applied to @import
ed resources.
webpack.config.js
This may change in the future when the module system (i. e. webpack) supports loader matching by origin.
Type: Boolean
Default: true
By default, css-loader
generates JS modules that use the ES modules syntax. There are some cases in which using ES modules is beneficial, like in the case of module concatenation and tree shaking.
You can enable a CommonJS modules syntax using:
webpack.config.js
The following webpack.config.js
can load CSS files, embed small PNG/JPG/GIF/SVG images as well as fonts as Data URLs and copy larger files to the output directory.
webpack.config.js
For production builds it's recommended to extract the CSS from your bundle being able to use parallel loading of CSS/JS resources later on.
When you have pure CSS (without CSS modules), CSS modules and PostCSS in your project you can use this setup:
webpack.config.js
index.css
webpack.config.js
The following setup is an example of allowing Interoperable CSS
features only (such as :import
and :export
) without using further CSS Module
functionality by setting compileType
option for all files that do not match *.module.scss
naming convention. This is for reference as having ICSS
features applied to all files was default css-loader
behavior before v4.
Meanwhile all files matching *.module.scss
are treated as CSS Modules
in this example.
An example case is assumed where a project requires canvas drawing variables to be synchronized with CSS - canvas drawing uses the same color (set by color name in JavaScript) as HTML background (set by class name in CSS).
webpack.config.js
variables.scss
File treated as ICSS
-only.
Component.module.scss
File treated as CSS Module
.
Component.jsx
Using both CSS Module
functionality as well as SCSS variables directly in JavaScript.
Please take a moment to read our contributing guidelines if you haven't yet done so.
./.github/CONTRIBUTING.md "CONTRIBUTING"