Skip to content

docs: fix typos and improve clarity in README.md #1128

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+40 −32
Open

docs: fix typos and improve clarity in README.md #1128

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
72 changes: 40 additions & 32 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@

# mini-css-extract-plugin

This plugin extracts CSS into separate files. It creates a CSS file per JS file which contains CSS. It supports On-Demand-Loading of CSS and SourceMaps.
This plugin extracts CSS into separate files. It creates a CSS file for each JS file that contains CSS. It supports On-Demand-Loading of CSS and SourceMaps.

It builds on top of a new webpack v5 feature and requires webpack 5 to work.

Expand Down Expand Up @@ -48,7 +48,7 @@ pnpm add -D mini-css-extract-plugin

It's recommended to combine `mini-css-extract-plugin` with the [`css-loader`](https://github.com/webpack-contrib/css-loader)

Then add the loader and the plugin to your `webpack` config. For example:
Then add the loader and the plugin to your `webpack` configuration. For example:

**style.css**

Expand Down Expand Up @@ -84,7 +84,7 @@ module.exports = {

> [!WARNING]
>
> Note that if you import CSS from your webpack entrypoint or import styles in the [initial](https://webpack.js.org/concepts/under-the-hood/#chunks) chunk, `mini-css-extract-plugin` will not load this CSS into the page. Please use [`html-webpack-plugin`](https://github.com/jantimon/html-webpack-plugin) for automatic generation `link` tags or create `index.html` file with `link` tag.
> Note that if you import CSS from your webpack entrypoint or import styles in the [initial](https://webpack.js.org/concepts/under-the-hood/#chunks) chunk, `mini-css-extract-plugin` will not load this CSS into the page automatically. Please use [`html-webpack-plugin`](https://github.com/jantimon/html-webpack-plugin) for automatic generation `link` tags or manually include a `<link>` tag in your `index.html` file.

> [!WARNING]
>
Expand Down Expand Up @@ -129,7 +129,7 @@ type chunkFilename =
| ((pathData: PathData, assetInfo?: AssetInfo) => string);
```

Default: `based on filename`
Default: `Based on filename`

> Specifying `chunkFilename` as a `function` is only available in webpack@5

Expand All @@ -148,7 +148,7 @@ type ignoreOrder = boolean;
Default: `false`

Remove Order Warnings.
See [examples](#remove-order-warnings) below for details.
See [examples](#remove-order-warnings) for more details.

#### `insert`

Expand All @@ -164,15 +164,15 @@ Inserts the `link` tag at the given position for [non-initial (async)](https://w

> [!WARNING]
>
> Only for [non-initial (async)](https://webpack.js.org/concepts/under-the-hood/#chunks) chunks.
> Only applicable for [non-initial (async)](https://webpack.js.org/concepts/under-the-hood/#chunks) chunks.

By default, the `mini-css-extract-plugin` appends styles (`<link>` elements) to `document.head` of the current `window`.

However in some circumstances it might be necessary to have finer control over the append target or even delay `link` elements insertion.
For example this is the case when you asynchronously load styles for an application that runs inside of an iframe.
In such cases `insert` can be configured to be a function or a custom selector.

If you target an [iframe](https://developer.mozilla.org/en-US/docs/Web/API/HTMLIFrameElement) make sure that the parent document has sufficient access rights to reach into the frame document and append elements to it.
If you target an [iframe](https://developer.mozilla.org/en-US/docs/Web/API/HTMLIFrameElement), make sure that the parent document has sufficient access rights to reach into the frame document and append elements to it.

##### `string`

Expand All @@ -187,14 +187,14 @@ new MiniCssExtractPlugin({
});
```

A new `<link>` element will be inserted after the element with id `some-element`.
A new `<link>` tag will be inserted after the element with the ID `some-element`.

##### `function`

Allows to override default behavior and insert styles at any position.

> ⚠ Do not forget that this code will run in the browser alongside your application. Since not all browsers support latest ECMA features like `let`, `const`, `arrow function expression` and etc we recommend you to use only ECMA 5 features and syntax.

>
> > ⚠ The `insert` function is serialized to string and passed to the plugin. This means that it won't have access to the scope of the webpack configuration module.

**webpack.config.js**
Expand All @@ -210,7 +210,7 @@ new MiniCssExtractPlugin({
});
```

A new `<link>` element will be inserted before the element with id `some-element`.
A new `<link>` tag will be inserted before the element with the ID `some-element`.

#### `attributes`

Expand All @@ -224,7 +224,7 @@ Default: `{}`

> [!WARNING]
>
> Only for [non-initial (async)](https://webpack.js.org/concepts/under-the-hood/#chunks) chunks.
> Only applies to [non-initial (async)](https://webpack.js.org/concepts/under-the-hood/#chunks) chunks.

If defined, the `mini-css-extract-plugin` will attach given attributes with their values on `<link>` element.

Expand Down Expand Up @@ -255,7 +255,8 @@ module.exports = {

> [!NOTE]
>
> It's only applied to dynamically loaded css chunks, if you want to modify link attributes inside html file, please using [html-webpack-plugin](https://github.com/jantimon/html-webpack-plugin)
> It's only applied to dynamically loaded CSS chunks.
> If you want to modify `<link>` attributes inside HTML file, please use [html-webpack-plugin](https://github.com/jantimon/html-webpack-plugin)

#### `linkType`

Expand Down Expand Up @@ -297,7 +298,7 @@ module.exports = {

##### `boolean`

`false` disables the link `type` attribute
`false` disables the link `type` attribute entirely.

**webpack.config.js**

Expand Down Expand Up @@ -372,10 +373,9 @@ Default: `undefined`
Enabled by default if not explicitly enabled (i.e. `true` and `false` allow you to explicitly control this option) and new API is available (at least webpack `5.52.0` is required).
Boolean values are available since version `5.33.2`, but you need to enable `experiments.executeModule` (not required from webpack `5.52.0`).

Use a new webpack API to execute modules instead of child compilers.
This improves performance and memory usage a lot.
Use a new webpack API to execute modules instead of child compilers, significantly improving performance and memory usage.

When combined with `experiments.layers`, this adds a `layer` option to the loader options to specify the layer of the css execution.
When combined with `experiments.layers`, this adds a `layer` option to the loader options to specify the layer of the CSS execution.

**webpack.config.js**

Expand Down Expand Up @@ -506,7 +506,8 @@ type emit = boolean;

Default: `true`

If true, emits a file (writes a file to the filesystem). If false, the plugin will extract the CSS but **will not** emit the file.
If `true`, emits a file (writes a file to the filesystem).
If `false`, the plugin will extract the CSS but **will not** emit the file.
It is often useful to disable this option for server-side packages.

#### `esModule`
Expand Down Expand Up @@ -610,11 +611,10 @@ module.exports = {

### Recommended

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.
This can be achieved by using the `mini-css-extract-plugin`, because it creates separate css files.
For `production` builds, it is recommended to extract the CSS from your bundle being able to use parallel loading of CSS/JS resources later on. This can be achieved by using the `mini-css-extract-plugin`, because it creates separate css files.
For `development` mode (including `webpack-dev-server`) you can use [style-loader](https://github.com/webpack-contrib/style-loader), because it injects CSS into the DOM using multiple <style></style> and works faster.

> Do not use `style-loader` and `mini-css-extract-plugin` together.
> Important: Do not use `style-loader` and `mini-css-extract-plugin` together.

**webpack.config.js**

Expand Down Expand Up @@ -684,7 +684,7 @@ module.exports = {

> ⚠ Names of locals are converted to `camelCase`.

> ⚠ It is not allowed to use JavaScript reserved words in css class names.
> ⚠ It is not allowed to use JavaScript reserved words in CSS class names.

> ⚠ Options `esModule` and `modules.namedExport` in `css-loader` should be enabled.

Expand Down Expand Up @@ -743,6 +743,8 @@ module.exports = {

### The `publicPath` option as function

You can specify `publicPath` as a function to dynamically determine the public path based on each resource’s location relative to the project root or context.

**webpack.config.js**

```js
Expand Down Expand Up @@ -836,7 +838,7 @@ module.exports = {
>
> HMR is automatically supported in webpack 5. No need to configure it. Skip the following:

The `mini-css-extract-plugin` supports hot reloading of actual css files in development.
The `mini-css-extract-plugin` supports hot reloading of actual CSS files in development.
Some options are provided to enable HMR of both standard stylesheets and locally scoped CSS or CSS modules.
Below is an example configuration of mini-css for HMR use with CSS modules.

Expand Down Expand Up @@ -908,27 +910,30 @@ module.exports = {
},
optimization: {
minimizer: [
// For webpack@5 you can use the `...` syntax to extend existing minimizers (i.e. `terser-webpack-plugin`), uncomment the next line
// For webpack@5 you can use the `...` syntax to extend existing minimizers (i.e. `terser-webpack-plugin`).
// Uncomment the next linet o keep JS minimizers and add CSS minimizer:
// `...`,
new CssMinimizerPlugin(),
],
},
};
```

This will enable CSS optimization only in production mode. If you want to run it also in development set the `optimization.minimize` option to true.
- By default, CSS minimization runs in production mode.
- If you want to run it also in development set the `optimization.minimize` option to `true`.

### Using preloaded or inlined CSS

The runtime code detects already added CSS via `<link>` or `<style>` tag.
This can be useful when injecting CSS on server-side for Server-Side-Rendering.
The `href` of the `<link>` tag has to match the URL that will be used for loading the CSS chunk.
The `data-href` attribute can be used for `<link>` and `<style>` too.
When inlining CSS `data-href` must be used.
The runtime code detects already added CSS via `<link>` or `<style>` tags and avoids duplicating CSS loading.

- This can be useful when injecting CSS on server-side for Server-Side-Rendering (SSR).
- The `href` of the `<link>` tag has to match the URL that will be used for loading the CSS chunk.
- The `data-href` attribute can be used for both `<link>` and `<style>` elements.
- When inlining CSS `data-href` must be used.

### Extracting all CSS in a single file

The CSS can be extracted in one CSS file using `optimization.splitChunks.cacheGroups`.
The CSS can be extracted in one CSS file using `optimization.splitChunks.cacheGroups` with the `type` `"css/mini-extract"`.

**webpack.config.js**

Expand Down Expand Up @@ -1076,7 +1081,7 @@ module.exports = {

### Remove Order Warnings

For projects where css ordering has been mitigated through consistent use of scoping or naming conventions, such as [CSS Modules](https://github.com/css-modules/css-modules), the css order warnings can be disabled by setting the ignoreOrder flag to true for the plugin.
For projects where CSS ordering has been mitigated through consistent use of scoping or naming conventions, such as [CSS Modules](https://github.com/css-modules/css-modules), the css order warnings can be disabled by setting the ignoreOrder flag to true for the plugin.

**webpack.config.js**

Expand All @@ -1102,6 +1107,8 @@ module.exports = {

### Multiple Themes

Switch themes by conditionally loading different SCSS variants with query parameters.

**webpack.config.js**

```js
Expand Down Expand Up @@ -1274,7 +1281,8 @@ MiniCssExtractPlugin.getCompilationHooks(compilation).beforeTagInsert.tap(

## Contributing

Please take a moment to read our contributing guidelines if you haven't yet done so.
We welcome all contributions!
If you're new here, please take a moment to review our contributing guidelines before submitting issues or pull requests.

[CONTRIBUTING](./.github/CONTRIBUTING.md)

Expand Down
Loading