跳到主要内容

文本字段

文本字段（Text）用于存储字符串数据，支持单行文本、密码、文本区、Markdown、富文本等多种渲染形式。

概述​

文本是最基础、最常用的字段类型，存储值与数据库类型均为字符串（text）。通过文本渲染类型，同一字段可以呈现为输入框、密码框、多行文本区、Markdown 编辑器或富文本编辑器；列表与详情页会按渲染类型采用对应的展示组件。

文本字段还可选配数据源，将输入框变为带候选提示的自动补全框，实现「可自由输入 + 下拉辅助」的效果。

配置项​

配置项说明适用渲染类型
名称字段显示名称，必填全部
编码字段唯一编码，必填，创建后不可修改全部
描述字段用途说明全部
文本渲染类型决定控件的输入与展示形态全部
最小长度文本最少字符数，范围 0–100000全部
最大长度文本最多字符数，范围 0–100000全部
首字母头像列表中在文本前展示首字母头像单行文本
数据源为输入框提供候选提示数据全部
输入框前缀输入框左侧前缀文本（如 #）全部
输入框后缀输入框右侧后缀文本（如 元）全部

文本渲染类型​

渲染类型值说明存储与展示
单行文本0标准单行输入框原文存储，列表直接展示
密码1内容隐藏的输入框原文存储，输入时掩码显示
文本区2多行文本输入原文存储，不可建索引
Markdown3Markdown 格式编辑器原文存储，展示时渲染 Markdown，不可建索引
富文本4富文本（HTML）编辑器HTML 存储，展示时渲染富文本，不可建索引
索引限制

渲染类型为文本区、Markdown、富文本的字段不会创建数据库索引；只有单行文本、密码类型支持开启索引。

文本长度限制​

最小长度与最大长度用于约束用户输入的字符数，取值范围均为 0–100000。该限制在表单校验阶段生效。

首字母头像​

开启「首字母头像」后，单行文本字段在列表中以「头像 + 文本」形式展示，头像内容取文本首字符，适用于姓名、名称类字段。

数据源辅助输入​

文本字段可以绑定一个数据源，此时输入框会变成自动补全框：用户既可自由输入，也可从候选列表中选择。该能力常用于「常见取值辅助填写」的场景。

下一步​

属性明细​

以下内容面向技术实现与 AI 检索。

文本字段属性表​

属性名类型含义取值/存储值
FieldTypeint字段类型Text = 2
TextFieldRenderTypeTextFieldRenderTypeEnum文本渲染类型Text=0 / Password=1 / TextArea=2 / Markdown=3 / RichText=4
Properties.TextMinLengthint?最小长度0–100000
Properties.TextMaxLengthint?最大长度0–100000
Properties.ShowInitialAvatarbool是否展示首字母头像默认 false，仅单行文本生效
Properties.Prefixstring输入框前缀如 #
Properties.Suffixstring输入框后缀如 元
DataSourceSelectstring候选数据源标识数据源接口 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": "客户要求尽快发货"
    }
  }
}

文本渲染类型枚举值​

枚举名值中文含义
Text0普通文本
Password1密码
TextArea2文本区
Markdown3Markdown
RichText4富文本