前端组件库

@alice-lib/react-library

目的:开发一套前端通用，文档清晰的组件库，提升开发效率,避免重复造轮子。

开始

安装依赖

$ yarn install

跑服务

$ yarn start

打包文档

$ yarn docs:build

打包组件库

Build library via father-build,

$ yarn build

发布组件库

1. 小版本号升级

bug 修复,向下兼容

$ npm version patch

package.json 中的版本号2.0.0变为 2.0.1

2. 中版本号升级

添加功能或组件/废弃功能

$ npm version minor

package.json 中的版本号2.0.1变为 2.1.0

3. 大版本号升级

破坏性修改/架构升级

$ npm version major

package.json 中的版本号3.1.0变为 4.0.0

组件开发说明

每个组件开发中预留扩展项，更新版本说明，尽量低耦合。

导出组件实例后在 index.md 文件中做 api 渲染，引入组件 interface 说明即可。

• tsx 文件

interface NavBarType {
  /**
   * @description     标题
   * @default         null
   */
  children?: ReactNode;
  /**
   * @description    navBar样式
   * @default        {}
   */
  style?: CSSProperties & Partial<Record<string, string>>;
}

• md 文件

<API src="./API.tsx"></API>

创建组件方式参考之前组件写法 以 React.FC 的方式可正常渲染。

组件开发完成后，新建 demo.tsx 文件，将示例示例化，在 src/util.ts 下引入。

组件路由及分组问题

• nav下的title和path相同则为顶部菜单同组
• group下的title和path相同则为左侧菜单同组

---
title: NavBar(导航栏)
group:
  title: 布局
---