Karin API Docs / WebConfigPage

接口: WebConfigPage

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

插件自定义 Web 配置页面。

当插件不想使用 Karin 内置表单渲染配置项时，可以声明一个自定义页面。 Karin WebUI 会在插件配置页中加载该地址。插件可以使用同源路由提供页面， 也可以指向一个外部公共配置管理平台。

属性

description?

optional description: string

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

页面描述，会作为配置页的辅助说明文本。

---

title?

optional title: string

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

页面标题，会展示在 Karin 插件配置页的页面容器中。

---

url

url: string

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

页面地址。

支持两种形式：

• 同源绝对路径，例如 /my-plugin/。插件需要在 Karin 后端自行注册对应静态路由。
• http:// 或 https:// 外部地址，例如 https://config.example.com/plugin?id=my-plugin。

外部公共配置管理平台可以通过 query 或 hash 携带插件标识。