Search code examples
reactjswebpacknext.jsantdant-design-pro

How to config Ant Design in Next.js with custom theme & support CSS Module feature


I'm building a ReactJs project base on SSR ( using Next.js ) with Ant Design. But after I customize next.config.js config for support Ant Design, I can't use CSS Module feature.

Next.js supports CSS Modules using the [name].module.css file naming convention

Here are my configure files:

  1. next.config.js
require('dotenv').config();
const lessToJS = require('less-vars-to-js')
const fs = require('fs')
const path = require('path');
const withSass = require('@zeit/next-sass');
const withLess = require('@zeit/next-less');
const withCSS = require('@zeit/next-css');
const withPlugins = require('next-compose-plugins');

// Where your antd-custom.less file lives
const themeVariables = lessToJS(fs.readFileSync(path.resolve(__dirname, './css/antd.less'), 'utf8'));

const nextConfig = {
    env: {
        spaceID: process.env.spaceID,
        accessTokenDelivery: process.env.accessTokenDelivery,
    },
    distDir: '.next',
};

const plugins = [
    withCSS,
    withLess({
        lessLoaderOptions: {
            javascriptEnabled: true,
            modifyVars: themeVariables,
        },
        webpack: (config, { isServer }) => {
            if (isServer) {
                const antStyles = /antd\/.*?\/style.*?/;
                const origExternals = [...config.externals];
                config.externals = [
                    (context, request, callback) => {
                        if (request.match(antStyles)) return callback();
                        if (typeof origExternals[0] === 'function') {
                            origExternals[0](context, request, callback);
                        } else {
                            callback();
                        }
                    },
                    ...(typeof origExternals[0] === 'function' ? [] : origExternals),
                ];

                config.module.rules.unshift({
                    test: antStyles,
                    use: 'null-loader',
                });
            }
            return config;
        },
    }),
    withSass,
];
module.exports = withPlugins(plugins, nextConfig);

  1. pages/index.tsx:
import headerStyled from '../components/Header.module.css'

export default () => {
  return (
    <>
      <div className={headerStyled.appc}>
        Hello World
      </div>
    </>
  )
}
  1. Here is my test project on github ( you can clone & see these configs )
    https://github.com/thobn24h/nextjs-with-ant.git

  2. When I run yarn dev to build project --> I got error:

./components/Header.module.css 1:0
Module parse failed: Unexpected token (1:0)
You may need an appropriate loader to handle this file type, currently no loaders are configured to process this file. See https://webpack.js.org/concepts#loaders
> .appc {
|   color: #fff;
|   background: #16191e;

  1. Here are my dependencies:
 "dependencies": {
    "@zeit/next-css": "^1.0.1",
    "@zeit/next-less": "^1.0.1",
    "@zeit/next-sass": "^1.0.1",
    "antd": "^4.4.0",
    "dotenv": "^8.2.0",
    "less": "^3.11.3",
    "less-vars-to-js": "^1.3.0",
    "next": "^9.4.4",
    "next-compose-plugins": "^2.2.0",
    "react": "^16.13.1",
    "react-dom": "^16.13.1"
  },
  "devDependencies": {
    "@types/node": "^14.0.14",
    "@types/react": "^16.9.41",
    "typescript": "^3.9.6"
  },

Please show me how to correct this configurations to run Next.js project with Ant Design support & still support CSS Modules


Thank you!

Solution

  • Thank you Sumit Sarkar (@sumitsarkar01) was helped me config the next.config.js,
    And now, It work correctly!

    const withLess = require('@zeit/next-less')
    const lessToJS = require('less-vars-to-js')
    const withPlugins = require('next-compose-plugins')
    
    const fs = require('fs')
    const path = require('path')
    
    const dotenv = require('dotenv')
    
    dotenv.config()
    
    // Where your antd-custom.less file lives
    const themeVariables = lessToJS(
      fs.readFileSync(path.resolve(__dirname, './css/antd.less'), 'utf8')
    )
    
    const plugins = [
      [withLess({
        lessLoaderOptions: {
          javascriptEnabled: true,
          modifyVars: themeVariables, // make your antd custom effective
        },
        webpack: (config, { isServer }) => {
          if (isServer) {
            const antStyles = /antd\/.*?\/style.*?/
            const origExternals = [...config.externals]
            config.externals = [
              (context, request, callback) => {
                if (request.match(antStyles)) return callback()
                if (typeof origExternals[0] === 'function') {
                  origExternals[0](context, request, callback)
                } else {
                  callback()
                }
              },
              ...(typeof origExternals[0] === 'function' ? [] : origExternals),
            ]
    
            config.module.rules.unshift({
              test: antStyles,
              use: 'null-loader',
            })
          }
    
          const builtInLoader = config.module.rules.find((rule) => {
            if (rule.oneOf) {
              return (
                rule.oneOf.find((deepRule) => {
                  return deepRule.test && deepRule.test.toString().includes('/a^/');
    
                }) !== undefined
              );
            }
            return false;
          });
    
          if (typeof builtInLoader !== 'undefined') {
            config.module.rules.push({
              oneOf: [
                ...builtInLoader.oneOf.filter((rule) => {
                  return (rule.test && rule.test.toString().includes('/a^/')) !== true;
                }),
              ],
            });
          }
    
          config.resolve.alias['@'] = path.resolve(__dirname);
          return config;
        }
      })]
    ]
    
    const nextConfig = {
      env: {
      }
    }
    
    module.exports = withPlugins(plugins, nextConfig)
    

    I was updated this config to my test project, you can check it out
    [https://github.com/thobn24h/nextjs-with-ant][1]