@nocobase/plugin-ai 2.3.0-alpha.1 → 3.0.0-alpha.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (246) hide show
  1. package/dist/ai/docs/nocobase/ai-employees/block/ai-chat-box.md +133 -0
  2. package/dist/ai/docs/nocobase/ai-employees/knowledge-base/knowledge-base/documents.md +1 -1
  3. package/dist/ai/docs/nocobase/ai-employees/knowledge-base/knowledge-base/index.md +11 -7
  4. package/dist/ai/docs/nocobase/ai-employees/knowledge-base/knowledge-base/settings.md +12 -8
  5. package/dist/ai/docs/nocobase/ai-employees/knowledge-base/vector-database.md +3 -3
  6. package/dist/ai/docs/nocobase/ai-employees/workflow/nodes/knowledge/create-document.md +1 -1
  7. package/dist/ai/docs/nocobase/api/app/env.md +3 -1
  8. package/dist/ai/docs/nocobase/api/cli/index.md +14 -2
  9. package/dist/ai/docs/nocobase/api/cli/portal/config.md +44 -0
  10. package/dist/ai/docs/nocobase/api/cli/portal/create.md +48 -0
  11. package/dist/ai/docs/nocobase/api/cli/portal/deploy.md +39 -0
  12. package/dist/ai/docs/nocobase/api/cli/portal/destroy.md +41 -0
  13. package/dist/ai/docs/nocobase/api/cli/portal/dev.md +39 -0
  14. package/dist/ai/docs/nocobase/api/cli/portal/index.md +136 -0
  15. package/dist/ai/docs/nocobase/api/cli/portal/info.md +41 -0
  16. package/dist/ai/docs/nocobase/api/cli/portal/list.md +40 -0
  17. package/dist/ai/docs/nocobase/api/cli/portal/pull.md +43 -0
  18. package/dist/ai/docs/nocobase/api/cli/portal/push.md +41 -0
  19. package/dist/ai/docs/nocobase/building-tips/ai-fill-js-block-form.md +1092 -0
  20. package/dist/ai/docs/nocobase/data-sources/calendar/calendar-collection.md +100 -3
  21. package/dist/ai/docs/nocobase/data-sources/collection-comment/index.md +92 -39
  22. package/dist/ai/docs/nocobase/data-sources/collection-sql/index.md +150 -29
  23. package/dist/ai/docs/nocobase/data-sources/collection-tree/index.md +93 -5
  24. package/dist/ai/docs/nocobase/data-sources/collection-view/index.md +226 -4
  25. package/dist/ai/docs/nocobase/data-sources/data-modeling/collection-fields/advanced/china-region.md +122 -5
  26. package/dist/ai/docs/nocobase/data-sources/data-modeling/collection-fields/advanced/collection-select.md +105 -4
  27. package/dist/ai/docs/nocobase/data-sources/data-modeling/collection-fields/advanced/json.md +102 -4
  28. package/dist/ai/docs/nocobase/data-sources/data-modeling/collection-fields/advanced/nano-id.md +104 -4
  29. package/dist/ai/docs/nocobase/data-sources/data-modeling/collection-fields/advanced/snowflake-id.md +108 -4
  30. package/dist/ai/docs/nocobase/data-sources/data-modeling/collection-fields/advanced/sort.md +3 -19
  31. package/dist/ai/docs/nocobase/data-sources/data-modeling/collection-fields/advanced/uuid.md +104 -4
  32. package/dist/ai/docs/nocobase/data-sources/data-modeling/collection-fields/associations/index.md +44 -8
  33. package/dist/ai/docs/nocobase/data-sources/data-modeling/collection-fields/basic/color.md +102 -4
  34. package/dist/ai/docs/nocobase/data-sources/data-modeling/collection-fields/basic/email.md +104 -4
  35. package/dist/ai/docs/nocobase/data-sources/data-modeling/collection-fields/basic/icon.md +102 -4
  36. package/dist/ai/docs/nocobase/data-sources/data-modeling/collection-fields/basic/input.md +112 -8
  37. package/dist/ai/docs/nocobase/data-sources/data-modeling/collection-fields/basic/integer.md +103 -4
  38. package/dist/ai/docs/nocobase/data-sources/data-modeling/collection-fields/basic/number.md +103 -4
  39. package/dist/ai/docs/nocobase/data-sources/data-modeling/collection-fields/basic/password.md +102 -4
  40. package/dist/ai/docs/nocobase/data-sources/data-modeling/collection-fields/basic/percent.md +104 -5
  41. package/dist/ai/docs/nocobase/data-sources/data-modeling/collection-fields/basic/phone.md +104 -4
  42. package/dist/ai/docs/nocobase/data-sources/data-modeling/collection-fields/basic/textarea.md +99 -8
  43. package/dist/ai/docs/nocobase/data-sources/data-modeling/collection-fields/basic/url.md +103 -4
  44. package/dist/ai/docs/nocobase/data-sources/data-modeling/collection-fields/choices/checkbox-group.md +105 -3
  45. package/dist/ai/docs/nocobase/data-sources/data-modeling/collection-fields/choices/checkbox.md +102 -4
  46. package/dist/ai/docs/nocobase/data-sources/data-modeling/collection-fields/choices/china-region.md +108 -5
  47. package/dist/ai/docs/nocobase/data-sources/data-modeling/collection-fields/choices/multiple-select.md +103 -5
  48. package/dist/ai/docs/nocobase/data-sources/data-modeling/collection-fields/choices/radio-group.md +106 -4
  49. package/dist/ai/docs/nocobase/data-sources/data-modeling/collection-fields/choices/select.md +103 -5
  50. package/dist/ai/docs/nocobase/data-sources/data-modeling/collection-fields/datetime/date.md +102 -4
  51. package/dist/ai/docs/nocobase/data-sources/data-modeling/collection-fields/datetime/datetime-without-tz.md +103 -5
  52. package/dist/ai/docs/nocobase/data-sources/data-modeling/collection-fields/datetime/datetime.md +103 -5
  53. package/dist/ai/docs/nocobase/data-sources/data-modeling/collection-fields/datetime/index.md +53 -47
  54. package/dist/ai/docs/nocobase/data-sources/data-modeling/collection-fields/datetime/time.md +102 -4
  55. package/dist/ai/docs/nocobase/data-sources/data-modeling/collection-fields/datetime/unix-timestamp.md +103 -5
  56. package/dist/ai/docs/nocobase/data-sources/data-modeling/collection-fields/geometric/circle.md +102 -4
  57. package/dist/ai/docs/nocobase/data-sources/data-modeling/collection-fields/geometric/line.md +103 -5
  58. package/dist/ai/docs/nocobase/data-sources/data-modeling/collection-fields/geometric/point.md +102 -4
  59. package/dist/ai/docs/nocobase/data-sources/data-modeling/collection-fields/geometric/polygon.md +102 -4
  60. package/dist/ai/docs/nocobase/data-sources/data-modeling/collection-fields/index.md +62 -16
  61. package/dist/ai/docs/nocobase/data-sources/data-modeling/collection-fields/media/markdown.md +104 -4
  62. package/dist/ai/docs/nocobase/data-sources/data-modeling/collection-fields/media/rich-text.md +105 -5
  63. package/dist/ai/docs/nocobase/data-sources/data-modeling/collection-fields/system-info/created-at.md +105 -5
  64. package/dist/ai/docs/nocobase/data-sources/data-modeling/collection-fields/system-info/created-by.md +103 -5
  65. package/dist/ai/docs/nocobase/data-sources/data-modeling/collection-fields/system-info/space.md +100 -6
  66. package/dist/ai/docs/nocobase/data-sources/data-modeling/collection-fields/system-info/table-oid.md +102 -4
  67. package/dist/ai/docs/nocobase/data-sources/data-modeling/collection-fields/system-info/updated-at.md +104 -5
  68. package/dist/ai/docs/nocobase/data-sources/data-modeling/collection-fields/system-info/updated-by.md +104 -6
  69. package/dist/ai/docs/nocobase/data-sources/data-modeling/collection-fields/validation.md +68 -58
  70. package/dist/ai/docs/nocobase/data-sources/data-modeling/collection.md +32 -13
  71. package/dist/ai/docs/nocobase/data-sources/data-modeling/index.md +41 -33
  72. package/dist/ai/docs/nocobase/data-sources/data-source-external-mariadb/index.md +114 -6
  73. package/dist/ai/docs/nocobase/data-sources/data-source-external-mssql/index.md +117 -6
  74. package/dist/ai/docs/nocobase/data-sources/data-source-external-mysql/index.md +103 -6
  75. package/dist/ai/docs/nocobase/data-sources/data-source-external-nocobase/index.md +75 -73
  76. package/dist/ai/docs/nocobase/data-sources/data-source-external-oracle/index.md +129 -11
  77. package/dist/ai/docs/nocobase/data-sources/data-source-external-postgres/index.md +110 -6
  78. package/dist/ai/docs/nocobase/data-sources/data-source-kingbase/index.md +75 -49
  79. package/dist/ai/docs/nocobase/data-sources/data-source-main/general-collection.md +116 -15
  80. package/dist/ai/docs/nocobase/data-sources/data-source-main/index.md +92 -62
  81. package/dist/ai/docs/nocobase/data-sources/data-source-main/inheritance-collection.md +97 -10
  82. package/dist/ai/docs/nocobase/data-sources/data-source-manager/external-database.md +97 -58
  83. package/dist/ai/docs/nocobase/data-sources/data-source-manager/index.md +32 -24
  84. package/dist/ai/docs/nocobase/data-sources/data-source-rest-api/index.md +115 -153
  85. package/dist/ai/docs/nocobase/data-sources/external/clickhouse.md +124 -0
  86. package/dist/ai/docs/nocobase/data-sources/external/doris.md +130 -0
  87. package/dist/ai/docs/nocobase/data-sources/external/index.md +140 -0
  88. package/dist/ai/docs/nocobase/data-sources/external/kingbase.md +129 -0
  89. package/dist/ai/docs/nocobase/data-sources/external/mariadb.md +126 -0
  90. package/dist/ai/docs/nocobase/data-sources/external/mssql.md +129 -0
  91. package/dist/ai/docs/nocobase/data-sources/external/mysql.md +115 -0
  92. package/dist/ai/docs/nocobase/data-sources/external/nocobase.md +159 -0
  93. package/dist/ai/docs/nocobase/data-sources/external/oceanbase.md +126 -0
  94. package/dist/ai/docs/nocobase/data-sources/external/oracle.md +158 -0
  95. package/dist/ai/docs/nocobase/data-sources/external/postgresql.md +122 -0
  96. package/dist/ai/docs/nocobase/data-sources/external/rest-api.md +245 -0
  97. package/dist/ai/docs/nocobase/data-sources/field-attachment-url/index.md +100 -12
  98. package/dist/ai/docs/nocobase/data-sources/field-encryption/index.md +48 -47
  99. package/dist/ai/docs/nocobase/data-sources/field-formula/index.md +99 -5
  100. package/dist/ai/docs/nocobase/data-sources/field-markdown-vditor/index.md +105 -5
  101. package/dist/ai/docs/nocobase/data-sources/field-sequence/index.md +102 -5
  102. package/dist/ai/docs/nocobase/data-sources/field-signature/index.md +18 -16
  103. package/dist/ai/docs/nocobase/data-sources/field-sort/index.md +76 -73
  104. package/dist/ai/docs/nocobase/data-sources/file-manager/field-attachment.md +101 -7
  105. package/dist/ai/docs/nocobase/data-sources/file-manager/file-collection.md +101 -14
  106. package/dist/ai/docs/nocobase/data-sources/index.md +49 -33
  107. package/dist/ai/docs/nocobase/data-sources/main/index.md +130 -0
  108. package/dist/ai/docs/nocobase/data-sources/main/kingbase.md +147 -0
  109. package/dist/ai/docs/nocobase/data-sources/main/mariadb.md +59 -0
  110. package/dist/ai/docs/nocobase/data-sources/main/mysql.md +59 -0
  111. package/dist/ai/docs/nocobase/data-sources/main/oceanbase.md +62 -0
  112. package/dist/ai/docs/nocobase/data-sources/main/postgresql.md +61 -0
  113. package/dist/ai/docs/nocobase/file-manager/storage/index.md +66 -26
  114. package/dist/ai/docs/nocobase/file-manager/storage/s3-pro.md +58 -7
  115. package/dist/ai/docs/nocobase/get-started/installation/env.md +2 -2
  116. package/dist/ai/docs/nocobase/ops-management/migration-manager/built-in-tables.md +1 -2
  117. package/dist/ai/docs/nocobase/runjs/context/ai.md +194 -4
  118. package/dist/ai/tools/executeFrontendTool.d.ts +10 -0
  119. package/dist/ai/tools/executeFrontendTool.js +86 -0
  120. package/dist/ai/tools/getSkill.js +1 -1
  121. package/dist/ai/tools/loadFrontendTool.d.ts +10 -0
  122. package/dist/ai/tools/loadFrontendTool.js +99 -0
  123. package/dist/client/244.8631eb5cf3f05e21.js +10 -0
  124. package/dist/client/{525.203778500aca5d05.js → 525.94dd4136c1361477.js} +1 -1
  125. package/dist/client/681.6ffbc9329b9ac242.js +10 -0
  126. package/dist/{client-v2/705.1d10027ff8cfdf79.js → client/705.19b642db34de438a.js} +1 -1
  127. package/dist/client/index.d.ts +1 -3
  128. package/dist/client/index.js +8 -8
  129. package/dist/client-v2/244.c428e645ecb94414.js +10 -0
  130. package/dist/client-v2/420.b2aedb1ff71fca0e.js +10 -0
  131. package/dist/client-v2/681.6890caa389564ff7.js +10 -0
  132. package/dist/client-v2/705.8dc34d43f02f322c.js +10 -0
  133. package/dist/client-v2/ai-employees/AIEmployeeShortcut.d.ts +2 -0
  134. package/dist/client-v2/ai-employees/AddContextButton.d.ts +2 -0
  135. package/dist/client-v2/ai-employees/chatbox/components/AIEmployeeSwitcher.d.ts +1 -0
  136. package/dist/client-v2/ai-employees/chatbox/components/ChatBoxUnreadBadge.d.ts +17 -0
  137. package/dist/client-v2/ai-employees/chatbox/components/Conversations.d.ts +9 -1
  138. package/dist/client-v2/ai-employees/chatbox/components/MessageRenderers.d.ts +1 -1
  139. package/dist/client-v2/ai-employees/chatbox/components/Messages.d.ts +5 -1
  140. package/dist/client-v2/ai-employees/chatbox/components/ModelSwitcher.d.ts +4 -0
  141. package/dist/client-v2/ai-employees/chatbox/components/Sender.d.ts +33 -1
  142. package/dist/client-v2/ai-employees/chatbox/components/index.d.ts +1 -0
  143. package/dist/client-v2/ai-employees/chatbox/hooks/useChat.d.ts +8 -5
  144. package/dist/client-v2/ai-employees/chatbox/hooks/useChatBoxActions.d.ts +3 -2
  145. package/dist/client-v2/ai-employees/chatbox/hooks/useChatBoxEffect.d.ts +2 -1
  146. package/dist/client-v2/ai-employees/chatbox/hooks/useChatConversationActions.d.ts +3 -2
  147. package/dist/client-v2/ai-employees/chatbox/hooks/useChatMessageActions.d.ts +4 -2
  148. package/dist/client-v2/ai-employees/chatbox/hooks/useToolCallActions.d.ts +3 -1
  149. package/dist/client-v2/ai-employees/chatbox/hooks/useUploadFiles.d.ts +13 -3
  150. package/dist/client-v2/ai-employees/chatbox/hooks/useWorkflowTasks.d.ts +3 -2
  151. package/dist/client-v2/ai-employees/chatbox/index.d.ts +17 -0
  152. package/dist/client-v2/ai-employees/chatbox/roles.d.ts +2 -153
  153. package/dist/client-v2/ai-employees/chatbox/stores/chat-box.d.ts +46 -31
  154. package/dist/client-v2/ai-employees/chatbox/stores/chat-conversations.d.ts +7 -7
  155. package/dist/client-v2/ai-employees/chatbox/stores/chat-messages.d.ts +23 -18
  156. package/dist/client-v2/ai-employees/chatbox/stores/chat-sender.d.ts +43 -0
  157. package/dist/client-v2/ai-employees/chatbox/stores/chat-tool-call.d.ts +6 -5
  158. package/dist/client-v2/ai-employees/chatbox/stores/chat-tools.d.ts +11 -5
  159. package/dist/client-v2/ai-employees/chatbox/stores/mounted-chat-boxes.d.ts +20 -0
  160. package/dist/client-v2/ai-employees/chatbox/stores/runtime.d.ts +43 -0
  161. package/dist/client-v2/ai-employees/chatbox/stores/workflow-tasks.d.ts +22 -10
  162. package/dist/client-v2/ai-employees/chatbox/upload.d.ts +19 -0
  163. package/dist/client-v2/ai-employees/chatbox/utils.d.ts +28 -4
  164. package/dist/client-v2/ai-employees/frontend-tools.d.ts +11 -0
  165. package/dist/client-v2/ai-employees/tools/SuggestionsOptionsCard.d.ts +1 -1
  166. package/dist/client-v2/ai-employees/tools/WorkflowTaskOutputCard.d.ts +1 -1
  167. package/dist/client-v2/ai-employees/types.d.ts +30 -0
  168. package/dist/client-v2/block/ai-chat-box/AIChatBoxBlockModel.d.ts +21 -0
  169. package/dist/client-v2/block/ai-chat-box/AIChatBoxCoreModel.d.ts +13 -0
  170. package/dist/client-v2/block/ai-chat-box/components/AIChatBoxCoreView.d.ts +10 -0
  171. package/dist/client-v2/block/ai-chat-box/components/AIChatBoxView.d.ts +12 -0
  172. package/dist/client-v2/block/ai-chat-box/index.d.ts +14 -0
  173. package/dist/client-v2/block/ai-chat-box/settings.d.ts +12 -0
  174. package/dist/client-v2/block/ai-chat-box/sub-models.d.ts +26 -0
  175. package/dist/client-v2/block/ai-chat-box/types.d.ts +38 -0
  176. package/dist/client-v2/block/ai-chat-box/utils.d.ts +26 -0
  177. package/dist/client-v2/index.d.ts +3 -5
  178. package/dist/client-v2/index.js +3 -3
  179. package/dist/client-v2/llm-services/model-select.d.ts +33 -0
  180. package/dist/client-v2/llm-services/utils.d.ts +1 -0
  181. package/dist/client-v2/manager/ai-manager.d.ts +10 -3
  182. package/dist/client-v2/manager/frontend-tool-registry.d.ts +30 -0
  183. package/dist/client-v2/models/ai-employees/AIEmployeeActionModel.d.ts +4 -1
  184. package/dist/client-v2/models/ai-employees/AIEmployeeShortcutModel.d.ts +5 -0
  185. package/dist/client-v2/pages/EmployeesPage.d.ts +2 -0
  186. package/dist/client-v2/runjs/registerAIEmployeeRunJSFacade.d.ts +1 -0
  187. package/dist/common/ai-employee-validation.d.ts +15 -0
  188. package/dist/common/ai-employee-validation.js +61 -0
  189. package/dist/common/error-codes.d.ts +13 -0
  190. package/dist/common/error-codes.js +48 -0
  191. package/dist/common/frontend-tools.d.ts +26 -0
  192. package/dist/common/frontend-tools.js +57 -0
  193. package/dist/common/llm-service-models.d.ts +16 -0
  194. package/dist/common/llm-service-models.js +84 -0
  195. package/dist/externalVersion.js +16 -16
  196. package/dist/locale/en-US.json +67 -0
  197. package/dist/locale/zh-CN.json +67 -0
  198. package/dist/node_modules/@langchain/mistralai/package.json +1 -1
  199. package/dist/node_modules/@langchain/xai/package.json +1 -1
  200. package/dist/node_modules/fs-extra/package.json +1 -1
  201. package/dist/node_modules/jsonrepair/package.json +1 -1
  202. package/dist/node_modules/just-bash/package.json +1 -1
  203. package/dist/node_modules/nodejs-snowflake/package.json +1 -1
  204. package/dist/node_modules/openai/package.json +1 -1
  205. package/dist/node_modules/zod/package.json +1 -1
  206. package/dist/server/ai-employees/ai-conversations.d.ts +4 -1
  207. package/dist/server/ai-employees/ai-conversations.js +2 -0
  208. package/dist/server/ai-employees/ai-employee.d.ts +2 -1
  209. package/dist/server/ai-employees/ai-employee.js +26 -7
  210. package/dist/server/ai-employees/middleware/conversation.js +9 -2
  211. package/dist/server/collections/ai-conversations.js +5 -0
  212. package/dist/server/document-loader/constants.js +1 -1
  213. package/dist/server/frontend-tools.d.ts +25 -0
  214. package/dist/server/frontend-tools.js +171 -0
  215. package/dist/server/manager/work-context-handler.js +10 -3
  216. package/dist/server/plugin.d.ts +1 -0
  217. package/dist/server/plugin.js +25 -0
  218. package/dist/server/resource/aiConversations.d.ts +2 -0
  219. package/dist/server/resource/aiConversations.js +33 -3
  220. package/dist/server/resource/aiEmployees.d.ts +2 -0
  221. package/dist/server/resource/aiEmployees.js +62 -0
  222. package/dist/server/resource/aiWorkflowTasks.js +9 -1
  223. package/dist/server/resource/llmServices.d.ts +11 -0
  224. package/dist/server/resource/llmServices.js +85 -0
  225. package/dist/server/types/knowledge-base.type.d.ts +6 -2
  226. package/dist/swagger/common.d.ts +143 -0
  227. package/dist/swagger/common.js +144 -0
  228. package/dist/swagger/employees.d.ts +301 -0
  229. package/dist/swagger/employees.js +131 -0
  230. package/dist/swagger/index.d.ts +1588 -0
  231. package/dist/swagger/index.js +62 -0
  232. package/dist/swagger/llm.d.ts +555 -0
  233. package/dist/swagger/llm.js +247 -0
  234. package/dist/swagger/schemas.d.ts +736 -0
  235. package/dist/swagger/schemas.js +381 -0
  236. package/package.json +2 -2
  237. package/dist/ai/docs/nocobase/ai-employees/knowledge-base/vector-store.md +0 -24
  238. package/dist/ai/docs/nocobase/data-sources/development/index.md +0 -6
  239. package/dist/client/372.40eb52905e3f3049.js +0 -10
  240. package/dist/client/681.399948c18d753667.js +0 -10
  241. package/dist/client/705.380279da896021fb.js +0 -10
  242. package/dist/client-v2/372.8cc3fde09c9bec77.js +0 -10
  243. package/dist/client-v2/406.341be51205c674e0.js +0 -10
  244. package/dist/client-v2/681.082f4f1c7b841983.js +0 -10
  245. package/dist/client-v2/ai-employees/chatbox/stores/create-selectors.d.ts +0 -46
  246. package/dist/client-v2/ai-employees/chatbox/utils/normalizeTriggerTaskOptions.d.ts +0 -19
@@ -1,13 +1,113 @@
1
+ ---
2
+ title: "Email"
3
+ description: "The Email field stores email addresses and provides email-format validation."
4
+ keywords: "Email,email,field,Field interface,NocoBase"
5
+ ---
6
+
1
7
  # Email
2
8
 
3
9
  ## Introduction
4
10
 
5
- ## Field configuration
11
+ In NocoBase, the **Email** field stores email addresses.
12
+
13
+ It is suitable for customer, employee, and supplier email addresses. Compared with a normal Input field, it provides clearer email semantics and format validation. Use [Input](./input.md) when the content is not an email address.
14
+
15
+ ## Use cases
16
+
17
+ Email fields are suitable for these business scenarios:
18
+
19
+ - Customer and contact email addresses
20
+ - Employee and sign-in contact email addresses
21
+ - Supplier and service email addresses
22
+ - Notification recipient addresses
23
+
24
+ ## Create and configure
25
+
26
+ On the collection's **Configure fields** page, click **Add field** and select **Email** to create this field.
27
+
28
+ ![Configure a Email field](https://static-docs.nocobase.com/20240512175609.png)
29
+
30
+ | Setting | Description |
31
+ | --- | --- |
32
+ | Field interface | The field interface. Email uses `email`, which determines how the field is entered and displayed in pages. |
33
+ | Field display name | The name displayed for the field, such as `Customer email`, `Contact email`, or `Recipient email`. Use a name that business users can recognize. |
34
+ | Field name | The field identifier used internally by APIs, relation fields, permissions, and workflows. It usually cannot be changed after creation. It supports only letters, numbers, and underscores, and must begin with a letter. |
35
+ | Field type | The data-layer type. Email uses `string` by default. |
36
+ | Default value | The default value. When a new record has no value, NocoBase can fill this value automatically. |
37
+ | Validation rules | Validation rules. Supports email-format and required validation. |
38
+ | Description | A field description. Record the field meaning, entry requirements, data source, or maintainer. |
39
+
40
+ :::warning Note
41
+
42
+ Field names are referenced by page blocks, permissions, workflows, and APIs after creation. Confirm the name before creating the field to avoid later configuration changes.
43
+
44
+ :::
45
+
46
+ ## Field behavior
47
+
48
+ The default behavior of a Email field is as follows:
49
+
50
+ | Behavior | Description |
51
+ | --- | --- |
52
+ | Default Field interface | `email`. |
53
+ | Default Field type | `string`. |
54
+ | Available Field types | `string`. |
55
+ | Page component | Uses an Input component with email-format validation in edit mode. |
56
+ | Filtering | Supports text filters such as contains, equals, is empty, and is not empty. |
57
+ | Sorting | Supports sorting in Table blocks. |
58
+ | Validation | Supports email-format and required validation. |
59
+
60
+ ## Edit configuration
61
+
62
+ After creation, click **Edit** beside the field to edit its configuration. Edit fields to adjust how they are displayed and used in NocoBase, such as the display name, description, default value, validation rules, or field-specific settings.
63
+
64
+ When a field comes from a synchronized main-database table, editing usually maps the database field to a NocoBase Field type and Field interface.
65
+
66
+ | Setting | Can be edited | Description |
67
+ | --- | --- | --- |
68
+ | Field display name | Yes | Changes the name displayed in the interface without changing the field identifier. |
69
+ | Field name | No | The field identifier normally cannot be changed in the edit form after creation. |
70
+ | Field interface | Conditional | Main-database fields and synchronized fields can be adjusted during field mapping. Changes affect page input, display, and validation. |
71
+ | Field type | Conditional | Main-database fields and synchronized fields can be adjusted during field mapping. Confirm that existing values can be used by the new type first. |
72
+ | Default value | Yes | Adjusts the default value for new records. |
73
+ | Validation rules | Yes | Adjusts field validation rules. |
74
+ | Description | Yes | Adds the field meaning, entry requirements, data source, or maintainer. |
75
+
76
+ :::warning Note
77
+
78
+ Changing a Field type or Field interface is more than changing a display name. It affects field storage, input components, validation rules, filters, and workflow-variable usage. When the field contains substantial existing data, confirm that its data format is compatible first.
79
+
80
+ :::
81
+
82
+ ## Delete field
83
+
84
+ Click **Delete** beside a Email field to delete it. You can also select multiple fields and delete them in the main data source.
85
+
86
+ Deleting a Email field created in the main database usually also deletes the actual database column and its values. For a synchronized or external-data-source field, the impact depends on the corresponding data source and field origin.
87
+
88
+ :::danger Warning
89
+
90
+ Deleting a field can affect page blocks, forms, filters, permissions, workflows, APIs, imports and exports, and existing data. Confirm that the field is no longer referenced by business configuration before deleting it.
91
+
92
+ :::
93
+
94
+ ## Use in pages
95
+
96
+ Email fields are suitable for forms, details, and notification flows.
6
97
 
98
+ ![Use a Email field in a page](https://static-docs.nocobase.com/20260709224700.png)
7
99
 
8
- ![20240512175609](https://static-docs.nocobase.com/20240512175609.png)
9
100
 
101
+ | Scenario | Use |
102
+ | --- | --- |
103
+ | Form block | Enter an email address. |
104
+ | Details block | Display an email address. |
105
+ | Filter block | Filter records by email address. |
106
+ | Workflows and notifications | Use the value as an email-notification recipient. |
10
107
 
11
- ## Example
108
+ ## Related links
12
109
 
13
- To be added.
110
+ - [Fields](../index.md) - Learn about field categories and mapping.
111
+ - [General collection](../../../data-source-main/general-collection.md) - Create and manage fields in a collection.
112
+ - [Input](./input.md) - Store ordinary short text.
113
+ - [Phone](./phone.md) - Store phone numbers.
@@ -1,13 +1,111 @@
1
+ ---
2
+ title: "Icon"
3
+ description: "The Icon field stores icon identifiers for menus, categories, statuses, and other interface elements."
4
+ keywords: "Icon,icon,field,Field interface,NocoBase"
5
+ ---
6
+
1
7
  # Icon
2
8
 
3
9
  ## Introduction
4
10
 
5
- ## Field configuration
11
+ In NocoBase, the **Icon** field stores icon identifiers.
12
+
13
+ It is suitable for menu icons, category icons, status icons, and other visual labels. Use a normal Input field when you need to store an arbitrary text value instead of an icon.
14
+
15
+ ## Use cases
16
+
17
+ Icon fields are suitable for these business scenarios:
18
+
19
+ - Menu and navigation icons
20
+ - Category and classification icons
21
+ - Status and label icons
22
+ - Visual identification for business records
23
+
24
+ ## Create and configure
25
+
26
+ On the collection's **Configure fields** page, click **Add field** and select **Icon** to create this field.
27
+
28
+ ![Configure a Icon field](https://static-docs.nocobase.com/20240512180027.png)
29
+
30
+ | Setting | Description |
31
+ | --- | --- |
32
+ | Field interface | The field interface. Icon uses `icon`, which determines how the field is entered and displayed in pages. |
33
+ | Field display name | The name displayed for the field, such as `Menu icon`, `Category icon`, or `Status icon`. Use a name that business users can recognize. |
34
+ | Field name | The field identifier used internally by APIs, relation fields, permissions, and workflows. It usually cannot be changed after creation. It supports only letters, numbers, and underscores, and must begin with a letter. |
35
+ | Field type | The data-layer type. Icon uses `string` by default. |
36
+ | Default value | The default value. When a new record has no value, NocoBase can fill this value automatically. |
37
+ | Validation rules | Validation rules. Supports required validation. |
38
+ | Description | A field description. Record the field meaning, entry requirements, data source, or maintainer. |
39
+
40
+ :::warning Note
41
+
42
+ Field names are referenced by page blocks, permissions, workflows, and APIs after creation. Confirm the name before creating the field to avoid later configuration changes.
43
+
44
+ :::
45
+
46
+ ## Field behavior
47
+
48
+ The default behavior of a Icon field is as follows:
49
+
50
+ | Behavior | Description |
51
+ | --- | --- |
52
+ | Default Field interface | `icon`. |
53
+ | Default Field type | `string`. |
54
+ | Available Field types | `string`. |
55
+ | Page component | Uses an icon selector in edit mode. |
56
+ | Filtering | Supports text-value filters such as equals, is empty, and is not empty. |
57
+ | Sorting | Supports sorting in Table blocks. |
58
+ | Validation | Supports required validation. |
59
+
60
+ ## Edit configuration
61
+
62
+ After creation, click **Edit** beside the field to edit its configuration. Edit fields to adjust how they are displayed and used in NocoBase, such as the display name, description, default value, validation rules, or field-specific settings.
63
+
64
+ When a field comes from a synchronized main-database table, editing usually maps the database field to a NocoBase Field type and Field interface.
65
+
66
+ | Setting | Can be edited | Description |
67
+ | --- | --- | --- |
68
+ | Field display name | Yes | Changes the name displayed in the interface without changing the field identifier. |
69
+ | Field name | No | The field identifier normally cannot be changed in the edit form after creation. |
70
+ | Field interface | Conditional | Main-database fields and synchronized fields can be adjusted during field mapping. Changes affect page input, display, and validation. |
71
+ | Field type | Conditional | Main-database fields and synchronized fields can be adjusted during field mapping. Confirm that existing values can be used by the new type first. |
72
+ | Default value | Yes | Adjusts the default value for new records. |
73
+ | Validation rules | Yes | Adjusts field validation rules. |
74
+ | Description | Yes | Adds the field meaning, entry requirements, data source, or maintainer. |
75
+
76
+ :::warning Note
77
+
78
+ Changing a Field type or Field interface is more than changing a display name. It affects field storage, input components, validation rules, filters, and workflow-variable usage. When the field contains substantial existing data, confirm that its data format is compatible first.
79
+
80
+ :::
81
+
82
+ ## Delete field
83
+
84
+ Click **Delete** beside a Icon field to delete it. You can also select multiple fields and delete them in the main data source.
85
+
86
+ Deleting a Icon field created in the main database usually also deletes the actual database column and its values. For a synchronized or external-data-source field, the impact depends on the corresponding data source and field origin.
87
+
88
+ :::danger Warning
89
+
90
+ Deleting a field can affect page blocks, forms, filters, permissions, workflows, APIs, imports and exports, and existing data. Confirm that the field is no longer referenced by business configuration before deleting it.
91
+
92
+ :::
93
+
94
+ ## Use in pages
95
+
96
+ Icon fields are suitable for visual configuration and record identification.
6
97
 
98
+ ![Use a Icon field in a page](https://static-docs.nocobase.com/20260709225630.png)
7
99
 
8
- ![20240512180027](https://static-docs.nocobase.com/20240512180027.png)
9
100
 
101
+ | Scenario | Use |
102
+ | --- | --- |
103
+ | Form block | Select an icon. |
104
+ | Details block | Display the selected icon. |
105
+ | Table block | Display icon values in a list. |
106
+ | Interface configuration | Use the icon as a visual identifier. |
10
107
 
11
- ## Example
108
+ ## Related links
12
109
 
13
- To be added.
110
+ - [Fields](../index.md) - Learn about field categories and mapping.
111
+ - [General collection](../../../data-source-main/general-collection.md) - Create and manage fields in a collection.
@@ -1,22 +1,126 @@
1
- # Single Line Text
1
+ ---
2
+ title: "Single line text"
3
+ description: "The Single line text field stores short text such as names, codes, titles, and contacts. It uses the string type and Input interface by default."
4
+ keywords: "Single line text,input,text field,string,Field interface,NocoBase"
5
+ ---
6
+
7
+ # Single line text
2
8
 
3
9
  ## Introduction
4
10
 
5
- ## Field Configuration
11
+ In NocoBase, **Single line text** is the most common text field. It is suitable for short text that fits on one line, such as customer names, order numbers, contacts, address summaries, and external-system identifiers.
12
+
13
+ Single line text uses the `Input` interface and the `string` Field type by default. It can be used as a title field and can participate in filters, sorting, permission rules, workflow conditions, and API queries.
14
+
15
+ When content might contain line breaks or be long, use [Textarea](./textarea.md) by default. When content has a fixed format, such as an email address, phone number, or URL, use the corresponding specialized field first.
16
+
17
+ ## Use cases
18
+
19
+ Single line text is suitable for these business scenarios:
20
+
21
+ - Customer names, company names, and contact names
22
+ - Order numbers, contract numbers, and project numbers
23
+ - Task titles, work-order titles, and article titles
24
+ - External-system IDs, synchronization numbers, and business codes
25
+ - Short text such as cities, address summaries, and store names
26
+
27
+ ## Create and configure
28
+
29
+ On the collection's **Configure fields** page, click **Add field** and select **Single line text** to create the field.
30
+
31
+ ![Create a Single line text field](https://static-docs.nocobase.com/20240512163555.png)
32
+
33
+ | Setting | Description |
34
+ | --- | --- |
35
+ | Field interface | The field interface. Single line text uses `input` and an Input component for entry and display. |
36
+ | Field display name | The name displayed for the field, such as `Customer name`, `Order number`, or `Task title`. Use a name that business users can recognize. |
37
+ | Field name | The field identifier used internally by APIs, relation fields, permissions, and workflows. It usually cannot be changed after creation. It supports only letters, numbers, and underscores, and must begin with a letter. |
38
+ | Field type | The data-layer type. Single line text uses `string` by default and can also use `uid`. Use `string` for ordinary short text. |
39
+ | Automatically remove heading and tailing spaces | Removes leading and trailing spaces automatically. Suitable for names, codes, and titles where leading or trailing spaces should not be retained. |
40
+ | Default value | The default value. When a new record has no value, NocoBase can fill the default text automatically. |
41
+ | Primary | Makes the field a primary key. Available only when creating a field in the main database; ordinary business text is not recommended as a primary key. |
42
+ | Unique | A unique constraint. Suitable for text values that cannot repeat, such as order numbers, contract numbers, and external-system IDs. |
43
+ | Validation rules | Validation rules. You can limit minimum length, maximum length, fixed length, or a regular expression. |
44
+ | Description | A field description. Record the field meaning, entry requirements, data source, or maintainer. |
45
+
46
+ :::warning Note
47
+
48
+ Field names are referenced by page blocks, permissions, workflows, and APIs after creation. Confirm the name before creating the field to avoid later configuration changes.
49
+
50
+ :::
51
+
52
+ ## Field behavior
53
+
54
+ The default behavior of a Single line text field is as follows:
55
+
56
+ | Behavior | Description |
57
+ | --- | --- |
58
+ | Default Field interface | `input`. |
59
+ | Default Field type | `string`. |
60
+ | Available Field types | `string`, `uid`. |
61
+ | Page component | Uses an `Input` component in edit mode. |
62
+ | Title field | Can be used as a collection title field. It is suitable to set fields such as `Customer name`, `Order number`, or `Task title` as the title field. |
63
+ | Sorting | Supports sorting in Table blocks. |
64
+ | Filtering | Supports text filters such as contains, does not contain, equals, does not equal, is empty, and is not empty. |
65
+ | Validation | Supports minimum length, maximum length, fixed length, regular-expression, and other validation. |
66
+
67
+ ## Edit configuration
68
+
69
+ After creation, click **Edit** beside the field to edit its configuration. Edit fields to adjust how they display and are used in NocoBase, such as the display name, description, default value, validation rules, or automatic removal of leading and trailing spaces.
70
+
71
+ When a field comes from a synchronized main-database table, editing usually maps the database field to a NocoBase Field type and Field interface. For example, short-text database columns such as `varchar` and `char` can be mapped to a Single line text field.
72
+
73
+ | Setting | Can be edited | Description |
74
+ | --- | --- | --- |
75
+ | Field display name | Yes | Changes the name displayed in the interface without changing the field identifier. |
76
+ | Field name | No | The field identifier normally cannot be changed in the edit form after creation. |
77
+ | Field interface | Conditional | Main-database fields and synchronized fields can be adjusted during field mapping. Changes affect page input, display, and validation. |
78
+ | Field type | Conditional | Main-database fields and synchronized fields can be adjusted during field mapping. Confirm that existing values can be used by the new type first. |
79
+ | Automatically remove heading and tailing spaces | Yes | Controls whether leading and trailing spaces are removed when saving. |
80
+ | Default value | Yes | Adjusts the default text for new records. |
81
+ | Unique | Conditional | Available when creating a field in the main database. Adding it can fail if existing data already contains duplicate values. |
82
+ | Validation rules | Yes | Adjusts length, format, or regular-expression validation. |
83
+ | Description | Yes | Adds the field meaning, entry requirements, data source, or maintainer. |
84
+
85
+ :::warning Note
86
+
87
+ Changing a Field type or Field interface is more than changing a display name. It affects field storage, input components, validation rules, filters, and workflow-variable usage. When the field contains substantial existing data, confirm that its data format is compatible first.
88
+
89
+ :::
90
+
91
+ ## Delete field
92
+
93
+ Click **Delete** beside a Single line text field to delete it. You can also select multiple fields and delete them in the main data source.
94
+
95
+ Deleting a Single line text field created in the main database usually also deletes the actual database column and its values. For a synchronized or external-data-source field, the impact depends on the corresponding data source and field origin.
96
+
97
+ :::danger Warning
6
98
 
99
+ Deleting a field can affect page blocks, forms, filters, permissions, workflows, APIs, imports and exports, and existing data. Confirm that the field is no longer referenced by business configuration before deleting it.
7
100
 
8
- ![20240512163555](https://static-docs.nocobase.com/20240512163555.png)
101
+ :::
9
102
 
103
+ ## Use in pages
10
104
 
11
- ## Interface Configuration
105
+ Single line text fields can be used in most data blocks and form scenarios.
12
106
 
13
- ### Edit Mode
107
+ | Scenario | Use |
108
+ | --- | --- |
109
+ | Form block | Enter or edit short text such as a customer name, order number, or task title. |
110
+ | Table block | Display, sort, and filter short text. Long values are truncated in tables according to interface configuration. |
111
+ | Details block | Display text information for one record. |
112
+ | Filter block | Use the field as a query condition, such as filtering by customer name, code, or title. |
113
+ | Relation field display | When a Single line text field is a title field, relation fields preferentially display this text when selecting a record. |
114
+ | Workflows and permissions | Use it in conditions, such as whether an order number is empty or a customer name contains a keyword. |
14
115
 
116
+ ### Edit mode
15
117
 
16
- ![20240512164001](https://static-docs.nocobase.com/20240512164001.png)
118
+ In edit mode, Single line text uses an Input component.
17
119
 
120
+ ![Single line text edit mode](https://static-docs.nocobase.com/20240512164001.png)
18
121
 
19
- ### Read-only Mode
122
+ ### Read mode
20
123
 
124
+ In read mode, Single line text is displayed as ordinary text.
21
125
 
22
- ![20240512164138](https://static-docs.nocobase.com/20240512164138.png)
126
+ ![Single line text read mode](https://static-docs.nocobase.com/20240512164138.png)
@@ -1,13 +1,112 @@
1
+ ---
2
+ title: "Integer"
3
+ description: "The Integer field stores whole-number values such as quantities, headcounts, and days."
4
+ keywords: "Integer,integer,field,Field interface,NocoBase"
5
+ ---
6
+
1
7
  # Integer
2
8
 
3
9
  ## Introduction
4
10
 
5
- ## Field configuration
11
+ In NocoBase, the **Integer** field stores whole-number values.
12
+
13
+ It is suitable for quantities, headcounts, delay days, and other values without decimal places. Use Number when the business value needs decimals.
14
+
15
+ ## Use cases
16
+
17
+ Integer fields are suitable for these business scenarios:
18
+
19
+ - Inventory quantity and order quantity
20
+ - Headcount and number of participants
21
+ - Delay days and service duration
22
+ - Sequence numbers and counting values
23
+
24
+ ## Create and configure
25
+
26
+ On the collection's **Configure fields** page, click **Add field** and select **Integer** to create this field.
27
+
28
+ ![Configure a Integer field](https://static-docs.nocobase.com/20240512175723.png)
29
+
30
+ | Setting | Description |
31
+ | --- | --- |
32
+ | Field interface | The field interface. Integer uses `integer`, which determines how the field is entered and displayed in pages. |
33
+ | Field display name | The name displayed for the field, such as `Quantity`, `Headcount`, or `Delay days`. Use a name that business users can recognize. |
34
+ | Field name | The field identifier used internally by APIs, relation fields, permissions, and workflows. It usually cannot be changed after creation. It supports only letters, numbers, and underscores, and must begin with a letter. |
35
+ | Field type | The data-layer type. Integer uses `integer` by default. |
36
+ | Default value | The default value. When a new record has no value, NocoBase can fill this value automatically. |
37
+ | Validation rules | Validation rules. Supports minimum, maximum, and required validation. |
38
+ | Description | A field description. Record the field meaning, entry requirements, data source, or maintainer. |
39
+
40
+ :::warning Note
41
+
42
+ Field names are referenced by page blocks, permissions, workflows, and APIs after creation. Confirm the name before creating the field to avoid later configuration changes.
43
+
44
+ :::
45
+
46
+ ## Field behavior
47
+
48
+ The default behavior of a Integer field is as follows:
49
+
50
+ | Behavior | Description |
51
+ | --- | --- |
52
+ | Default Field interface | `integer`. |
53
+ | Default Field type | `integer`. |
54
+ | Available Field types | `integer`, `bigInt`. |
55
+ | Page component | Uses a number input in edit mode. |
56
+ | Filtering | Supports numerical filters such as greater than, less than, equals, and is empty. |
57
+ | Sorting | Supports sorting in Table blocks. |
58
+ | Validation | Supports minimum, maximum, and required validation. |
59
+
60
+ ## Edit configuration
61
+
62
+ After creation, click **Edit** beside the field to edit its configuration. Edit fields to adjust how they are displayed and used in NocoBase, such as the display name, description, default value, validation rules, or field-specific settings.
63
+
64
+ When a field comes from a synchronized main-database table, editing usually maps the database field to a NocoBase Field type and Field interface.
65
+
66
+ | Setting | Can be edited | Description |
67
+ | --- | --- | --- |
68
+ | Field display name | Yes | Changes the name displayed in the interface without changing the field identifier. |
69
+ | Field name | No | The field identifier normally cannot be changed in the edit form after creation. |
70
+ | Field interface | Conditional | Main-database fields and synchronized fields can be adjusted during field mapping. Changes affect page input, display, and validation. |
71
+ | Field type | Conditional | Main-database fields and synchronized fields can be adjusted during field mapping. Confirm that existing values can be used by the new type first. |
72
+ | Default value | Yes | Adjusts the default value for new records. |
73
+ | Validation rules | Yes | Adjusts field validation rules. |
74
+ | Description | Yes | Adds the field meaning, entry requirements, data source, or maintainer. |
75
+
76
+ :::warning Note
77
+
78
+ Changing a Field type or Field interface is more than changing a display name. It affects field storage, input components, validation rules, filters, and workflow-variable usage. When the field contains substantial existing data, confirm that its data format is compatible first.
79
+
80
+ :::
81
+
82
+ ## Delete field
83
+
84
+ Click **Delete** beside a Integer field to delete it. You can also select multiple fields and delete them in the main data source.
85
+
86
+ Deleting a Integer field created in the main database usually also deletes the actual database column and its values. For a synchronized or external-data-source field, the impact depends on the corresponding data source and field origin.
87
+
88
+ :::danger Warning
89
+
90
+ Deleting a field can affect page blocks, forms, filters, permissions, workflows, APIs, imports and exports, and existing data. Confirm that the field is no longer referenced by business configuration before deleting it.
91
+
92
+ :::
93
+
94
+ ## Use in pages
95
+
96
+ Integer fields are suitable for numerical entry, statistics, filters, and conditions.
6
97
 
98
+ ![Use a Integer field in a page](https://static-docs.nocobase.com/20260709224913.png)
7
99
 
8
- ![20240512175723](https://static-docs.nocobase.com/20240512175723.png)
9
100
 
101
+ | Scenario | Use |
102
+ | --- | --- |
103
+ | Form block | Enter a whole-number value. |
104
+ | Table block | Display, sort, and filter numerical values. |
105
+ | Details block | Display a whole-number value. |
106
+ | Workflows and permissions | Use the value in numerical conditions. |
10
107
 
11
- ## Example
108
+ ## Related links
12
109
 
13
- to be added.
110
+ - [Fields](../index.md) - Learn about field categories and mapping.
111
+ - [General collection](../../../data-source-main/general-collection.md) - Create and manage fields in a collection.
112
+ - [Number](./number.md) - Store decimal numerical values.
@@ -1,13 +1,112 @@
1
+ ---
2
+ title: "Number"
3
+ description: "The Number field stores decimal values such as amounts, scores, and weights."
4
+ keywords: "Number,number,field,Field interface,NocoBase"
5
+ ---
6
+
1
7
  # Number
2
8
 
3
9
  ## Introduction
4
10
 
5
- ## Field configuration
11
+ In NocoBase, the **Number** field stores numerical values that can include decimals.
12
+
13
+ It is suitable for order amounts, scores, weights, and other decimal values. For monetary values that require exact decimal precision, use `decimal`.
14
+
15
+ ## Use cases
16
+
17
+ Number fields are suitable for these business scenarios:
18
+
19
+ - Order amounts and budgets
20
+ - Scores and ratings
21
+ - Weight, length, and other measurements
22
+ - Statistical indicators and calculated values
23
+
24
+ ## Create and configure
25
+
26
+ On the collection's **Configure fields** page, click **Add field** and select **Number** to create this field.
27
+
28
+ ![Configure a Number field](https://static-docs.nocobase.com/20240512175752.png)
29
+
30
+ | Setting | Description |
31
+ | --- | --- |
32
+ | Field interface | The field interface. Number uses `number`, which determines how the field is entered and displayed in pages. |
33
+ | Field display name | The name displayed for the field, such as `Order amount`, `Score`, or `Weight`. Use a name that business users can recognize. |
34
+ | Field name | The field identifier used internally by APIs, relation fields, permissions, and workflows. It usually cannot be changed after creation. It supports only letters, numbers, and underscores, and must begin with a letter. |
35
+ | Field type | The data-layer type. Number uses `double` by default. |
36
+ | Default value | The default value. When a new record has no value, NocoBase can fill this value automatically. |
37
+ | Validation rules | Validation rules. Supports minimum, maximum, precision, and required validation. |
38
+ | Description | A field description. Record the field meaning, entry requirements, data source, or maintainer. |
39
+
40
+ :::warning Note
41
+
42
+ Field names are referenced by page blocks, permissions, workflows, and APIs after creation. Confirm the name before creating the field to avoid later configuration changes.
43
+
44
+ :::
45
+
46
+ ## Field behavior
47
+
48
+ The default behavior of a Number field is as follows:
49
+
50
+ | Behavior | Description |
51
+ | --- | --- |
52
+ | Default Field interface | `number`. |
53
+ | Default Field type | `double`. |
54
+ | Available Field types | `double`, `float`, `decimal`. |
55
+ | Page component | Uses a number input in edit mode. |
56
+ | Filtering | Supports numerical filters such as greater than, less than, equals, and is empty. |
57
+ | Sorting | Supports sorting in Table blocks. |
58
+ | Validation | Supports minimum, maximum, precision, and required validation. |
59
+
60
+ ## Edit configuration
61
+
62
+ After creation, click **Edit** beside the field to edit its configuration. Edit fields to adjust how they are displayed and used in NocoBase, such as the display name, description, default value, validation rules, or field-specific settings.
63
+
64
+ When a field comes from a synchronized main-database table, editing usually maps the database field to a NocoBase Field type and Field interface.
65
+
66
+ | Setting | Can be edited | Description |
67
+ | --- | --- | --- |
68
+ | Field display name | Yes | Changes the name displayed in the interface without changing the field identifier. |
69
+ | Field name | No | The field identifier normally cannot be changed in the edit form after creation. |
70
+ | Field interface | Conditional | Main-database fields and synchronized fields can be adjusted during field mapping. Changes affect page input, display, and validation. |
71
+ | Field type | Conditional | Main-database fields and synchronized fields can be adjusted during field mapping. Confirm that existing values can be used by the new type first. |
72
+ | Default value | Yes | Adjusts the default value for new records. |
73
+ | Validation rules | Yes | Adjusts field validation rules. |
74
+ | Description | Yes | Adds the field meaning, entry requirements, data source, or maintainer. |
75
+
76
+ :::warning Note
77
+
78
+ Changing a Field type or Field interface is more than changing a display name. It affects field storage, input components, validation rules, filters, and workflow-variable usage. When the field contains substantial existing data, confirm that its data format is compatible first.
79
+
80
+ :::
81
+
82
+ ## Delete field
83
+
84
+ Click **Delete** beside a Number field to delete it. You can also select multiple fields and delete them in the main data source.
85
+
86
+ Deleting a Number field created in the main database usually also deletes the actual database column and its values. For a synchronized or external-data-source field, the impact depends on the corresponding data source and field origin.
87
+
88
+ :::danger Warning
89
+
90
+ Deleting a field can affect page blocks, forms, filters, permissions, workflows, APIs, imports and exports, and existing data. Confirm that the field is no longer referenced by business configuration before deleting it.
91
+
92
+ :::
93
+
94
+ ## Use in pages
95
+
96
+ Number fields are suitable for numerical entry, calculation, statistics, and conditions.
6
97
 
98
+ ![Use a Number field in a page](https://static-docs.nocobase.com/20260709225103.png)
7
99
 
8
- ![20240512175752](https://static-docs.nocobase.com/20240512175752.png)
9
100
 
101
+ | Scenario | Use |
102
+ | --- | --- |
103
+ | Form block | Enter a numerical value. |
104
+ | Table block | Display, sort, and filter numerical values. |
105
+ | Details block | Display a numerical value. |
106
+ | Workflows and permissions | Use the value in numerical conditions and calculations. |
10
107
 
11
- ## Example
108
+ ## Related links
12
109
 
13
- To be added.
110
+ - [Fields](../index.md) - Learn about field categories and mapping.
111
+ - [General collection](../../../data-source-main/general-collection.md) - Create and manage fields in a collection.
112
+ - [Percent](./percent.md) - Store percentage values.