ComponentCode

用 ::component-code 以属性矩阵驱动任意已注册的 Vue 组件实时渲染,读者在预览上方切换属性值,下方的 Vue 代码片段同步更新,可直接复制使用。

ComponentCode 不需要单独的示例文件:在 frontmatter 中给出组件名与初始 props,即可得到可交互的预览和对应的 Vue 代码。

需要开启 movkNuxtDocs.componentDocs,前置条件与 ComponentProps 相同。

用法

name 为 PascalCase 的组件名,可以是 Nuxt UI 组件或项目中自动导入的组件。props 中的每个键都会生成一个控件,items 为对应的键提供可选值:

New
<template>
  <UBadge label="New" color="primary" variant="solid" />
</template>
::component-code
---
name: UBadge
props:
  label: New
  color: primary
  variant: solid
items:
  color: [primary, secondary, success, warning, error, neutral]
  variant: [solid, outline, soft, subtle]
---
::

布尔类型的 prop 自动提供 true / false 两个选项,数字类型显示数字输入框,其余显示文本框。代码片段会省略与组件默认值相同的布尔与字符串属性。

控制生成的代码

字段作用
ignore不生成控件,但仍写入代码,适合固定不变的属性
hide既不生成控件,也不写入代码,适合只影响预览的属性
external在 <script setup> 中声明为 ref,模板中以变量绑定
model以 v-model:{key} 绑定;modelValue 始终以 v-model 绑定
slots插槽内容,键为插槽名,值为模板字符串
::component-code
---
name: UInput
props:
  modelValue: ''
  placeholder: 搜索文档
  class: w-64
external: [modelValue]
hide: [class]
slots:
  trailing: <UKbd value="/" />
---
::

上例生成的代码中,modelValue 声明为 const value = ref("") 并以 v-model="value" 绑定,class 只作用于预览。

ComponentCode 与 ComponentExample 共用 ComponentExampleExtras 扩展组件。

API

Props

Prop Default Type
namestring
props Record<string, any>
items Record<string, any[]>
model string[]
hide string[]
ignore string[]
slots Record<string, any>
prettierfalseboolean

是否使用 Prettier 格式化代码

collapsefalseboolean | { icon?: string ; name?: string | undefined; openText?: string | undefined; closeText?: string | undefined; open?: boolean | undefined; } | undefined

是否折叠代码块

highlights number[]
overflowHiddenboolean
elevatedboolean

Changelog

No recent changes
Copyright © 2024 - 2026