# Org 组织选择

# 使用指南

用于选择部门或者人员的组件。

# 代码演示

查看代码

# 与h3-mobile-vue组件的区别以及迁移

旧组件库org组件与listfield组件过于耦合,因此新组件单独做成一个纯粹的弹窗式的组件。

同时也提取出一个单独的h3-org-selector组件便于业务集成

若要做迁移请参考

  1. 弃用的props:prefixCls prefixStyle selectStyle useDefaultIcon hasExtra showSelect showModel title placeholder orgName selectPlaceholder value selectUser selectOrg beforeConfirm

  2. 替换的props:

    • org => data
    • isMulpitle => mulpitle
    • showModel => visible
  3. 新增的props:mode cancel control limit auto

# API

# Prop H3Org

参数 说明 类型 默认值
visible 手动展示或关闭选人控件,v-model绑定值 boolean false
mask 是否显示遮罩 boolean true
safeAreaInsetTop 上方的安全高度 String|Number 0
cancelable 是否允许取消 boolean false
control 是否自主控制显示隐藏,若为true,则需要在 evnet:confirm evnet:cancel 事件中控制 visible 的值为false boolean false
mode all org user,控件选择类型 string all
data 组织数据源 Array<orgItem> []
searchData 搜索结果数据源 Array<orgItem> []
selectedData 已选择的数据 Array<orgItem> []
realTimeSearch 是否实时搜索 boolean true
locale 语言包 stringzh or en zh
mulpitle 是否支持多选 boolean true
limit 多选下即mulpitle=true,限制选择上限 number
auto 限制上限生效即limit=true,是否自动取消之前选中的一个,勾选当前一个 boolean false
allowRecursion 是否允许递归 即选择部门后是否允许再点击下级 boolean true
topNavigation 若数据中没有type: company的类型时,会默认内置一个顶级导航。修改该值来改变默认提示名 string 选择
  • orgItem 配置项
参数 说明 类型 示例
id 唯一标志 string -
name 名称 string 某某部门
type 人员还是部门,类型 org/user/company company 为特殊类型,所有部门归于该类型下 string org
hasChild 部门 Item 是否有下级 boolean false
avatar 人员 Item 头像 string
orglist 搜索结果的部门序列 string '研发中心/前端研发部'

# Event H3Org

事件名称 说明 回调参数
toggle 切换显示时触发,v-model绑定事件 value
show 显示时回调 -
hide 关闭时回调 -
search 点击搜索事件 Function(searchKey:string)
confirm 点击确认按钮事件(返回当前被选中序列) Function(selectedList: Array<orgItem>)
cancel 点击取消按钮事件 Function()
breadcrumb 点击面包屑 Item 返回事件 Function(item: orgItem)
subordinate 点击下级事件 Function(item: orgItem)
outLimit 限制上限生效即limit=true,如果选项超过限制是触发事件 Function(selectedList:Array<orgItem>)

# Prop H3OrgSelector

参数 说明 类型 默认值
value 已选择的数据,v-model绑定值 Array<orgItem> []
data 组织数据源 Array<orgItem> []
mode all org user,控件选择类型 string all
searchData 搜索结果数据源 Array<orgItem> []
realTimeSearch 是否实时搜索 boolean true
locale 语言包 stringzh or en zh
mulpitle 是否支持多选 boolean true
limit 多选下即mulpitle=true,限制选择上限 number
auto 限制上限生效即limit=true,是否自动取消之前选中的一个,勾选当前一个 boolean false
allowRecursion 是否允许递归 即选择部门后是否允许再点击下级 boolean true

# Event H3OrgSelector

事件名称 说明 回调参数
change 选择改变时触发,v-model绑定事件 Function(selectedList: Array<orgItem>)
search 点击搜索事件 Function(searchKey:string)
confirm 点击确认按钮事件(返回当前被选中序列) Function(selectedList: Array<orgItem>)
cancel 点击取消按钮事件 Function()
breadcrumb 点击面包屑 Item 返回事件 Function(item: orgItem)
subordinate 点击下级事件 Function(item: orgItem)
outLimit 限制上限生效即limit=true,如果选项超过限制是触发事件 Function(selectedList:Array<orgItem>)