arthur/ui
1
0
Fork 0
mirror of https://github.com/ArthurDanjou/ui.git synced 2026-01-22 16:00:39 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs(ComponentProps): display schema default in description

Browse Source
This commit is contained in:
Benjamin Canac
2024-09-04 10:20:01 +02:00
parent eb2667fa81
commit b3de942696
1 changed files with 14 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
docs/app/components/content/ComponentPropsSchema.vue
View File

@@ -18,7 +18,20 @@ function getSchemaProps(schema: PropertyMeta['schema']) {
return (Array.isArray(schema.schema) ? schema.schema : Object.values(schema.schema)).flatMap(getSchemaProps)
}
const schemaProps = computed(() => getSchemaProps(props.prop.schema))
const schemaProps = computed(() => {
return getSchemaProps(props.prop.schema).map((prop) => {
const defaultValue = prop.default ?? prop.tags?.find(tag => tag.name === 'defaultValue')?.text
let description = prop.description
if (defaultValue) {
description = description ? `${description} Defaults to \`${defaultValue}\`{lang="ts-type"}.` : `Defaults to \`${defaultValue}\`{lang="ts-type"}.`
}
return {
...prop,
description
}
})
})
</script>
<template>