0.0.1 • Published 1 month ago

@hzab/org-list v0.0.1

Weekly downloads
-
License
ISC
Repository
-
Last release
1 month ago

@hzab/org-list

TODO: description

Usage

const OrgList = require('@hzab/org-list');

API

InfoPanel Attributes

参数类型必填默认值说明
defaultBreadcrumbsArray-默认的面包屑数据 { title: "xxx", id: 1 }
userConfObject-用户数据配置项
orgConfObject-部门数据配置项
globalSearchConfObject-全局人员搜索数据配置项
showEmptyOrgbooleantrue是否展示数量为 0 的部门
virtualizedbooleanfalse是否开启虚拟滚动
pageRownumber6虚拟滚动页面行数
hasFilterbooleantrue是否有筛选按钮
defaultQueryObject-初始的 query 数据
filterSchemaObject-筛选表单 schema
filterFormPropsObject-筛选表单 props
checkUserbooleantrue是否支持选中人员
checkOrgbooleanfalse是否支持选中部门
onCheckedChangeFunction-选中状态改变 (userChecked, orgChecked) => void
ItemRenderFunction-子项渲染函数 (props) => ReactElement
ItemInfoRenderFunction-子项信息部分渲染函数 (props) => ReactElement
checkItemShowFunction-判断当前列表项是否展示 (item, index?: number, props?: Object) => boolean
onItemClickFunction-子项点击事件,返回 false 进行事件拦截 (item, props) => void | boolean
showUserboolean-是否直接展示人员列表
hasUserboolean-是否存在人员列表
hasOrgboolean-是否存在部门列表
showFooterboolean-是否展示底部
FooterFunction-底部渲染函数 (props) => ReactElement
keysObject-出入参键名字段枚举
i18nObject-文案
keepBreadcrumbboolean-是否缓存面包屑数据
keepCheckedboolean-是否选中数据

userConf

参数类型必填默认值说明
idKeystringuserIdid 字段值
listDMObject-列表请求 DataModel 实例
listApistring-列表请求接口
getListFuncFunction-获取列表数据的自定义函数 (query) => { pagination: { total: number; current: number }; list: Array }
defaultQueryObject-初始的 query 数据
showMoreboolean-是否展示分页触发器

orgConf

  • 参数继承 userConf,特有参数如下:
参数类型必填默认值说明
treeDMObject-部门树数据请求 DataModel 实例
treeApistring-部门树数据请求接口地址

globalSearchConf

  • 参数继承 userConf

keys

参数类型必填默认值说明
globalSearchKeysObject-globalSearch 相关键名
userKeysObject-用户列表 相关键名
orgKeysObject-部门列表 相关键名
globalSearchKeys
参数类型必填默认值说明
idKeystring-id 键名
nameKeystring-name 键名
avatarKeystring-头像 键名
parentIdKeystring-父级 id 键名
userKeys
  • 参数继承 globalSearchKeys,特有参数如下:
参数类型必填默认值说明
orgNameKeystring-用户所属部门名称键名
orgIdKeystring-用户所属部门 id 键名
orgKeys
  • 参数继承 globalSearchKeys,特有参数如下:
参数类型必填默认值说明
userCountKeystring-部门人员统计数量字段 键名

i18n

参数类型必填默认值说明
collapsePrefixstring本级用户折叠面板 前缀文案
collapseSuffixstring用户折叠面板 后缀文案
globalSearchPlaceholderstring请输入搜索内容全局搜索 placeholder
checkedPrefixstring当前选中底部选中前缀文案
checkedSuffixstring底部选中后缀文案