文本字段
文本字段(Text)用于存储字符串数据,支持单行文本、密码、文本区、Markdown、富文本等多种渲染形式。
概述
文本是最基础、最常用的字段类型,存储值与数据库类型均为字符串(text)。通过文本渲染类型,同一字段可以呈现为输入框、密码框、多行文本区、Markdown 编辑器或富文本编辑器;列表与详情页会按渲染类型采用对应的展示组件。
文本字段还可选配数据源,将输入框变为带候选提示的自动补全框,实现「可自由输入 + 下拉辅助」的效果。
配置项
| 配置项 | 说明 | 适用渲染类型 |
|---|---|---|
| 名称 | 字段显示名称,必填 | 全部 |
| 编码 | 字段唯一编码,必填,创建后不可修改 | 全部 |
| 描述 | 字段用途说明 | 全部 |
| 文本渲染类型 | 决定控件的输入与展示形态 | 全部 |
| 最小长度 | 文本最少字符数,范围 0–100000 | 全部 |
| 最大长度 | 文本最多字符数,范围 0–100000 | 全部 |
| 首字母头像 | 列表中在文本前展 示首字母头像 | 单行文本 |
| 数据源 | 为输入框提供候选提示数据 | 全部 |
| 输入框前缀 | 输入框左侧前缀文本(如 #) | 全部 |
| 输入框后缀 | 输入框右侧后缀文本(如 元) | 全部 |
文本渲染类型
| 渲染类型 | 值 | 说明 | 存储与展示 |
|---|---|---|---|
| 单行文本 | 0 | 标准单行输入框 | 原文存储,列表直接展示 |
| 密码 | 1 | 内容隐藏的输入框 | 原文存储,输入时掩码显示 |
| 文本区 | 2 | 多行文本输入 | 原文存储,不可建索引 |
| Markdown | 3 | Markdown 格式编辑器 | 原文存储,展示时渲染 Markdown,不可建索引 |
| 富文本 | 4 | 富文本(HTML)编辑器 | HTML 存储,展示时渲染富文本,不可建索引 |
索引限制
渲染类型为文本区、Markdown、富文本的字段不会创建 数据库索引;只有单行文本、密码类型支持开启索引。
文本长度限制
最小长度与最大长度用于约束用户输入的字符数,取值范围均为 0–100000。该限制在表单校验阶段生效。
首字母头像
开启「首字母头像」后,单行文本字段在列表中以「头像 + 文本」形式展示,头像内容取文本首字符,适用于姓名、名称类字段。
数据源辅助输入
文本字段可以绑定一个数据源,此时输入框会变成自动补全框:用户既可自由输入,也可从候选列表中选择。该能力常用于「常见取值辅助填写」的场景。
下一步
属性明细
以下内容面向技术实现与 AI 检索。
文本字段属性表
| 属性名 | 类型 | 含义 | 取值/存储值 |
|---|---|---|---|
FieldType | int | 字段类型 | Text = 2 |
TextFieldRenderType | TextFieldRenderTypeEnum | 文本渲染类型 | Text=0 / Password=1 / TextArea=2 / Markdown=3 / RichText=4 |
Properties.TextMinLength | int? | 最小长度 | 0–100000 |
Properties.TextMaxLength | int? | 最大长度 | 0–100000 |
Properties.ShowInitialAvatar | bool | 是否展示首字母头像 | 默认 false,仅单行文本生效 |
Properties.Prefix | string | 输入框前缀 | 如 # |
Properties.Suffix | string | 输入框后缀 | 如 元 |
DataSourceSelect | string | 候选数据源标识 | 数据源接口 Id,可空 |
前端读写的属性名
表单/视图渲染时,Properties 中的属性会被展平为前端 FieldMetaItem 的驼峰字段(如 TextMinLength、TextMaxLength、ShowInitialAvatar)。
存储示例
字段定义(system_metafield):
{
"Code": "remark",
"Name": "备注",
"FieldType": 2,
"TextFieldRenderType": 2,
"Properties": {
"TextMinLength": 0,
"TextMaxLength": 500
}
}
对象数据中该字段的存储值:
{
"Fields": {
"remark": {
"Code": "remark",
"Text": "客户要求尽快发货",
"Value": "客户要求尽快发货"
}
}
}
文本渲染类型枚举值
| 枚举名 | 值 | 中文含义 |
|---|---|---|
Text | 0 | 普通文本 |
Password | 1 | 密码 |
TextArea | 2 | 文本区 |
Markdown | 3 | Markdown |
RichText | 4 | 富文本 |