ifui/docs/markdown/quickstart.en-US.md

## Quickstart

### Starter kit

Use [vue-cli](https://github.com/vuejs/vue-cli) to create a ifu project.

```shell
vue init youzan/vue-cli-template-ifu projectName
```

### Install

#### NPM

```shell
npm i ifu -S
```

#### YARN

```shell
yarn add ifu
```

#### CDN

```html
<!-- import style -->
<link rel="stylesheet" href="https://unpkg.com/ifu/lib/ifu-css/index.css" />

<!-- import script -->
<script src="https://unpkg.com/vue/dist/vue.min.js"></script>
<script src="https://unpkg.com/ifu/lib/ifu.min.js"></script>
```

### Usage

#### 1. Use [babel-plugin-import](https://github.com/ant-design/babel-plugin-import) (Recommended)

```bash
# Install babel-plugin-import
npm i babel-plugin-import -D
```

```js
// set babel config in .babelrc or babel-loader
// Note: Don't set libraryDirectory if you are using webpack 1.
{
  "plugins": [
    ["import", {
      "libraryName": "ifu",
      "libraryDirectory": "es",
      "style": true
    }]
  ]
}
```

Then you can import components from ifu, equivalent to import manually below.

```js
import { Button } from 'ifu';
```

> If you are using TypeScript，please use [ts-import-plugin](https://github.com/Brooooooklyn/ts-import-plugin) instead

#### 2. Manually import

```js
import Button from 'ifu/lib/button';
import 'ifu/lib/ifu-css/base.css';
import 'ifu/lib/ifu-css/button.css';
```
 
#### 3. Import all components

```js
import Vue from 'vue';
import ifu from 'ifu';
import 'ifu/lib/ifu-css/index.css';

Vue.use(ifu);
```

> If you configured babel-plugin-import, you won't be allowed to import all components.


### Rem units

ifu use `px` as size units by default，you can use tools such as `postcss-pxtorem` to transform units to `rem`.

- [postcss-pxtorem](https://github.com/cuth/postcss-pxtorem)
- [lib-flexible](https://github.com/amfe/lib-flexible)

postcss config example:

```js
module.exports = {
  plugins: {
    'autoprefixer': {
      browsers: ['Android >= 4.0', 'iOS >= 7']
    }
    'postcss-pxtorem': {
      rootValue: 37.5,
      propList: ['*']
    }
  }
}
```