辅助文本
辅助文本字段存储自由文本,并在用户输入时给出建议。适合那些会重复出现、但又不适合做成固定选项的内容:职位、项目名称、手工填写的分类、常用备注等。
建议只是提示:用户始终可以保存不在建议列表里的文本,字段不会限制输入范围。如果只允许保存配置好的选项,请改用单选下拉或单选字段。
基础设置
| 设置 | 说明 |
|---|---|
| 名称 | 用户看到的字段标签,必填,应清楚表达字段的业务含义 |
| API 名称 | 数据接口、脚本、公式、导入和集成使用的稳定技术名,必填 |
| 必填 | 用户必须填写后才能保存记录 |
| 只读 | 显示字段内容,但不允许用户修改 |
| 禁用 | 让字段在正常使用中不可用 |
| 隐藏 | 仍然存储字段值,但在正常表单页面中不显示 |
这些开关会相互影响:例如字段不能同时「必填」和「隐藏」,只读字段也不能同时必填、禁用或隐藏。
建议来源
| 来源 | 说明 |
|---|---|
| 预设列表 | 建议来自字段上维护的文本条目 |
| Studio 脚本 | 建议由 Studio 服务端脚本根据当前输入和草稿数据计算得出 |
预设列表
| 操作 | 说明 |
|---|---|
| 新增预设 | 增加一个空行,输入要提示的文本 |
| 删除 | 把这条预设从字段上移除 |
每条预设同时存成标签和值,两者都是用户看到并写入字段的文本。预设只是建议,用户仍然可以输入并保存其它文本。
Studio 脚本
| 项目 | 说明 |
|---|---|
| 脚本 | 产出建议的 Studio 脚本 |
| 入口文件 | 脚本里的入口文件,建议由该文件的 main 函数返回 |
- 脚本和入口文件都要选:缺任意一个都无法保存字段
- 脚本返回
{ suggestions: ["建议文本"] }。空文本、只有空白的文本和重复文本会被去掉,顺序保留,单次执行最多采用 100 条 - 脚本在用户输入之后按当前查询执行;运行时对查询做了 250ms 防抖,输入为空时不会调用脚本
- 脚本执行失败时建议列表为空,但不会阻止用户自由输入
- 运行时还会对建议做大小写不敏感的匹配,所以脚本可以返回候选、由运行时缩小范围
脚本可以通过 payload 读取当前草稿值,因此建议可以依赖其它字段。完整的输入结构、返回契约和可直接运行的示例见辅助文本建议。
只读表格、详情页和筛选条件不会执行建议脚本。
输入设置
| 设置 | 说明 |
|---|---|
| 占位提示 | 用户输入前显示在输入框里的提示文字 |
| 最大长度 | 允许保存的最大字符数;没有上限时留空 |
| 允许清空 | 显示清空操作,方便用户清掉已填内容 |
辅助说明
辅助文本用于填写时始终可见的简短说明,例如这个字段通常应该填哪类文本。
运行时行为
| 行为 | 说明 |
|---|---|
| 输入时提示 | 用户输入后才出现建议;聚焦空字段时不显示 |
| 选择建议 | 把该文本原样写入字段 |
| 自由输入 | 任何文本都可以保存,包括从未出现在建议里的文本 |
| 校验 | 按保存的文本做必填和最大长度校验 |
| 只读场景 | 只读表格、详情页和筛选条件只显示已存文本,不请求建议 |
| 默认值 | 辅助文本字段没有默认值配置,见默认值配置 |
存储值
字段值是纯文本,dataType 为 'string',脚本、公式、导出和分析都会按文本处理。共同的字符串契约见字符串字段类型。