babel-plugin-import

What is babel-plugin-import?

babel-plugin-import is a Babel plugin for modular import of components, enabling on-demand loading of specific parts of a library. This can help reduce bundle sizes by only including the necessary parts of a library in the final build.

What are babel-plugin-import's main functionalities?

Importing specific components

This feature allows you to import specific components from a library like 'antd' without importing the entire library. The configuration in babel.config.js specifies the library name, directory, and style options. The import statement in the JavaScript file then only includes the 'Button' component.

/* Babel configuration (babel.config.js) */
{
  "plugins": [
    [
      "import",
      {
        "libraryName": "antd",
        "libraryDirectory": "es",
        "style": "css"
      }
    ]
  ]
}

/* Usage in a JavaScript file */
import { Button } from 'antd';

Customizing import paths

This feature allows you to customize the import paths for libraries like 'lodash'. The configuration in babel.config.js specifies the library name and options like 'camel2DashComponentName' to control the import path format. The import statement in the JavaScript file then only includes the 'debounce' function.

/* Babel configuration (babel.config.js) */
{
  "plugins": [
    [
      "import",
      {
        "libraryName": "lodash",
        "libraryDirectory": "",
        "camel2DashComponentName": false
      },
      "lodash"
    ]
  ]
}

/* Usage in a JavaScript file */
import { debounce } from 'lodash';

Other packages similar to babel-plugin-import

babel-plugin-lodash

babel-plugin-lodash is a Babel plugin that cherry-picks Lodash modules so you don’t have to. It helps reduce the size of your Lodash imports by only including the specific functions you use. Compared to babel-plugin-import, it is more specialized for Lodash and offers more granular control over Lodash imports.

babel-plugin-transform-imports

babel-plugin-transform-imports is a Babel plugin that allows you to transform import statements for specific modules. It provides a flexible way to rewrite import paths and can be used with various libraries. Compared to babel-plugin-import, it offers more customization options for transforming imports but may require more configuration.

README

babel-plugin-import

Modular import plugin for babel, compatible with antd, antd-mobile, and so on.

---

Why babel-plugin-import

• English Instruction
• 中文说明

Where to add babel-plugin-import

• babelrc
• babel-loader

Example

{ "libraryName": "antd" }

import { Button } from 'antd';
ReactDOM.render(<Button>xxxx</Button>);

      ↓ ↓ ↓ ↓ ↓ ↓
      
var _button = require('antd/lib/button');
ReactDOM.render(<_button>xxxx</_button>);

{ "libraryName": "antd", style: "css" }

import { Button } from 'antd';
ReactDOM.render(<Button>xxxx</Button>);

      ↓ ↓ ↓ ↓ ↓ ↓
      
var _button = require('antd/lib/button');
require('antd/lib/button/style/css');
ReactDOM.render(<_button>xxxx</_button>);

{ "libraryName": "antd", style: true }

import { Button } from 'antd';
ReactDOM.render(<Button>xxxx</Button>);

      ↓ ↓ ↓ ↓ ↓ ↓
      
var _button = require('antd/lib/button');
require('antd/lib/button/style');
ReactDOM.render(<_button>xxxx</_button>);

Usage

npm install babel-plugin-import --save-dev

Via .babelrc or babel-loader.

{
  "plugins": [["import", options]]
}

options

options can be object.

{
  "libraryName": "antd",
  "style": true,   // or 'css'
}

{
  "libraryName": "material-ui",
  "libraryDirectory": "components",  // default: lib
  "camel2DashComponentName": false,  // default: true
}

options can be an array.

For Example:

[
  {
    "libraryName": "antd",
    "libraryDirectory": "lib",   // default: lib
    "style": true
  },
  {
    "libraryName": "antd-mobile"
  },
]

style

• ["import", { "libraryName": "antd" }]: import js modularly
• ["import", { "libraryName": "antd", "style": true }]: import js and css modularly (LESS/Sass source files)
• ["import", { "libraryName": "antd", "style": "css" }]: import js and css modularly (css built files)

Note

babel-plugin-import will not work properly if you add the library to the webpack config vendor.