rtl-css-plugin-webpack

Webpack plugin to use in addition to mini-css-extract-plugin to create a second css bundle, processed to be rtl.

This uses rtlcss under the hood

Installation

1$ npm install rtl-css-plugin-webpack

Usage

Add the plugin to your webpack configuration:

1const RtlCssPluginWebpack = require('rtl-css-plugin-webpack');
2
3module.exports = {
4  entry: path.join(__dirname, 'src/index.js'),
5  output: {
6    path: path.resolve(__dirname, 'dist'),
7    filename: 'bundle.js',
8    chunkFilename: 'chunk/[name].[hash].js',
9
10  },
11  module: {
12    rules: [
13      {
14        test: /\.css$/i,
15        use: [MiniCssExtractPlugin.loader, "css-loader"],
16      },
17    ],
18  },
19  plugins: [new MiniCssExtractPlugin(), new RtlCssPluginWebpack()]
20};

Options

new RtlCssPlugin({
  filename: '[name].rtl.css',
  chunkFilename: '[name].rtl.css',
  });

filename

Default: [name].rtl.css

This option determines the name of each output CSS file.

chunkFilename

Default: [name].rtl.css

This option determines the name of non-entry chunk files.

Example with MiniCSSExtractPlugin to dynamic load rtl css

The insert option of mini-css-extract-plugin can be used to load non-initial (async) rtl/ltr CSS chunks

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

1const RtlCssPluginWebpack = require('rtl-css-plugin-webpack');
2
3module.exports = {
4  entry: path.join(__dirname, 'src/index.js'),
5  output: {
6    path: path.resolve(__dirname, 'dist'),
7    filename: 'bundle.js',
8    chunkFilename: 'chunk/[name].[hash].js',
9
10  },
11  module: {
12    rules: [
13      {
14        test: /\.css$/i,
15        use: [MiniCssExtractPlugin.loader, "css-loader"],
16      },
17    ],
18  },
19  plugins: [
20      // generates ltr css files
21      new MiniCssExtractPlugin({
22      filename: '[name]-ltr.css',
23      chunkFilename: 'chunks/[name].[hash]-ltr.css',
24      // this function is going to be part of bundle to load rtl/ltr css chunk based on html dir attribute
25      insert: linkTag => {
26        if (document.documentElement.dir === 'rtl') {
27          linkTag.href = linkTag.href.replace('-ltr', '-rtl');
28        }
29        document.head.appendChild(linkTag);
30      },
31    }),
32    // generates rtl css files
33      new RtlCssPluginWebpack({
34            filename: '[name]-rtl.css',
35            chunkFilename: 'chunks/[name].[hash]-rtl.css',
36      }),
37    ]
38};

Example for optimization

We can update webpacks optimization config to avoid duplicate css chunks

1module.exports = {
2  // ... other webpack configs
3  optimization: {
4    // ... other optimization
5    splitChunks: {
6      cacheGroups: {
7        // avoids duplication of dynamically loaded css chunks
8        styles: {
9          test: /\.(css|scss|less)$/,
10          enforce: true,
11        },
12      },
13    },
14  }
15}