https://github.com/sinchang/vue-distpicker

A simple Vue component for picking provinces, cities and districts of China.
https://github.com/sinchang/vue-distpicker

component distpicker vue

Last synced: 7 days ago
JSON representation

A simple Vue component for picking provinces, cities and districts of China.

• Host: GitHub
• URL: https://github.com/sinchang/vue-distpicker
• Owner: sinchang
• Created: 2017-02-14T15:50:36.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2018-01-06T15:49:18.000Z (almost 7 years ago)
• Last Synced: 2024-12-23T04:47:33.431Z (11 days ago)
• Topics: component, distpicker, vue
• Language: Vue
• Homepage: https://distpicker.netlify.com/
• Size: 213 KB
• Stars: 2
• Watchers: 2
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# vue-distpicker

[![NPM version](https://img.shields.io/npm/v/vue-distpicker.svg?style=flat)](https://npmjs.com/package/vue-distpicker) [![NPM downloads](https://img.shields.io/npm/dm/vue-distpicker.svg?style=flat)](https://npmjs.com/package/vue-distpicker) [![CircleCI](https://circleci.com/gh/sinchang/vue-distpicker/tree/master.svg?style=shield)](https://circleci.com/gh/sinchang/vue-distpicker/tree/master) [![codecov](https://codecov.io/gh/sinchang/vue-distpicker/branch/master/graph/badge.svg)](https://codecov.io/gh/sinchang/vue-distpicker)

A simple Vue component for picking provinces, cities and districts of China.

## Install

```bash

yarn add vue-distpicker

```

CDN: [UNPKG](https://unpkg.com/vue-distpicker/) | [jsDelivr](https://cdn.jsdelivr.net/npm/vue-distpicker/) (available as `window.Distpicker`)

## Usage

```vue

  

import Distpicker from 'vue-distpicker'

export default {

  components: {

    Distpicker

  }

}

```

## API

| Name | Type | Description |

| --- | --- | --- |

| ids | Array | 默认传入省市区的 id |

| change | Function | 返回选择的省市区数据包含 id 以及 name |

| prov | String | 省份选择框 name 值 |

| city | String | 城市选择框 name 值 |

| dist | String | 地区选择框 name 值 |

| prov-placeholder | String | 省份选择框 placeholder 值 |

| city-placeholder | String | 城市选择框 placeholder 值 |

| dist-placeholder | String | 地区选择框 placeholder 值 |

## License

MIT © [sinchang](https://sinchang.me)