Skip to content

✨ [Feature]: Hope to add the TypeScript type declaration of components #370

@kagol

Description

@kagol

What problem does this feature solve

Adding type declaration to components can improve the developer experience(DX).

建议优先完善高频组件的 TypeScript 类型声明。

TinyVue 高频组件

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
}
image

Metadata

Metadata

Assignees

No one assigned

    Labels

    refactoringRefactoring (重构)

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions