feat(docs): [components] additions (#10374)

* Add primitive-type api component. * Add [number, string, boolean] type component.
element-plus · Nov 3, 2022 · a329ed6 · a329ed6
1 parent e7843c0
commit a329ed6
Show file tree

Hide file tree

Showing 6 changed files with 45 additions and 0 deletions.
diff --git a/docs/.vitepress/vitepress/components/globals/vp-api-bool.vue b/docs/.vitepress/vitepress/components/globals/vp-api-bool.vue
@@ -0,0 +1,7 @@
+<script setup lang="ts">
+import Primitive from './vp-api-primitive.vue'
+</script>
+
+<template>
+  <Primitive type="boolean" />
+</template>
diff --git a/docs/.vitepress/vitepress/components/globals/vp-api-number.vue b/docs/.vitepress/vitepress/components/globals/vp-api-number.vue
@@ -0,0 +1,7 @@
+<script setup lang="ts">
+import Primitive from './vp-api-primitive.vue'
+</script>
+
+<template>
+  <Primitive type="number" />
+</template>
diff --git a/docs/.vitepress/vitepress/components/globals/vp-api-primitive.vue b/docs/.vitepress/vitepress/components/globals/vp-api-primitive.vue
@@ -0,0 +1,14 @@
+<script setup lang="ts">
+defineProps({
+  type: {
+    type: String,
+    required: true,
+  },
+})
+</script>
+
+<template>
+  <code>
+    {{ type }}
+  </code>
+</template>
diff --git a/docs/.vitepress/vitepress/components/globals/vp-api-string.vue b/docs/.vitepress/vitepress/components/globals/vp-api-string.vue
@@ -0,0 +1,7 @@
+<script setup lang="ts">
+import Primitive from './vp-api-primitive.vue'
+</script>
+
+<template>
+  <Primitive type="string" />
+</template>
diff --git a/docs/.vitepress/vitepress/index.ts b/docs/.vitepress/vitepress/index.ts
@@ -17,6 +17,9 @@ 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 ApiBooleanType from './components/globals/vp-api-bool.vue'
+import ApiStringType from './components/globals/vp-api-string.vue'
+import ApiNumberType from './components/globals/vp-api-number.vue'
 import ApiEnumType from './components/globals/vp-api-enum.vue'
 import ApiExternalType from './components/globals/vp-api-external.vue'
 import IconList from './components/globals/icons.vue'
@@ -32,5 +35,8 @@ export const globals: [string, Component][] = [
   ['ApiTyping', ApiTyping],
   ['FunctionType', ApiFunctionType],
   ['EnumType', ApiEnumType],
+  ['BooleanType', ApiBooleanType],
+  ['StringType', ApiStringType],
+  ['NumberType', ApiNumberType],
   ['ExternalType', ApiExternalType],
 ]
diff --git a/docs/components.d.ts b/docs/components.d.ts
@@ -59,9 +59,13 @@ 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']
+    VpApiBool: typeof import('./.vitepress/vitepress/components/globals/vp-api-bool.vue')['default']
     VpApiEnum: typeof import('./.vitepress/vitepress/components/globals/vp-api-enum.vue')['default']
     VpApiExternal: typeof import('./.vitepress/vitepress/components/globals/vp-api-external.vue')['default']
     VpApiFunction: typeof import('./.vitepress/vitepress/components/globals/vp-api-function.vue')['default']
+    VpApiNumber: typeof import('./.vitepress/vitepress/components/globals/vp-api-number.vue')['default']
+    VpApiPrimitive: typeof import('./.vitepress/vitepress/components/globals/vp-api-primitive.vue')['default']
+    VpApiString: typeof import('./.vitepress/vitepress/components/globals/vp-api-string.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']