Mobile-org NPM

Mobile Org

Introduction

移动端组织架构数据选择方案，包括组织机构、角色以及人员等分类，支持单选、多选、关键字段自定义以及多种事件及插槽等，适用于大部分组织选人场景。

支持懒加载回调，点击获取当前组织下的子组织及人员等
支持单选、多选、必选等条件限制
支持自定义子节点、key 值、头像等字段
支持自定义可选类型
多事件绑定类型，实现全生命周期全监测
多部位插槽，支持默认样式以及快速实现定制化

Modules

Instructions

Functional demonstration


单选	多选	搜索

Attributes

prop	type	options	default	description
data	Array	一	[]	渲染数据源
label	String	一	name	展示字段名称
nodeKey	String	一	id	数据 key(如: id)
children	String	一	children	子节点的字段名称
icon	String	一	avatar	头像的字段名称
isShowClearBtn	Boolean	一	true	是否显示搜索框右侧的清除按钮
isShowIcon	Boolean	一	false	是否显示图标
defaultIcon	String	一	一	默认图标，本地图片引用：`:defaultIcon="require('@/assets/demo/icon.jpg')"`
checkboxStyle	String	round/square	round	复选框显示样式，正方形 square 或圆形 round
isMultiple	Boolean	一	true	是否多选
selectTypes	Array	一	'user', 'org', 'role'	可选项，user 用户，org，组织部门，role 角色
isSelectRequired	Boolean	一	true	是否必选
selectedList	Array	一	[]	已经选择的数据，可用作回显
slideDistance	Number	一	100	滑动手时触发距离
searchPlaceholder	String	一	搜索	搜索框提示占位符文字
defaultShowType	String	org/role	org	默认展示类型
orgText	String	一	组织	切换按钮 org 文字
roleText	String	一	角色	切换按钮 role 文字
submitText	String	一	提交	提交按钮文字
cancelText	String	一	取消	取消按钮文字

Events

name	description	parameter	remark
on-select	点击选项时触发，返回当前点击的选项信息	item	—
on-submit	提交时触发，返回所有已选项	selectedItems	—
on-cancel	点击取消按钮时候触发，可用来关闭组件等	—	—
on-search	搜索框输入时候触发	searchKey	—
on-expand	点击下级时候触发	currentNode	—
on-nav	点击面包屑导航时触发	currentNode	返回 `-1` 时为点击全部
on-clear	点击清除搜索框时候触发	—	—
on-slide	滑动手势触发的事件	—	—
on-switch-show-type	点击切换显示类型按钮触发	showType	—

Slots

name	description	parameter
switch-show-type-btn	切换显示类型按钮插槽	showType
content-area	中间内容区	renderData
empty-tips	无数据时提示信息	—
selected-list	已经选择项的集合展示区	selectedItems
result-area	底部操作区	selectedItems

Install

npm install mobile-org -S

Quick Start

import Vue from "vue";

// import mobile-org component
import MobileOrg from "mobile-org";
// import mobile-org style file
import "mobile-org/mobile-org.css";

Vue.use(MobileOrg);

Demo

<MobileOrg
  :data="data"
  label="name"
  children="children"
  icon="avatar"
  :isMultiple="true"
  :selectedList="selectedList"
  @on-submit="handleSubmit"
  @on-search="handleSearch"
  @on-expand="handleExpand"
  @on-nav="handleNav"
  @on-clear="clearSearchKey"
  @on-switch-show-type="handleSwitchShowType"
>
  <!-- 此处示例插槽只做展示，非必需，如无特殊需求，不建议使用。 -->
  <!-- 切换显示类型按钮插槽 -->
  <template slot="switch-show-type-btn" slot-scope="scope">
    通过 scope.showType 来获取切换的显示类型
  </template>

  <!-- 内容区插槽 -->
  <template slot="content-area" slot-scope="scope">
    通过 scope.renderData 来获取显示区数据
  </template>

  <!-- 无数据提示信息插槽 -->
  <template slot="empty-tips"> 暂无数据 </template>

  <!-- 底部已选项展示区插槽 -->
  <template slot="selected-list" slot-scope="scope">
    通过 scope.selectedItems 来获取已选项数据
  </template>

  <!-- 底部操作区插槽 -->
  <template slot="result-area" slot-scope="scope">
    通过 scope.selectedItems 来获取已选项数据
  </template>
</MobileOrg>

Function realization

数据渲染

将 data 绑定对应数据即可

// 需将数据转换为以下结构(以组织部分代码为例), name 和 id 可通过 prop 属性进行自定义
[
  {
    name: "研发部",
    id: "3zs96s5ddds2c4f1re5",
    children: [],
    type: "org",
    avatar: "",
  },
  {
    name: "人事部",
    id: "5ef2eo2qwh56yil15wa",
    avatar: "",
    type: "org",
    children: [
      {
        name: "培训组",
        id: "a3s5d21v4forut96521",
        avatar: "",
        type: "org",
        children: [
          {
            name: "张晓丽",
            id: "3a6s5d2f8d555e4r1fp",
            type: "user",
            avatar: "",
          },
        ],
      },
      {
        name: "赵海",
        id: "a8s5d4c111d4f5e2f3s",
        type: "user",
        avatar: "",
      },
    ],
  },
];