单行文本

介绍

在 NocoBase 中，单行文本（Single line text） 是最常用的文本字段。它适合保存一行以内的短文本内容，比如客户名称、订单编号、联系人、地址摘要、外部系统编号。

单行文本字段默认使用 Input 输入框，默认 Field type 是 string。它可以作为标题字段使用，也可以参与筛选、排序、权限、工作流条件和 API 查询。

如果内容可能需要换行、篇幅较长，默认选择多行文本更合适。如果内容有固定格式，比如邮箱、手机号、URL，可以优先选择对应的专用字段。

适用场景

单行文本适合这些业务场景：

客户名称、公司名称、联系人姓名
订单编号、合同编号、项目编号
任务标题、工单标题、文章标题
外部系统 ID、同步编号、业务编码
城市、地址摘要、门店名称等短文本信息

创建配置

在数据表的「Configure fields」页面中，点击「Add field」，选择「Single line text」可以创建单行文本字段。

20240512163555

配置	说明
Field interface	字段的界面类型。单行文本对应 `input`，页面中默认使用输入框录入和展示。
Field display name	字段在界面中显示的名称，比如「客户名称」「订单编号」「任务标题」。建议使用业务人员能直接理解的名称。
Field name	字段标识名称，用于 API、关系字段、权限、工作流等内部引用。创建后通常不再修改，只支持字母、数字和下划线，并且必须以字母开头。
Field type	字段在数据层的类型。单行文本默认是 `string`，也可以选择 `uid`。普通短文本默认使用 `string` 就够了。
Automatically remove heading and tailing spaces	自动去除首尾空格。适合客户名称、编号、标题等不希望保留首尾空格的内容。
Default value	默认值。新增记录时，如果用户没有填写，可以自动带出默认文本。
Primary	将字段作为主键。只有主数据库新建字段时可用，普通业务文本不建议作为主键。
Unique	唯一约束。适合订单编号、合同编号、外部系统 ID 等不能重复的文本。
Validation rules	校验规则。可以限制最小长度、最大长度、固定长度或正则表达式。
Description	字段说明。适合写字段含义、填写要求、数据来源或维护人。

注意

字段名创建后会被页面区块、权限、工作流和 API 引用。创建前先确认命名，避免后续修改带来配置调整成本。

字段特性

单行文本字段的默认行为如下：

特性	说明
默认 Field interface	`input`。
默认 Field type	`string`。
可选 Field type	`string`、`uid`。
页面组件	编辑模式使用 `Input` 输入框。
标题字段	支持作为数据表标题字段。适合把「客户名称」「订单编号」「任务标题」设为标题字段。
排序	支持在表格区块中排序。
筛选	支持文本类筛选，比如包含、不包含、等于、不等于、为空、不为空等。
校验	支持最小长度、最大长度、固定长度、正则表达式等校验。

编辑配置

创建后，点击字段右侧的「Edit」可以编辑单行文本字段配置。编辑字段主要用于调整字段在 NocoBase 中的展示和使用方式，比如修改显示名称、说明、默认值、校验规则或是否自动去除首尾空格。

如果字段来自主数据库中已经同步的表，编辑时通常是在做字段映射——把数据库字段映射为 NocoBase 的 Field type 和 Field interface。比如数据库里的 varchar、char 等短文本列，可以映射为单行文本字段。

配置	允许编辑	说明
Field display name	是	修改字段在界面中的显示名称，不改变字段标识名称。
Field name	否	字段标识名称创建后通常不能在编辑表单中修改。
Field interface	条件支持	主数据库字段或同步字段在字段映射时可以调整。调整后会影响页面输入、展示和校验方式。
Field type	条件支持	主数据库字段或同步字段在字段映射时可以调整。调整前需要确认已有数据能否按新类型使用。
Automatically remove heading and tailing spaces	是	控制保存时是否去除首尾空格。
Default value	是	调整新增记录时的默认文本。
Unique	条件支持	主数据库新建字段可配置。已有数据如果已经存在重复值，添加唯一约束可能失败。
Validation rules	是	调整长度、格式或正则表达式校验。
Description	是	补充字段含义、填写要求、数据来源或维护人。

注意

切换 Field type 或 Field interface 不等于简单改一个显示名称。它会影响字段的存储方式、输入组件、校验规则、筛选条件和工作流变量使用方式。已有数据较多时，先确认数据格式是否匹配。

删除字段

点击字段右侧的「Delete」可以删除单行文本字段。主数据库中还可以勾选多个字段后批量删除。

删除主数据库中新建的单行文本字段时，通常会同时删除数据库中的真实列及该列已有数据。删除从数据库同步或外部数据源映射出的字段时，影响范围取决于对应数据源和字段来源。

警告

删除字段可能影响页面区块、表单、筛选、权限、工作流、API、导入导出和已有数据。删除前先确认字段是否仍被业务配置引用。

页面配置使用

单行文本字段可以用于大多数数据区块和表单场景。

场景	用途
表单区块	录入或编辑短文本内容，比如客户名称、订单编号、任务标题。
表格区块	展示、排序、筛选短文本内容。内容较长时，表格中会按界面配置省略展示。
详情区块	展示单条记录中的文本信息。
筛选区块	作为查询条件筛选记录，比如按客户名称、编号、标题筛选。
关系字段展示	当单行文本字段被设为标题字段后，关系字段选择记录时会优先显示这段文本。
工作流和权限	作为条件字段参与判断，比如订单编号是否为空、客户名称是否包含某个关键字。

可编辑模式

可编辑模式下，单行文本字段使用输入框录入内容。

20240512164001

阅读模式

阅读模式下，单行文本字段以普通文本方式展示。

20240512164138

#单行文本

#介绍

#适用场景

#创建配置

#字段特性

#编辑配置

#删除字段

#页面配置使用

#可编辑模式

#阅读模式