字段容器 新
约 405 字大约 1 分钟
2025-04-29
概述
在 markdown 中,使用 ::: field
容器,用于描述字段信息,包括字段名称、字段类型、是否必填、默认值、详情等信息。
它适用于 描述配置中的字段、组件的 Props 等场景。
还可以使用额外的 :::: field-group
容器,用于组合多个 ::: field
。
启用
该功能默认不启用,您需要在 theme
配置中启用它。
.vuepress/config.ts
export default defineUserConfig({
theme: plumeTheme({
markdown: {
field: true,
},
})
})
语法
<!-- 单个字段 -->
::: field name="字段名" type="类型" required default="默认值"
字段描述信息
:::
<!-- 字段组合 -->
:::: field-group
::: field name="字段名" type="类型" required default="默认值"
字段描述信息
:::
::: field name="字段名" type="类型" required default="默认值"
字段描述信息
:::
::::
属性
nameRequiredstring
字段名称
typeOptionalstring
字段的类型
requiredOptionalboolean
是否必填
optionalOptionalboolean
是否可选
defaultOptionalstring
默认值, 如果为空字符串,应该使用 default="''"
示例
输入:
::: field name="theme" type="ThemeConfig" required default="{}"
主题配置
:::
::: field name="enabled" type="boolean" optional default="true"
是否启用
:::
输出:
themeRequiredThemeConfig
{}
主题配置
enabledOptionalboolean
true
是否启用
输入:
:::: 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="() => {}"
回调函数
:::
::::
输出:
themeRequiredThemeConfig
{ base: '/' }
主题配置
enabledOptionalboolean
true
是否启用
callbackOptional(...args: any[]) => void
() => {}
回调函数