babel-plugin-load-as-need

Install

npm i babel-plugin-load-as-need -D

# For babel6
npm i babel-plugin-load-as-need@0 -D

Example

Converts

import { Button } from 'components'

to

var button = require('components/lib/button')
require('components/lib/button/style.css')

styleLibraryName Example

Converts

import Components from 'components'
import { Button } from 'components'

to

require('components/lib/styleLibraryName/index.css')
var button = require('components/lib/styleLibraryName/button.css')

Usage

Via .babelrc or babel-loader.

{
  "plugins": [["load-as-need", options]]
}

Multiple Module

{
  "plugins": [xxx,
    ["load-as-need", {
      libraryName: "antd",
      style: true,
    }, "antd"],
    ["load-as-need", {
      libraryName: "test-module",
      style: true,
    }, "test-module"]
  ]
}

Component directory structure

- lib // 'libDir'
  - index.js // or custom 'root' relative path
  - style.css // or custom 'style' relative path
  - componentA
    - index.js
    - style.css
  - componentB
    - index.js
    - style.css

Theme library directory structure

- lib
  - theme-default // 'styleLibraryName'
    - base.css // required
    - index.css // required
    - componentA.css
    - componentB.css
  - theme-material
    - ...
  - componentA
    - index.js
  - componentB
    - index.js

or

- lib
  - theme-custom // 'styleLibrary.name'
    - base.css // if styleLibrary.base true
    - index.css // required
    - componentA.css // default 
    - componentB.css
  - theme-material
    - componentA
      -index.css  // styleLibrary.path  [module]/index.css
    - componentB
      -index.css
  - componentA
    - index.js
  - componentB
    - index.js

options

• ["load-as-need"]: import js modularly
• ["load-as-need", { "libraryName": "component" }]: module name
• ["load-as-need", { "styleLibraryName": "theme_package" }]: style module name
• ["load-as-need", { "styleLibraryName": "~independent_theme_package" }]: Import a independent theme package
• ["load-as-need", { "styleLibrary": {} }]: Import a independent theme package with more config

  styleLibrary: {
    "name": "xxx", // same with styleLibraryName
    "base": true,  // if theme package has a base.css
    "path": "[module]/index.css",  // the style path. e.g. module Alert =>  alert/index.css
    "mixin": true  // if theme-package not found css file, then use [libraryName]'s css file
  }
  

• ["load-as-need", { "style": true }]: import js and css from 'style.css'
• ["load-as-need", { "style": cssFilePath }]: import style css from filePath
• ["load-as-need", { "libDir": "lib" }]: lib directory
• ["load-as-need", { "root": "index" }]: main file dir
• ["load-as-need", { "camel2Dash": false }]: whether parse name to dash mode or not, default true