nocobase/docs/plugins/concepts/fields.md
chenos d5d0e1036b
docs: add docs (#75)
* docs: add docs

* ignore dumi theme test

* fix: error TS2717: Subsequent property declarations must have the same type.

* update docs

* deploy gh-pages

* plugins docs

* hash & cname

* exportStatic

* ssr

* vercel

* vercel

* fix: deploy vercel

* Delete vercel.json

* docs

* fix APP_DIST

* on master branch
2021-04-17 21:33:21 +08:00

117 lines
1.9 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

---
title: Fields - 字段
---
# Fields
一个完整的字段由「数据类型」和「区块类型」两部分参数组合而成。同一个数据类型可能对应多种区块类型同一个区块类型的数据值也可能是多种数据类型。因此提炼了字段的接口Interface作为唯一标识。
字段的 Types 和 Blocks 就不赘述了,请查阅核心章节介绍
- [Field Types](/cores/packages/database#field-types)
- [Field Blocks](/cores/packages/blocks#fields---字段)
<Alert title="注意" type="warning">
在 NocoBase 里,普通用户概念上的字段类型指的是 interfacefield type 只表示数据类型 - data typefield block 是 ui 组件同一个组件也可能表示多种字段类型interface
</Alert>
## Interfaces - 接口类型
```ts
{
// 多行文本框
interface: 'textarea',
// 长文本类型
type: 'text', // 也可以是 string
// 使用 多行文本框 区块渲染 UI
block: {
type: 'textarea',
},
}
{
// 电子邮箱
interface: 'email',
// 字符串
type: 'string',
format: 'email',
// 使用 String 区块渲染
block: {
type: 'string',
},
}
{
// 手机号
interface: 'phone',
// 字符串
type: 'string',
format: 'phone',
// 使用 String 区块渲染
block: {
type: 'string',
},
}
```
分类有:
- basic
- media
- choices
- datetime
- relation
- systemInfo
- developerMode
- others
### basic
#### string
#### textarea
#### phone
#### email
#### number
#### percent
### media
#### markdown
#### wysiwyg
#### attachment
### choices
#### select
#### multipleSelect
#### radio
#### checkboxes
#### boolean
#### chinaRegion
### datetime
#### datetime
#### time
### relation
#### subTable
#### linkTo
### systemInfo
#### createdAt
#### createdBy
#### updatedAt
#### updatedBy
### developerMode
#### primaryKey
#### sort
#### password
#### icon
#### json
### Others
以下字段可能会被遗弃
#### description
#### group
#### status