@hzab/component-boilerplate

组件模板

• [email protected]

组件

示例

import Demo from "@hzab/component-boilerplate";

<Demo />;

API

InfoPanel Attributes

| 参数 | 类型 | 必填 | 默认值 | 说明 | | ------------------ | -------- | ---- | ------ | ----------------- | | schema | Object | 是 | - | 数据信息的 schema | | breadcrumbProps | Object | 否 | {} | 面包屑配置项 | | defaultBreadcrumbs | Array | 否 | {} | 默认的面包屑数据 | | hasUser | boolean | 否 | false | 是否是用户列表 | | userConf | Object | 否 | {} | 用户数据配置项 | | orgConf | Object | 否 | {} | 部门数据配置项 | | searchFilterConf | Object | 否 | {} | 搜索数据配置项 | | hasFilter | boolean | 否 | - | 是否有筛选项 | | onItemClick | Function | 否 | - | 列表子项点击事件 | | breadCrumbBackFn | Function | 否 | - | 面包屑返回回调 | | Slots | Object | 否 | - | 插槽 | | hasSearch | boolean | 否 | - | 是否展示搜索框 | | style | Object | 否 | - | 组件样式 | | breadcrumbDataConf | Object | 否 | - | 面包屑配置 | | hasSearchFilter | boolean | 否 | - | 搜索框是否展示 | | tabItems | any | 否 | - | tab 数据 | | searchTop | boolean | 否 | false | 搜索框是否置顶 | | showTab | boolean | 否 | false | 是否展示 tab | | tabConf | Object | 否 | false | tab 配置 | | hasMore | boolean | 否 | false | 是否加载更多 | | historyTab | string | 否 | - | 地址栏 tab | | bottomTabFlag | string | 否 | - | 最后一层 tab 标识 |

组件开发流程

• 在 config/webpack.config.js 中按需修改 library 配置的文件名
• 在 config/webpack.config.js 中按需修改 alias 配置的包名，便于本地调试
• 在 tsconfig.json 中按需修改 paths 配置的包名，解决 ts 报错问题
• npm run dev

文件目录

• example 本地开发测试代码
• src 组件源码
• lib 组件打包编译后的代码

命令

• Mac 执行该命令，设置 pre-commit 为可执行文件

  • npm run mac-chmod
  • chmod +x .husky && chmod +x .husky/pre-commit

• 生成文档：npm run docs

• 本地运行：npm run dev

• 打包编译：npm run build

发布

• 注意：示例代码生效，但发布之后未生效。确认是否执行了编译！！！

• 编译组件：npm run build

• 命令：npm publish --access public

• 发布目录：

  • lib
  • src

配置

配置文件

• 本地配置文件：config/config.js

webpack 配置文件

• config/webpack.config.js