babel-plugin-import weekly downloads statistics

babel-plugin-import

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

Why babel-plugin-import

• English Instruction • 中文说明

Where to add babel-plugin-import

• babelrc • babel-loader

Example

{ "libraryName": "antd" }

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

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

Note : with style: true css source files are imported and optimizations can be done during compilation time. With style: "css", pre bundled css files are imported as they are.

style: true can reduce the bundle size significantly, depending on your usage of the library.

Usage

Via .babelrc or babel-loader.

options

options can be object.

~options can be an array.~ It's not available in babel@7+

For Example:

Options can't be an array in babel@7+, but you can add plugins with name to support multiple dependencies.

For Example:

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)

If option style is a Function, babel-plugin-import will auto import the file which filepath equal to the function return value. This is useful for the components library developers.

e.g. • `["import", { "libraryName": "antd", "style": (name) => ${name}/style/2x }]: import js and css modularly & css file path is ComponentName/style/2x`

If a component has no style, you can use the style function to return a false and the style will be ignored.

e.g.

styleLibraryDirectory

• ["import", { "libraryName": "element-ui", "styleLibraryDirectory": "lib/theme-chalk" }]: import js and css modularly

If styleLibraryDirectory is provided (default null), it will be used to form style file path, style will be ignored then. e.g.

customName

We can use customName to customize import file path.

For example, the default behavior:

You can set camel2DashComponentName to false to disable transfer from camel to dash:

And finally, you can use customName to customize each name parsing:

So this result is:

In some cases, the transformer may serialize the configuration object. If we set the customName to a function, it will lost after the serialization.

So we also support specifying the customName with a JavaScript source file path:

The customName.js looks like this:

customStyleName

customStyleName works exactly the same as customName, except that it deals with style file path.

transformToDefaultImport

Set this option to false if your module does not have a default export.

Note

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

Description from the npm listing.