tiny-vue
tiny-vue copied to clipboard
feat: generate renderless props table by jsdoc
PR
PR Checklist
Please check if your PR fulfills the following requirements:
- [x] The commit message follows our Commit Message Guidelines
- [ ] Tests for the changes have been added (for bug fixes / features)
- [x] Docs have been added / updated (for bug fixes / features)
PR Type
What kind of change does this PR introduce?
- [ ] Bugfix
- [x] Feature
- [ ] Code style update (formatting, local variables)
- [ ] Refactoring (no functional changes, no api changes)
- [ ] Build related changes
- [ ] CI related changes
- [ ] Documentation content changes
- [ ] Other... Please describe:
What is the current behavior?
Issue Number: https://github.com/opentiny/tiny-vue/discussions/645#%E5%B7%A5%E7%A8%8B%E4%BC%98%E5%8C%96
What is the new behavior?
// button.type.ts
export interface IButtonApi {
/**
* @zh 状态
* @en status of button
*/
state: IButtonState
/**
* @zh 该项不会被渲染, 因为在renderless.ts的api变量中没有暴露
* @en This item will not be rendered because it is not exposed in the API variable of renderless. ts
*/
clearTimer: ReturnType<typeof clearTimer>
/**
* @zh 点击时触发的函数
* @en Function triggered on click
*/
handleClick: ReturnType<typeof handleClick>
}
Does this PR introduce a breaking change?
- [ ] Yes
- [x] No
Other information
[e2e-test-warn] The component to be tested is missing.
The title of the Pull request should look like "fix(vue-renderless): [action-menu, alert] fix xxx bug".
Please make sure you've read our contributing guide