-
Notifications
You must be signed in to change notification settings - Fork 4.9k
Description
Preface
Our Typescript docs are split into two pages for Composition API and Options API, which is fine as there are different things to be aware about when using these APIs with TS.
However at the same time, we should document similarities in both sections equally.
We explain the use of PropType
only in the Options API TS guide.
We explain how to use it here in the second code snippet: https://vuejs.org/guide/typescript/options-api.html#typing-component-props
However we don't mention it on the Composition API Version of that page anywhere. If one were to read this page alone, as they are not using Options API, they would not be aware they need to do this to use an external type:
<script setup>
import type { Categories } from './types'
import { PropType } from 'vue'
defineProps({
category: {
type: String as PropType<Categories>
}
})
</script>
Proposed solution
Right after the first simple code snippet explaining runtime props declaration, we should insert and explanation of PropType
before we go on to dive into defineProps<{ }>()