TailwindCSS v2 (Legacy)

info

This documentation concerns TailwindCSS v2. See here for V3!

1. Install the following dependencies:

npm

npm i postcss-loader postcss postcss-preset-env tailwindcss@2 autoprefixer

yarn

pnpm i postcss-loader postcss postcss-preset-env tailwindcss@2 autoprefixer

pnpm

yarn add postcss-loader postcss postcss-preset-env tailwindcss@2 autoprefixer

2. Add the following to your remotion.config.ts file:

Config.overrideWebpackConfig((currentConfiguration) => {
  return {
    ...currentConfiguration,
    module: {
      ...currentConfiguration.module,
      rules: [
        ...(currentConfiguration.module?.rules
          ? currentConfiguration.module.rules
          : []
        ).filter((rule) => {
          if (!rule) {
            return false;
          }
          if (rule === "...") {
            return false;
          }
          if (rule.test?.toString().includes(".css")) {
            return false;
          }
          return true;
        }),
        {
          test: /\.css$/i,
          use: [
            "style-loader",
            "css-loader",
            {
              loader: "postcss-loader",
              options: {
                postcssOptions: {
                  plugins: [
                    "postcss-preset-env",
                    "tailwindcss",
                    "autoprefixer",
                  ],
                },
              },
            },
          ],
        },
      ],
    },
  };
});

3. Create a file src/style.css with the following content:

@tailwind base;
@tailwind components;
@tailwind utilities;

4. Import the stylesheet in your src/Root.tsx file. Add to the top of the file:

import "./style.css";

5. Start using TailwindCSS! You can verify that it's working by adding className="bg-red-900" to any element.

6. Optional: Add a tailwind.config.js file to the root of your project. Add /* eslint-env node */ to the top of the file to get rid of an ESLint rule complaining that module is not defined.

warning

Due to a caching bug, the config file might not be picked up until you remove the node_modules/.cache folder - watch this issue: https://github.com/remotion-dev/remotion/issues/315