容器通用标签

Fields

Field

参数	说明	类型	默认值
name	字段 Key , 如果为对一关联模型字段, 可以通过 . 取子字段, 例如: name 、 address.city	string	-
label	标签名称，如果没有指定取字段上显示名称	string	-
renderType	渲染器，可选, 具体见 Field RenderType	string	-
show	是否显示,  在 table 和 tableform 中不能在表达式中使用 this.record	boolean	-
submit	字段在表单中是否需要提交; show = false 时,默认值为 false ,其他情况下默认值为 true	boolean
readonly	是否只读	boolean	-
editable	是否可切换至编辑，table 和 detail 可用，需要配合 onUpdate 属性使用。	boolean
dependFields	表达式计算依赖字段, 例如: Field1,Field2	string	-
initValue	在容器初始化阶段时会读取这个属性，可以通过它来替换请求之后的数据。 initValue 是一个函数时它会接受两个参数 initValue = "#{(value, data) => value || '初始值'}" initValue = "123456" 例子： <Field name="partner" renderType="Text" initValue="#{ () => this.record.partner[0].id}" /> this 表示当前上下文: { record : any }	function | any	-
helpText	控件下方的文本提示（只适合在 form  和 detail 中使用）	string	-
fixed	固定列可选值 true | false | left | right ，table 可用	string	false

注意：当前例子为 0.17.x 版本

Field RenderType

编辑态：

类型	说明	适用字段类型
Input	文本框	Text
InputNumber	数字输入框	Number
Switch	开关	Boolean
Checkbox	多选框	Boolean
Radio	单选框	Enum
CheckboxGroup	多选框组	Enum
DatePicker	日期选择	Date、DateTime
DateRangePicker	日期范围选择,仅限搜索	Date、DateTime
TimePicker	时间选择	Time
TimeRangePicker	日期范围选择,仅限搜索	Time
Textarea	多行文本	MultiText
RichText	富文本	RichText
Select	下拉选择	Boolean、Enum
Password	密码框	Password
Email	电子邮件	Email
Phone	电话	Phone
Link	链接	Link
Transfer	穿梭框	Enum
Rate	评分	Rate
ModelSelect	关联选择	ToOne、ToMany
CascadeModelSelect	关联自关联模型选择	ToOne、ToMany
Image	图片	Image
Attachment	附件	Attachment
Address	地址	Address

显示态

类型	说明	适用字段类型
Boolean	布尔值	Boolean
Date	日期	Date、DateTime
Time	时间	Time
Enum	枚举	Enum
Rate	评分	Rate
MainField	展示模型的 mainField  信息	ToOne、ToMany
ModelInfo	展示模型的默认字段信息,如果在表格中配置会展示成嵌套表样式	ToOne、ToMany
Image	图片	Image
Attachment	附件	Attachment
Address	地址	Address
Text	文本	*

注意：editable 的字段 renderType 需要指定编辑态和显示态，编辑态要加上 editable 到控件上

<Field name="text" >
  <RenderType>
    <Link />
  </RenderType>
</Field>

GroupField

例子见 Detail

参数	说明	类型	默认值
title	分组显示名称，在 Detail 和 Form 场景下显示为字段分组，在表格场景下显示为多级表头	string	-
label	表格中表头分组名	string	-
singleColumn	当前分组下的 field 单行展示，仅限于 Detail 容器和 Form 容器	boolean	false
key	string	GroupField 的标识，用于挂载分组 action 操作按钮	-

在 GroupField 分组标题栏显示 Action 按钮

<View version="2">
  <Form model="trantor_doc_Person">
    <Fields>
      <Field name="id"/>
      <GroupField title="时间区间" key="timeGroup" >
        <Field name="createdAt"/>
        <Field name="createdAt"/>
      </GroupField>
      <GroupField title="其他信息" key="anotherGroup" >
        <Field name="birthday"/>
      </GroupField>
    </Fields>
    <Actions>
        <!-- 此Action将显示在key为 timeGroup 的GroupField上-->
        <Action layout="GroupField" groupFieldKey="timeGroup" label="分组操作A" />
        <!-- 此Action将显示在key为 another 的GroupField上-->
        <Action layout="GroupField" groupFieldKey="anotherGroup" label="分组操作B" />
        <Action label="其他操作" />
    </Actions>
  </Form>
</View>

Actions

数据容器级别操作

Action

参数	说明	类型	默认值
label	动作显示名	string	-
type	Action 类型，不同的类型对应不同的名称和样式，具体见 ActionType	string	-
renderType	按钮渲染方式，可选值 `Button	Link ,一般情况下为 Button ,表格行操作为 Link` , 树形场景下为结点操作	string | 随场景
show	显示条件	boolean	-
action	对应 Action Key 或者一个方法, 如果是一个异步操作请返回 Promise	string | (actionContext) => void	-
layout	显示位置，可选值 `Header	Footer` , 仅限于 Actions 下 Action 有效	string
disabled	是否禁用	boolean	false
multi	是否支持批量操作	boolean	false
context	触发 action 时上下文, context="#{{modelKey:'user', record: {id:1}}}" 也可以是一个方法 context="#{() => {modelKey:'user', record: {id:1}}}" ,如果需要传多个值 context=#{"{modelKey:'user', record: [{id:1},{id:2]}}"	object | function	-
after	Action 完成后执行的动作，目前支持:  `Refresh(刷新当前数据容器)	GoBack（返回上一视图）| Close (关闭当前视图，不刷新)| [Action Key] | [Controller Method]  | string | (actionContext) => void`	-
openViewType	仅限 View Action, 打开页面方式，可选项： Self | Blank | Dialog | Drawer | Columns	string	self
openViewSize	预设打开页面尺寸，Columns, Dialog, Dawer 可配置 Colums: xs: 25%；s: 33.3%；m: 50%；l: 66%；xl: 75% Dialog: s: 560px；m: 960px；l: 1280px Dawer: s: 560px；m: 720px；l: 960px	s | m | l	Colums 默认值“l” Dialog 默认值 “m” Drawer 默认值 “s”
env	对于 View Action, 可传递参数至下一个页面， 对于 Server Action, 请求时会额外传递 env 参数	string	-
confirm	确认操作提示文案	string | () => string	-
passRelated	将当前容器 related 关系作为 Context 传递给下一个视图	boolean	-
href	配置一个链接地址，在同时配置 action 和 herf 的情况下, 只有 href 会生效	string	-
promptType	配置 Action 错误提示类型的展示方式，可选项： toast | modal , 此属性已废弃, 请通过 Server Action 返回 message 来代替	string	toast
validator	配置 Action 的自定义校验, 如果返回值为 true(校验通过) 或 false(校验不通过,但是没有错误信息提示) 或 错误信息	(context)=> boolean | string | Pormise<boolean | string>	-
successTip	server action 执行成功后提示内容, 如果内容为空则不提示, 此属性已经废弃, 请通过 Server Action 返回 message 来代替	string | ()=> string	-
authKey	配置为一个 actionKey, 用于交付控制台勾选鉴权	string	-

注意：当前例子为 0.17.x 版本

Action Type

action type 用于区分一些特殊的动作，如：
提交动作:<Action type="Submit" /> 
加载动作: <Action type="Download" />

类型	显示名称	默认样式
Normal	-	normal
Create	新增	secondary
Edit	修改	normal
Delete	删除	danger
Query	搜索	normal
Submit	提交	primary
Reset	重置	normal
Back	返回	primary
Cancel	取消	normal
Load	加载, 见: 通过 View 加载数据	normal
Payload	提交	normal

RecordActions

行级别操作, Table 中为行级别操作 , Tree 、 CascadeList 中为结点操作

参数	说明	类型	默认值
label	显示名称	string	-

Alert

数据容器级别提示信息, 位于 Title 下方, 例子

参数	说明	类型	默认值
type	指定警告提示的样式，有四种选择 success | normal | warning | error	string	normal
message	提示信息，可以渲染容器内的 Action	string	-
show	控制该控件的展示隐藏	boolean	true
closable	是否允许用户关闭	boolean	true

场景：提示框中需要展示链接，文本和链接进行混排 写法：在 message 中插入 @{actionKey} ，如下

<Table>
  <Alert message="some test" />
  <Alert message="text@{actionKey}test" />
  <Actions>
    <Action key="actionKey" label="xxx" />
  </Actions>
</Table>

<Detail>
  <Alert message="text@{actionKey}test" />
  <Actions>
    <Action key="actionKey" label="xxx" />
  </Actions>
</Detail>

Title

数据容器标题

参数	说明	类型	默认值
title	标题信息	string	-