从零到一搭建React组件库

最近一直在捣鼓如何搭建实用的组件库，至于为什么会产生这个想法，主要是因为组件库对于前端生态来说究极重要，每一个着眼于长远发展的互联网公司基本上都会量身定制组件库，它的好处不用多说，读者们在使用中或多或少都会体会到一些优点，如果以前做过MVC，那么对于这一点的体会肯定更加深刻。一款组件库如此之重要，作为一名前端工程师应该去深入的了解，为以后任务开发、职业发展赋能。

大致来说，开发一款组件库通常会有以下几点好处：

统一产品设计体验
提高团队协作效率
降低开发成本

功能需求

在做任何一件事情之前都应该捋清楚我们的初衷，也就是我们的需求是什么，凡事预则立，不预则废。

这里撇开业务上的需求，因为这篇文章没有基于业务场景去考虑。只梳理一些功能上需求，也就是如何搭建一个高性能、高实用、高标准的React组件库。

需求清单：

满足ES Module、CommonJS、AMD、CMD模块引入方式
支持按需加载

技术选型~~~~

环境搭建

搭建组件库首先我们来搭建工程环境，这里我们不采用create-react-app脚手架来搭建，因为脚手架封装好了很多东西，而有些东西对于组件库并不适用，用来搭建组件库过于臃肿。因此，我准备从零到一搭建React组件库。

首先，先创建一个工程文件夹，执行npm init命令生成package.json；执行tsc --init生成tsconfig.json

然后，按如下结构组织工程的目录结构：

pony-react-ui
    - src
        - assets  // 存放静态文件，比如图片、文字等
        - components // 组件
        - styles // 组件样式
        - index.ts // 主文件入口
        - style.ts // 样式文件入口
    - package.json // 依赖管理
    - tsconfig.json // ts配置
    - webpack.config.js // webpack配置

如何组织组件

在components文件夹下以如下方式组织组件，比如创建一个Button组件

- components
    - Button
        - Button.tsx // 按钮组件
        - index.tsx // 组件入口
    - Dialog
        - Dialog.tsx
        - index.tsx

Button.tsx

import React from 'react';
import classNames from 'classnames';

export interface IButtonProps {
  onClick?: React.MouseEventHandler;
  // 类型
  primary?: boolean;
  secondary?: boolean;
  outline?: boolean;
  dashed?: boolean;
  link?: boolean;
  text?: boolean;
  // 尺寸
  xLarge?: boolean;
  large?: boolean;
  small?: boolean;
  xSmall?: boolean;
  xxSmall?: boolean;
  // 颜色
  success?: boolean;
  warn?: boolean;
  danger?: boolean;
  // 禁用状态
  disabled?: boolean;
  className?: string;
  style?: React.CSSProperties;
  children?: React.ReactNode;
}

export const Button = (props: IButtonProps) => {
  const {
    className: tempClassName,
    style,
    onClick,
    children,
    primary,
    secondary,
    outline,
    dashed,
    link,
    text,
    xLarge,
    large,
    small,
    xSmall,
    xxSmall,
    success,
    danger,
    warn,
    disabled,
  } = props;
  
  
  const className = classNames(
    {
      'pony-button': true,
      'pony-button-primary': primary,
      'pony-button-secondary': secondary && !text,
      'pony-button-outline': outline,
      'pony-button-dashed': dashed,
      'pony-button-link': link,
      'pony-button-text': text && !secondary,
      'pony-button-text-secondary': secondary && text,
      'pony-button-round': round,
      'pony-button-rectangle': noRadius,
      'pony-button-fat': fat,
      'pony-button-xl': xLarge,
      'pony-button-lg': large,
      'pony-button-sm': small,
      'pony-button-xs': xSmall,
      'pony-button-xxs': xxSmall,
      'pony-button-long': long,
      'pony-button-short': short,
      'pony-button-success': success,
      'pony-button-warn': warn,
      'pony-button-danger': danger,
      'pony-button-disabled': disabled,
    },
    tempClassName
  );
  
  return (
    
  );
}

在index.tsx抛出组件以及该组件的类型声明

export * from './Button';

如何组织样式

- styles
    -

我把组件的样式都存放在/src/styles文件夹中，除了存放各个组件样式之外，另外创建_minxin.scss