diff --git a/README.md b/README.md index 73df47f..904f601 100644 --- a/README.md +++ b/README.md @@ -5,28 +5,38 @@ ## Installation Install the pkg with npm: ``` +// v3之前的版本 npm i --save react-area-linkage + +// v3及之后的版本 +npm i --save react-area-linkage area-data ``` + or yarn + ``` -yarn add react-area-linkage +// v3之前的版本 +yarn add react-area-linkage + +// v3及之后的版本 +yarn add react-area-linkage area-data ``` ## Usage ``` import React from 'react'; import ReactDOM from 'react-dom'; - +import { pca, pcaa } from 'area-data'; // v3 or higher import 'react-area-linkage/dist/index.css'; // v2 or higher import { AreaSelect, AreaCascader } from 'react-area-linkage'; // basic - - + + //setting - - + + ``` More demo to visit [here](https://dwqs.github.io/react-area-linkage/). @@ -56,16 +66,16 @@ npm i babel-plugin-on-demand-import -D ``` import 'react-area-linkage/dist/index.css'; // v2 or higher - +import pcaa from 'area-data/pcaa'; // Only import AreaCascader component import { AreaCascader } from 'react-area-linkage'; - + // Only import AreaSelect component import { AreaSelect } from 'react-area-linkage'; - + ``` ## 属性 @@ -79,6 +89,7 @@ import { AreaSelect } from 'react-area-linkage'; | defaultArea | Array | - | [] | 设置默认值(值类型数据需统一,要么全是文本,要么全是区域代码) | | onChange | Function | - | - | 选择项改变时的回调 | | disabled | Boolean | - | false | 是否禁用 | +| data | Object | - | - | 地区数据(v3需要传入) | > v2 仅支持省市区联动,即 v2 不再支持 level 的值为 3 @@ -93,6 +104,7 @@ import { AreaSelect } from 'react-area-linkage'; | onChange | Function | - | - | 选择项改变时的回调 | | disabled | Boolean | - | false | 是否禁用 | | separator | String | - | '/' | 显示选中文本的分隔符 | +| data | Object | - | - | 地区数据(v3需要传入) | ## Related Project * [vue-area-linkage](https://github.com/dwqs/vue-area-linkage/)