DefineComponentConfig
约 323 字大约 1 分钟
2026-06-11
Karin API Docs / DefineComponentConfig
接口: DefineComponentConfig\<T\>
定义于: packages/core/src/types/server/local.ts:137
使用 Karin 内置组件渲染的 WebUI 配置。
继承
类型参数
T
T = any
属性
components()?
optionalcomponents: () =>ComponentConfig[] |Promise<ComponentConfig[]>
定义于: packages/core/src/types/server/local.ts:143
内置组件配置。
返回值会交给 Karin WebUI 渲染为配置表单。
返回
ComponentConfig[] | Promise<ComponentConfig[]>
customComponent()?
optionalcustomComponent: () =>unknown
定义于: packages/core/src/types/server/local.ts:133
自定义组件配置
返回
unknown
Description
未完成
继承自
DefineConfigBase.customComponent
info
info:
object
定义于: packages/core/src/types/server/local.ts:115
插件信息
author?
插件作者
description?
optionaldescription:string
插件描述 可不填 会自动读取package.json中的version
icon?
optionalicon:Icon
插件图标 前端优先展示
id
id:
string
插件id 也就是插件的包名
name?
optionalname:string
插件名称 前端优先展示
version?
optionalversion:string
插件版本 可不填 会自动读取package.json中的version
继承自
save()?
optionalsave: (config) =>SaveConfigResponse|Promise<SaveConfigResponse>
定义于: packages/core/src/types/server/local.ts:150
保存配置。
参数
config
T
Karin WebUI 提交的配置数据。类型由 defineConfig<T> 的泛型决定。
返回
SaveConfigResponse | Promise<SaveConfigResponse>
保存结果。success 控制前端保存反馈,message 会展示给用户。
