Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

region-select

Package Overview
Dependencies
Maintainers
5
Versions
77
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

region-select

地区级联选择框

  • 0.4.12
  • latest
  • npm
  • Socket score

Version published
Weekly downloads
21
decreased by-85.91%
Maintainers
5
Weekly downloads
 
Created
Source

region-select

引入

yarn add region-select
npm i region-select

依赖项:
element-ui

版本迭代

RegionSelect 0.4.3 版本
取消外部数据源,由于组件维护全国地区树JSON (如有个性化数据源,可通过data重置数据源)
如需部分地区地区树,可用filter筛选

测试版本
为0.1.0版本号开头

引入

yarn add region-select
npm i region-select

简介

region-select 是基于 Element Cascader 开发的全国地区级联选择组件,组件内置全国通用地区数据,支持指定地区、层级过滤(如只需要贵州省所属州市选择)。

使用

地区级联选择组件,根据所选最后一级id数据级联选中

<RegionSelect 
    v-model="areaCode"          选中地区 code
/>

全局配置

如需在项目中对组件进行一些公共配置,可在 main.js 注册组件时,注入 config 属性对象

* 在页面中对 config 中属性进入重复设置,会覆盖全局设置 * 

import RegionSelect from 'region-select'

Vue.use(RegionSelect,{
    filter:'520000000000',     地区过滤,是否只需要其子类地区
    level = '2'                地区树显示层级(如有地区过滤,则为过滤后地区树的层级)   
    placeholder = '所属地区'   占位文本
    props = option.props       属性绑定
    data = areaTree            全局自定义地区树
})




地区选择级联属性

参数说明类型可选值默认值
v-model选中地区 codestring
data组件内置标准全国数据源,如有个性化数据源,可通过data重置数据源array自定义数据源格式下有详情标准全国数据源
label.sync选中地区最后一级labelstring
pathLabel.sync选中地区全路径string
filter地区过滤,是否只需要部分地区string
filterShowChild只显示过滤地区的子类地区(需 filter 过滤才会生效)booleantrue / falsefalse
level地区树显示层级(如有地区过滤,则为过滤后地区树的层级) number
collapseTags折叠展示Tagbooleantrue / falsetrue
props配置选项,具体见下表object



element 级联原生属性

参数说明类型可选值默认值
datasizestringmedium / small / mini
placeholder输入框占位文本string请选择
clearable是否禁用booleanfalse
clearable是否支持清空选项booleanfalse
show-all-levels输入框中是否显示选中值的完整路径booleantrue
data组件内置array



Props

参数说明类型可选值默认值
checkStrictly任意层级可选booleantrue / falsefalse
multiple是否多选(返回数据为字符数组)booleantrue / falsefalse
label指定选项标签为选项对象的某个属性值string
value指定选项的值为选项对象的某个属性值string



事件

事件名称说明回调参数
change当选中节点变化时触发选中节点的值
handleExpandChange当选中节点变化时触发返回节点node,可在node中获取所有的父类信息



自定义数据源格式

[
    {
        label: "呼和浩特市",
        value: '001',
        children: [
            {
                label: "市辖区",
                value: '0011'
            },
            {
                label: "东河区",
                value: '0012'
            },
            {
                label: "昆都仑区",
                value: '0013'
            },
        ]
    }
]

FAQs

Package last updated on 18 Dec 2023

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc