Karin API Docs / DefinePageConfig

接口: DefinePageConfig

定义于: packages/core/src/types/server/local.ts:159

使用插件自定义页面渲染的 WebUI 配置。

声明 page 后，Karin WebUI 会加载该页面，而不是渲染 components 表单。 自定义页面需要自行处理配置读取与保存，不再接入 Karin 的通用组件保存接口。

继承

• DefineConfigBase

属性

components?

optional components: undefined

定义于: packages/core/src/types/server/local.ts:163

自定义页面模式不使用 Karin 内置组件配置。

---

customComponent()?

optional customComponent: () => 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?

optional author: Author | Author[]

插件作者

description?

optional description: string

插件描述 可不填 会自动读取package.json中的version

icon?

optional icon: Icon

插件图标 前端优先展示

id

id: string

插件id 也就是插件的包名

name?

optional name: string

插件名称 前端优先展示

version?

optional version: string

插件版本 可不填 会自动读取package.json中的version

继承自

DefineConfigBase.info

---

page

page: WebConfigPage | WebConfigPageFactory

定义于: packages/core/src/types/server/local.ts:161

插件自定义配置页面，或返回页面配置的工厂函数。

---

save?

optional save: undefined

定义于: packages/core/src/types/server/local.ts:165

自定义页面模式不使用 Karin 通用保存接口。