yccw-common v0.5.85

@yccw/common

有成财务公共组件库

安装依赖

$ cnpm i @yccw/common --save --registry=http://npmjs.kuaidizs.cn/

组件目录结构

前往 Foo 模板文件夹

• index.tsx

  组件实现, 配合参数类型的规范注释可在index.md中配置API标签进行展示描述信息;

• index.md

  该说明文档在组件库展示配置, 该文件会根据文件内的路由配置

  自动挂载路由; 可使用 markdown 语法进行展示说明, 也可根据API标签进行参数描述的自动导出;

  

  • API 标签属性

    • src: 自定义渲染文件路径, 默认 './index.tsx'
    • exports: 显式指明渲染哪些导出，请确保值为合法的 JSON 字符串, 例: exports='"default", "Other"'
    • hideTitle: 如果不需要标题 ，可以使用 hideTitle

• indexDumiDoc.tsx

  该文件可选; 只用于导出类型描述加以展示, 不负责功能实现; 需配合.md 里的 API 标签的 src 属性使用; (由于 dumi 描述文档的自动导出类型描述的功能只支持 React 组价的参数类型描述; 所以新增该文件用来直接导出类型; 切记不要将导出类型描述的声明写在方法内, 这样会错误引导使用者, 并且在导出时注释说明 @deprecated 只适用于dumi文档模板渲染)