tiny-vue
tiny-vue copied to clipboard
✨ [Feature]: Hope to add the TypeScript type declaration of components
What problem does this feature solve
Adding type declaration to components can improve the developer experience(DX).
建议优先完善高频组件的 TypeScript 类型声明。
What does the proposed API look like
Take the alert component as an example.
packages/renderless/src/alert/vue.ts
// Add type declaration to state
const state: IAlertState = reactive({
show: true,
getIcon: computed(() => api.computedGetIcon()),
getTitle: computed(() => api.computedGetTitle()),
contentVisible: false,
contentDescribeHeight: 0,
contentDefaultHeight: 0,
contentMaxHeight: constants.CONTENT_MAXHEUGHT,
scrollStatus: false
})
export interface IAlertState {
show: boolean
getIcon: ComputedRef<string>
getTitle: ComputedRef<string>
contentVisible: boolean
contentDescribeHeight: number
contentDefaultHeight: number
contentMaxHeight: number
scrollStatus: boolean
}
For more information on how to supplement the type declaration of a component, please refer to discussion #252
The TypeScript type declaration of the component needs to be continuously improved.