Skip to content

Commit 411f14e

Browse files
committed
docs: ✏️ api doc
1 parent 1f37840 commit 411f14e

File tree

7 files changed

+135
-193
lines changed

7 files changed

+135
-193
lines changed

.vitepress/i18n/en.json

+1
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@
3030
"api.expose": "Expose",
3131
"api.props": "Props",
3232
"api.slots": "Slots",
33+
"api.values": "Values",
3334
"api.viewSource": "View source",
3435
"z": "Z"
3536
}

.vitepress/i18n/zh.json

+1
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@
3030
"api.expose": "暴露属性",
3131
"api.props": "属性",
3232
"api.slots": "插槽",
33+
"api.values": "",
3334
"api.viewSource": "查看源码",
3435
"z": "Z"
3536
}

.vitepress/theme/components/ComponentDoc.vue

+14-8
Original file line numberDiff line numberDiff line change
@@ -52,19 +52,25 @@ onMounted(async () => {
5252
</div>
5353
<PluginTabs>
5454
<PluginTabsTab :label="t('props')" v-if="meta?.props">
55-
<div v-for="(prop, index) in meta.props" :key="index" class="item">
55+
<div v-for="(item, index) in meta.props" :key="index" class="item">
5656
<div class="item-main">
5757
<div>
58-
<code>{{ prop.name }}</code>:
59-
<span class="text-tips">{{ prop.type?.name || '—' }}</span>
58+
<code>{{ item.name }}</code>:
59+
<span class="text-tips">{{ item.type?.name || '—' }}</span>
6060
</div>
6161
<div class="default-value">
62-
<code>{{ prop.defaultValue?.value || '—' }}</code>
62+
<code>{{ item.defaultValue?.value || '—' }}</code>
6363
</div>
6464
</div>
65-
<div class="description text-tips" v-if="prop.description">
65+
<div class="description text-tips" v-if="item.description">
6666
<div class="text-tip">{{ t('description') }}</div>
67-
<div class="text-info">{{ prop.description }}</div>
67+
<div class="text-info" v-html="item.description" />
68+
</div>
69+
<div class="description text-tips" v-if="item.values">
70+
<div class="text-tip">{{ t('values') }}</div>
71+
<div class="text-info">
72+
{{ item.values.join(', ') || '—' }}
73+
</div>
6874
</div>
6975
</div>
7076
</PluginTabsTab>
@@ -78,7 +84,7 @@ onMounted(async () => {
7884
</div>
7985
<div class="description text-tips" v-if="item.description">
8086
<div class="text-tip">{{ t('description') }}</div>
81-
<div class="text-info">{{ item.description }}</div>
87+
<div class="text-info" v-html="item.description" />
8288
</div>
8389
</div>
8490
</PluginTabsTab>
@@ -91,7 +97,7 @@ onMounted(async () => {
9197
</div>
9298
<div class="description text-tips" v-if="item.description">
9399
<div class="text-tip">{{ t('description') }}</div>
94-
<div class="text-info">{{ item.description }}</div>
100+
<div class="text-info" v-html="item.description" />
95101
</div>
96102
</div>
97103
</PluginTabsTab>

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
"url": "https://github.com/yiitap/docs/issues"
1919
},
2020
"dependencies": {
21-
"@yiitap/vue": "^1.2.3",
21+
"@yiitap/vue": "^1.2.4",
2222
"vue": "^3.5.13"
2323
},
2424
"devDependencies": {

pnpm-lock.yaml

+54-54
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)