Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(docs): api typing shortcuts #10353

Merged
merged 1 commit into from Nov 1, 2022
Merged

feat(docs): api typing shortcuts #10353

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
17 changes: 17 additions & 0 deletions docs/.vitepress/vitepress/components/globals/vp-api-enum.vue
View file
Open in desktop
@@ -0,0 +1,17 @@
<script setup lang="ts">
import { computed } from 'vue'
import ApiTyping from './vp-api-typing.vue'

const props = defineProps({
values: {
type: Array,
required: true,
},
})

const details = computed(() => props.values.join(' | '))
</script>

<template>
<api-typing type="enum" :details="details" />
</template>
21 changes: 21 additions & 0 deletions docs/.vitepress/vitepress/components/globals/vp-api-function.vue
View file
Open in desktop
@@ -0,0 +1,21 @@
<script setup lang="ts">
import { computed } from 'vue'
import ApiTyping from './vp-api-typing.vue'

const props = defineProps({
params: {
type: String,
default: '',
},
returns: {
type: String,
default: 'void',
},
})

const details = computed(() => `(${props.params}) => ${props.returns}`)
</script>

<template>
<api-typing type="Function" :details="details" />
</template>
4 changes: 2 additions & 2 deletions docs/.vitepress/vitepress/components/globals/vp-api-typing.vue
View file
Open in desktop
Expand Up @@ -9,9 +9,9 @@ defineProps({

<template>
<span class="flex items-center">
<span class="api-typing">
<code class="api-typing">
{{ type }}
</span>
</code>
<el-tooltip effect="light" trigger="click">
<el-button text :icon="Warning" class="p-2 text-5" />
<template #content>
Expand Down
4 changes: 4 additions & 0 deletions docs/.vitepress/vitepress/index.ts
View file
Open in desktop
Expand Up @@ -16,6 +16,8 @@ import 'uno.css'
import VPApp from './components/vp-app.vue'
import VPDemo from './components/vp-demo.vue'
import ApiTyping from './components/globals/vp-api-typing.vue'
import ApiFunctionType from './components/globals/vp-api-function.vue'
import ApiEnumType from './components/globals/vp-api-enum.vue'
import IconList from './components/globals/icons.vue'

import type { Component } from 'vue'
Expand All @@ -27,4 +29,6 @@ export const globals: [string, Component][] = [
['Demo', VPDemo],
['IconList', IconList],
['ApiTyping', ApiTyping],
['FunctionType', ApiFunctionType],
['EnumType', ApiEnumType],
]
2 changes: 2 additions & 0 deletions docs/components.d.ts
View file
Open in desktop
Expand Up @@ -59,6 +59,8 @@ declare module '@vue/runtime-core' {
ToggleSidebarBtn: typeof import('./.vitepress/vitepress/components/subnav/toggle-sidebar-btn.vue')['default']
TopNavigationExample: typeof import('./.vitepress/vitepress/components/nav/top-navigation-example.vue')['default']
VersionTag: typeof import('./.vitepress/vitepress/components/dev/VersionTag.vue')['default']
VpApiEnum: typeof import('./.vitepress/vitepress/components/globals/vp-api-enum.vue')['default']
VpApiFunction: typeof import('./.vitepress/vitepress/components/globals/vp-api-function.vue')['default']
VpApiTyping: typeof import('./.vitepress/vitepress/components/globals/vp-api-typing.vue')['default']
VpApp: typeof import('./.vitepress/vitepress/components/vp-app.vue')['default']
VpChangelog: typeof import('./.vitepress/vitepress/components/globals/vp-changelog.vue')['default']
Expand Down