Jiess文档

Appearance

react 组件库 ​

位于基础库.jiess/_resource/react/16.8/antd/components目录

SuperTable 组件 ​

基于JiessTable与列表数据请求的深度封装的列表组件

接收参数 ​

首参为midder

函数类型的参数，其首参均为midder，若为Function函数，其this指向SuperTable的上下文

beforeCreate ​

  • 类型 Function
  • 必要 否
  • 说明 midder刚创建完毕后的回调

created ​

  • 类型 Function
  • 必要 否
  • 说明 基础数据初始完毕后的回调

beforeMounte ​

  • 类型 Function
  • 必要 否
  • 说明 挂载前的回调

mounted ​

  • 类型 Function
  • 必要 否
  • 说明 挂载后的回调

beforeUpdate ​

  • 类型 Function
  • 必要 否
  • 说明 更新前的回调

updated ​

  • 类型 Function
  • 必要 否
  • 说明 更新后的回调

title ​

  • 类型 String|NumberReactElement
  • 必要 否
  • 说明 列表表头区标题，位于列表容器左上角

extra ​

  • 类型 String|NumberReactElement
  • 必要 否
  • 说明 列表表头区补充，位于列表容器右上角，常放置列表工具栏

isCard ​

  • 类型 Boolean
  • 默认 true
  • 必要 否
  • 说明 midder刚创建完毕后的回调

注：若table容器不使用card，则容器使用div元素

filter ​

  • 类型 Function
  • 必要 否
  • 返回 渲染节点
  • 说明 构造筛选区，并返回渲染节点

container ​

  • 类型 Function
  • 必要 是
  • 返回 Object
  • 说明 构造容器的配置参数

tableProps ​

  • 类型 Object
  • 必要 否
  • 说明 透传到antd的table组件的参数

tableBoxParam ​

  • 类型 Object
  • 必要 否
  • 说明 列表容器的参数

pagerBoxParam ​

  • 类型 Object
  • 必要 否
  • 说明 分页容器的参数

containerParam ​

  • 类型 Object
  • 必要 否
  • 说明 列表容器参数，通常（isCard为真）作用于card

items ​

  • 类型 Array|Function
  • 必要 否
  • 返回 Array
  • 说明 列表表头配置
js
export default function(midder) {
	return [
		{ text: '表头1', prop: 'field1' },
		{ text: '表头2', prop: 'field2' },
		/* ... */
	]
}

initLayout ​

  • 类型 Function
  • 必要 否
  • 形参 (midder, tableNode)
  • 返回 渲染节点
  • 说明 初始化整体布局，可对节点自定义包装，如左树右表的布局

isCheckbox ​

  • 类型 Boolean
  • 必要 否
  • 默认 true
  • 说明 是否开启复选框

selectionParam ​

  • 类型 Array
  • 必要 否
  • 默认 []
  • 说明 复选参数配置

httpApi ​

  • 类型 Function
  • 必要 是
  • 说明 列表资源数据请求接口

httpKey ​

  • 类型 Object
  • 必要 否
  • 说明 接口的身份标识，用于JiessLoading对接口状态的监听，处理Loading效果

httpTag ​

  • 类型 Object
  • 必要 否
  • 说明 列表唯一标记，配合httpKey，两者组合构成JiessLoading的唯一标识

immedicat ​

  • 类型 Object
  • 必要 否
  • 默认 true
  • 说明 初始化页面渲染完毕后，是否立即加载列表

updateType ​

  • 类型 String
  • 必要 否
  • 默认 listUpdate
  • 可选 listUpdate|tableUpdate
  • 说明 默认按带分页方案处理数据逻辑及数据更新

updateParam ​

  • 类型 Object
  • 必要 否
  • 说明 列表字段的相关参数映射，未自定则使用全局默认映射参数

其余参数，透传给JiessTable组件

TableFilter 组件 ​

与SuperTable组合使用，用于筛选区渲染的组件，渲染风格为普通筛选区

接收参数 ​

改组件接收以下参数

midder ​

  • 类型 Object
  • 必要 是
  • 说明 中介者对象

formParam ​

  • 类型 Object
  • 必要 否
  • 说明 筛选区表单配置的参数

onReset ​

  • 类型 Function
  • 必要 否
  • 说明 点击重置按钮，触发该回调
  • 详细 筛选区重置时，默认使用内置的重置逻辑；若该函数存在，则使用该函数接管重置逻辑

onReset的调用及传参 onReset.call(this, filter.values)

onSearch ​

  • 类型 Function
  • 必要 否
  • 说明 点击搜索按钮，触发该回调
  • 详细 筛选区搜索时，默认使用内置的搜索逻辑；若该函数存在，则使用该函数接管搜索逻辑

onSearch的调用及传参 onSearch.call(this, filter.values)

buttons ​

  • 类型 Object
  • 必要 否
  • 说明 自定义右上角的操作按钮，默认会放置搜索和重置两个按钮
  • 详细 右上按钮区基于ActionButtons配置按钮，自定义按钮时触发filter.onSearch和filter.onReset，分别触发内置的搜索和筛选逻辑

onValuesChange ​

  • 类型 Function
  • 必要 否
  • 说明 筛选区表单数据变化时调用

title ​

  • 类型 Object
  • 默认 筛选区
  • 说明 筛选区左上角的标题

resetPlan ​

  • 类型 Object
  • 默认 1
  • 必要 否
  • 说明 指定内置的重置方案
  • 详情 重置后加载列表（1）；重置后清空列表（2）；

其余属性为area区的配置参数

暴露方法 ​

提供给组件外调用的方法，TableFilter暴露的方法挂载到midder.filter上，下面不再赘述

load ​

  • 参数 (values = { ...baseValues })
  • 说明 手动设定表单区域回显的数据，默认使用初始的基础数据

toValidate ​

  • 参数 ——
  • 说明 手动触发校验（当筛选区表单含数据校验时）

onSearch ​

  • 参数 (callback: Function)
  • 说明 手动触发搜索，存在回调函数，则调用该函数，接管搜索逻辑

回调的调用及传参 callback.call(this, filter.values)

onReset ​

  • 参数 ——
  • 说明 手动触发重置

TableTabs 组件 ​

基于SuperTable；实现一个多分页页面，且每个分页有各自的SuperTable列表

接收参数 ​

TableTabs 组件接收以下参数

tables ​

  • 类型 Array
  • 必要 是
  • 说明 多个SuperTable配置对象所构成的数组

headParam ​

  • 类型 Object
  • 必要 否
  • 说明 组件头部区域的参数配置

defaultKey ​

  • 类型 Object
  • 必要 否
  • 默认 1
  • 说明 默认激活的tab页

其余参数透传给原框架组件Tabs

组件插槽 ​

TableTabs 组件含有以下插槽

  • header 头部插槽，位于组件最顶部，无默认渲染
  • middle 中部插槽，位于筛选区和Tabs组件直接，无默认渲染
  • footer 底部插槽，位于组件最底部，无默认渲染

ActionButton 组件 ​

基于UI封装的按照组件，含tooltip和Popconfirm效果

接收参数 ​

ActionButton 组件接收以下参数

items ​

  • 类型 Array
  • 必要 否
  • 说明 Dropdown按钮的下拉子项配置
  • 详细 items数组长度大于0，则使用Dropdown.Button按钮

onClick ​

  • 类型 Function
  • 必要 否
  • 说明 点击按钮的事件监听器

tip ​

  • 类型 String
  • 必要 否
  • 默认 ——
  • 说明 内容为真，则启用tooltip效果

pop ​

  • 类型 String
  • 必要 否
  • 默认 ——
  • 说明 内容为真，则启用Popconfirm效果

icon ​

  • 类型 String
  • 必要 否
  • 默认 ——
  • 说明 按钮的图标

text ​

  • 类型 String
  • 必要 是
  • 默认 1
  • 说明 按钮中的文案

stop ​

  • 类型 Boolean
  • 必要 否
  • 默认 true
  • 说明 是否阻止冒泡

waitTime ​

  • 类型 Number
  • 必要 否
  • 默认 500
  • 说明 按钮的节流时常

tipParam ​

  • 类型 Object
  • 必要 否
  • 默认 {}
  • 说明 透传到Tooltip组件的配置参数

popParam ​

  • 类型 Object
  • 必要 否
  • 默认 {}
  • 说明 透传到Popconfirm组件的配置参数

其余参数作用于Button组件

TableTools 组件 ​

基于ActionButtons组件封装的列表右上角工具栏组件，增加了列表表头的控制

接收参数 ​

TableTools 组件接收以下参数

midder ​

  • 类型 Object
  • 必要 是
  • 说明 中介者对象

buttons ​

  • 类型 Array
  • 必要 是
  • 说明 按钮配置对象构成的数组集合
  • 详细 该属性的配置规则ActionButtons组件对按钮的配置规则一致

custom ​

  • 类型 Boolean|Function
  • 必要 否
  • 默认 true
  • 说明 启用或开启表头组件，为函数时可自定义该组件的配置参数
  • 详细 表头组件：1、控制列表表头的顺序；2、指定表头的展示与隐藏

其余参数作用于ActionButtons组件