外观
字段容器
约 449 字大约 2 分钟
2025-12-23
在markdown中, 使用::: field容器, 用于描述字段信息, 包括字段名称/字段类型/是否必填/默认值/详情等信息.
它适用于描述配置中的字段/组件的Props等场景.
还可以使用额外的:::: field-group容器, 用于组合多个 ::: field.
语法
单个字段
::: field name="字段名" type="类型" required default="默认值"
字段描述信息
:::字段名Required类型
默认值
字段描述信息
字段组合
:::: field-group
::: field name="字段名" type="类型" required default="默认值"
字段描述信息
:::
::: field name="字段名" type="类型" optional default="默认值"
字段描述信息
:::
::::字段名Required类型
默认值
字段描述信息
字段名Optional类型
默认值
字段描述信息
属性
nameRequiredstring
字段名称
typeOptionalstring
字段的类型
typeOptionalstring
字段的类型
requiredOptionalboolean
是否必填
optionalOptionalboolean
是否可选
defaultOptionalstring
默认值, 如果为空字符串, 应该使用default="''"
示例
:::: field-group
::: field name="theme" type="ThemeConfig" required default="{ base: '/' }"
主题配置
:::
::: field name="enabled" type="boolean" optional default="true"
是否启用
:::
::: field name="callback" type="(...args: any[]) => void" optional default="() => {}"
<Badge type="tip" text="v1.0.0 新增" />
回调函数
:::
::: field name="other" type="string" deprecated
<Badge type="danger" text="v0.9.0 弃用" />
已弃用属性
:::
::::themeRequiredThemeConfig
{ base: '/' }
主题配置
enabledOptionalboolean
true
是否启用
callbackOptional(...args: any[]) => void
() => {}
v1.0.0 新增
回调函数
otherDeprecatedstring
v0.9.0 弃用
已弃用属性
版权所有
版权归属：洱海