diff --git a/console/docs/components/README.md b/console/docs/components/README.md new file mode 100644 index 000000000..14f3c29c2 --- /dev/null +++ b/console/docs/components/README.md @@ -0,0 +1,54 @@ +# Console 组件介绍 + +目前 Console 的组件包含基础组件(`@halo-dev/components`)和 Console 端的业务组件,这两种组件都可以在插件中使用。 + +## 业务组件 + +### AnnotationsForm + +此组件用于为自定义模型设置 annotations 数据,同时支持自定义 key / value 和自定义表单,表单定义方式可以参考: + +使用方式: + +```vue + + + +``` + +其中,kind 和 group 为必填项,分别表示模型的 kind 和 group。 diff --git a/console/src/setup/setupComponents.ts b/console/src/setup/setupComponents.ts index 28853bf93..95e349838 100644 --- a/console/src/setup/setupComponents.ts +++ b/console/src/setup/setupComponents.ts @@ -9,6 +9,7 @@ import FormKitConfig from "@/formkit/formkit.config"; import FilterDropdown from "@/components/filter/FilterDropdown.vue"; import FilterCleanButton from "@/components/filter/FilterCleanButton.vue"; import SearchInput from "@/components/input/SearchInput.vue"; +import AnnotationsForm from "@/components/form/AnnotationsForm.vue"; export function setupComponents(app: App) { app.use(VueGridLayout); @@ -33,4 +34,5 @@ export function setupComponents(app: App) { app.component("FilterDropdown", FilterDropdown); app.component("FilterCleanButton", FilterCleanButton); app.component("SearchInput", SearchInput); + app.component("AnnotationsForm", AnnotationsForm); }