docs: add documentations for plugin detail modal component (#385)

添加 2.17.0 添加的 PluginDetailModal 组件的文档。

/kind documentation

```release-note
None
```
wan92hen-patch-1
Ryan Wang 5 months ago committed by GitHub
parent b2bab07578
commit 1714c0f496
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

@ -0,0 +1,30 @@
---
title: PluginDetailModal
description: 插件详情弹窗组件
---
此组件可以在 UI 部分的任意组件中打开差价的详情和设置弹窗,可以用于实现在不打断正常操作流程的情况下让用户查看和修改插件的详细信息。
## 使用方式
```html
<script lang="ts" setup>
import { ref } from "vue"
const modalVisible = ref(false)
function onPluginDetailModalClose() {
// Do something
}
</script>
<template>
<PluginDetailModal v-if="modalVisible" @close="onPluginDetailModalClose" name="starter" />
</template>
```
## Props
| 属性名 | 类型 | 默认值 | 描述 |
| ------ | ------ | -------- | --------------------------------------------- |
| `name` | string | 无,必填 | 插件名称,即 plugin.yaml 中的 `metadata.name` |

@ -178,7 +178,7 @@ module.exports = {
"developer-guide/plugin/api-reference/server/reconciler",
"developer-guide/plugin/api-reference/server/role-template",
"developer-guide/plugin/api-reference/server/extension-client",
"developer-guide/plugin/api-reference/server/setting-fetcher",
"developer-guide/plugin/api-reference/server/setting-fetcher",
"developer-guide/plugin/api-reference/server/reverseproxy",
"developer-guide/plugin/api-reference/server/finder-for-theme",
"developer-guide/plugin/api-reference/server/template-for-theme",
@ -259,6 +259,7 @@ module.exports = {
"developer-guide/plugin/api-reference/ui/components/attachment-selector-modal",
"developer-guide/plugin/api-reference/ui/components/has-permission",
"developer-guide/plugin/api-reference/ui/components/search-input",
"developer-guide/plugin/api-reference/ui/components/plugin-detail-modal",
"developer-guide/plugin/api-reference/ui/components/v-codemirror",
"developer-guide/plugin/api-reference/ui/components/v-tooltip",
"developer-guide/plugin/api-reference/ui/components/v-permission",

@ -0,0 +1,30 @@
---
title: PluginDetailModal
description: 插件详情弹窗组件
---
此组件可以在 UI 部分的任意组件中打开差价的详情和设置弹窗,可以用于实现在不打断正常操作流程的情况下让用户查看和修改插件的详细信息。
## 使用方式
```html
<script lang="ts" setup>
import { ref } from "vue"
const modalVisible = ref(false)
function onPluginDetailModalClose() {
// Do something
}
</script>
<template>
<PluginDetailModal v-if="modalVisible" @close="onPluginDetailModalClose" name="starter" />
</template>
```
## Props
| 属性名 | 类型 | 默认值 | 描述 |
| ------ | ------ | -------- | --------------------------------------------- |
| `name` | string | 无,必填 | 插件名称,即 plugin.yaml 中的 `metadata.name` |

@ -244,6 +244,7 @@
"developer-guide/plugin/api-reference/ui/components/attachment-selector-modal",
"developer-guide/plugin/api-reference/ui/components/has-permission",
"developer-guide/plugin/api-reference/ui/components/search-input",
"developer-guide/plugin/api-reference/ui/components/plugin-detail-modal",
"developer-guide/plugin/api-reference/ui/components/v-codemirror",
"developer-guide/plugin/api-reference/ui/components/v-tooltip",
"developer-guide/plugin/api-reference/ui/components/v-permission"

Loading…
Cancel
Save