TypeScript Support
Type declarations are supported starting from version 2.5.2.
VEUI provides TS declarations for component APIs, which require Volar for the best development experience.
Configure Volar extension
Please refer to the Volar documentation on Setup for Vue2.
For Vue versions < 2.7, @vue/runtime-dom needs to be installed:
npm i -D @vue/runtime-dom
Local configuration
Add the following configuration to tsconfig.json to support Vue 2's template syntax.
// tsconfig.json
{
"compilerOptions": {
// ...
},
"vueCompilerOptions": {
"target": 2.7,
// "target": 2, // for Vue versions < 2.7
}
}
If types are not working properly, try restarting Volar: Press ⌘ + ⇧ + P and select “Volar: Restart Vue server”.
Usage example
<template>
<veui-button>OK</veui-button>
</template>
<script lang="ts">
import { defineComponent } from 'vue' // < 2.7 versions require `@vue/composition-api`
import { Button } from 'veui'
export default defineComponent({
components: {
'veui-button': Button
}
})
</script>
If you have not manually imported and registered components, but instead use an automatic registration solution like unplugin-vue-components, please import the file veui/types/global.d.ts or include it in the tsconfig.json file:
{
"include": [
"src/**/*",
"node_modules/veui/types/global.d.ts"
]
}