@truelore/web-template

4.1.1 • Public • Published

Create React apps (with Typescript and antd) with no build configuration.

base on react-scripts-ts@4.0.8

Usage

create a new project with create-react-app

create-react-app myapp --scripts-version=react-scripts-ts-antd

Features

Include ts-import-plugin for importing components on demand.

// source
import { Card } from 'antd';

// output
import Card from 'antd/lib/card';
import Card from 'antd/lib/card/style/index.less';

Include react-app-rewired

You can rewire your webpack configurations without eject.

// You can get all default loads
const { loaders } = require('react-scripts-ts-antd');

Support scss and less

  • use less-loader for less.
  • use precss for scss.

Turn on some options of compileOptions in tsconfig.json.

// tsconfig.json
{
    "allowSyntheticDefaultImports": "true",
    "experimentalDecorators": "true"
}

Theme

Now you can use theme field in package to customize antd theme. Value of theme field should be a plain object or a path to the file which export a object. This theme object will be passed to the modifyVars option of less-loader

// package.json
{
  "theme": {
    "@primary-color": "#000"
  }
}

// or 
{
  "theme": "path-to-your-theme-file"
}

You can find all Ant Design Less variables in here

Tips

How to avoid importing styles twice

If you want to customize theme by overriding less variables like below.

// index.less
@import "~antd/dist/antd.less";
@primary-color: #000;

You have imported all styles and ts-import-plugin will import styles again. So you need to reset ts-loader options by modifying config-overrides.js to avoid importing styles twice.

// config-overrides.js
const { getLoader } = require("react-app-rewired");

module.exports = function override(config, env) {

  // get tsloader
  const tsloader = getLoader(
    config.module.rules,
    rule => String(rule.test) == String(/\.(ts|tsx)$/)
  );

  // set new options
  tsloader.options = {
    transpileOnly: true,
    getCustomTransformers: () => ({
      before: [
        tsImportPluginFactory([
          {
            libraryName: 'antd',
            libraryDirectory: 'es',
          },
          {
            libraryName: 'antd-mobile',
            libraryDirectory: 'es',
          }
        ])
      ]
    })
  }
  return config;
};

antd package will be installed automatically.If you need antd-mobile, install it manually.

react-scripts

This package includes scripts and configuration used by Create React App.
Please refer to its documentation:

Readme

Keywords

none

Package Sidebar

Install

npm i @truelore/web-template

Weekly Downloads

1

Version

4.1.1

License

MIT

Unpacked Size

262 kB

Total Files

50

Last publish

Collaborators

  • pibarr