小白之封装第一个组件到组件库的过程(react)

。故事前景:之前没有封装过公共组件到某个组件库的经验,此次是从零开始,我尽量写的详细一些,开始还抱着一些担忧,后来发现这个就像我们平时写业务一样,不是很难,难的是封装的组件做到让别人挑剔不起来。

好了,话不多说,咱们开始今天的话题。

开始之前有些什么:有一个老大搭建好的组件库项目,是用的storybook去搭建的,下面我把老大搭建的框架用到的开发依赖跟生产依赖截图出来


然后项目的目录


然后这些是开始就有的

然后有同事已经在她的分支上封装好了一个组件,input组件,我参考了一下她的封装,并且我封装的Button组件有大致给出业务场景,还有设计文档,我截图出来



就这样,带着实现这些功能的目的我开始了组件封装

我就是引用组件的方式,来传参实现控制这些功能就算完成任务,下面来分享一下我写的代码,小二,上代码~

```

import React, { useState } from "react";

import styled, { css } from "styled-components";

import { rem } from "@utils/UtilsFunc";

const Wrapper = styled.button`

  width: ${(props) => (props.isInline === true ? "" : rem(250))};

  height: ${(props) => (props.size === "small" ? rem(28) : rem(40))};

  margin: 0 auto;

  border: none;

  font-size: 16px;

  color: #ffffff;

  border-radius: ${rem(4)};

  background-color: #ff5b5b;

  padding: 0 ${rem(16)};

  ${(props) =>

    props.shape &&

    css`

      border-radius: ${props.shape === "square"

        ? 0

        : props.shape === "circle"

        ? rem(20)

        : rem(4)};

    `};

  ${(props) =>

    props.type &&

    css`

      background: ${props.type === "normal"

        ? "linear-gradient(137deg, #ff5b5b 0%, #db0113 100%)"

        : "transparent"};

      border: 1px solid ${props.type === "normal" ? "none" : "#FF5B5B"};

      color: ${props.type === "normal" ? "#FFFFFF" : "#FF5B5B"};

    `};

  ${(props) =>

    props.isShortClick &&

    css`

      background: ${props.type === "normal"

        ? "rgba(255, 255, 255, 0.372)"

        : "linear-gradient(137deg, #f70000 0%, #f70000 100%);"};

      color: ${props.type === "normal" ? "rgb(242, 145, 145)" : "#fc9d9d"};

    `};

  ${(props) =>

    css`

      display: ${props.isInline === true ? "inline-block" : "block"};

    `};

  ${(props) =>

    props.disabled &&

    props.isBgGrey &&

    css`

      background: ${props.type === "normal" ? "#E09896" : "transparent"};

    `}

  ${(props) =>

    (props.disabled === false || props.isBgGrey === false) &&

    css`

      background: ${props.type === "normal"

        ? "linear-gradient(137deg, #ff5b5b 0%, #db0113 100%)"

        : "transparent"};

    `}

  .button-disabled {

    ${(props) =>

      props.type &&

      css`

        color: ${props.type === "normal"

          ? "rgba(255, 255, 255, 0.6)"

          : "#E09896"};

      `};

    opacity: 0.4;

  }

`;

const Button = (props) => {

  const {

    shape,

    type,

    text,

    disabled,

    onClick,

    isBgGrey,

    isInline,

    size,

    style,

    throttleTime

  } = props;

  const [isShortClick, setIsShortClick] = useState(false);

  const [isThrottle, setIsThrottle] = useState(false);

  const _onClick = () => {

    if (disabled === true) {

      return;

    }

    if (isThrottle === true) {

      return;

    }

    console.log("click the button");

    setIsShortClick(true);

    setIsThrottle(true);

    onClick();

    setTimeout(() => {

      setIsShortClick(false);

    }, 100);

    // 节流处理

    setTimeout(() => {

      setIsThrottle(false);

    }, throttleTime);

  };

  return (

    <Wrapper

      shape={shape}

      type={type}

      isInline={isInline}

      size={size}

      isShortClick={isShortClick}

      onClick={_onClick}

      style={style}

      disabled={disabled}

      isBgGrey={isBgGrey}

    >

      <span className={disabled && isBgGrey ? "button-disabled" : ""}>

        {text}

      </span>

    </Wrapper>

  );

};

Button.defaultProps = {

  type: "normal",

  shape: "default",

  text: "this is a button",

  disabled: false,

  onClick: () => {},

  isBgGrey: true,

  isInline: false,

  size: "small",

  throttleTime: 500,

  style: {}

};

export default Button;

```

仔细看其实用到的东西就是三个

1.Button.defaultProps

2. styled-components的使用

3.${}让其在css里面可以写js用这些来灵活的使用外部组件传进来的参数控制整个组件的一个状态

其实到上面那些代码这个组件已经封装好了,那么还有就是如何像antd mobile或者vant UI那么去展示呢

看到右边的control没有,修改那个就能更改模拟机上面显示的效果,那么这个就是重点,也是难点

笔者开头已经说过,这个架构是老大(架构师)搭建起来的,用于收集加工业务组件,提高开发效率,让我们不用繁忙于业务,高效的完成业务开发

在这里附上组件库搭建用到的技术(storybook)官网地址:https://storybook.js.org/tutorials/

再来说有了这个架构以及有了刚才封装的组件如何在页面中给它展示出来


如图除了guideDocAssets(里面放了一些图片)存放静态资源的地方,我们之所以能看到页面上的那个类似antd mobile里面看到的那些效果

下面我付出源码标注一下意思

```

import React from "react";

import Button from "@components/Button";

import "lib-flexible";

export default {

  title: "TCLPH/Component/Button",

  component: Button,

  parameters: {

    viewport: {

      defaultViewport: "iphone6"

    },

    layout: "padded" // 'padded' | 'centered' | 'fullscreen',

  },

  argTypes: {

    type: {

      defaultValue: "normal",

      description: "按钮的类型,实心还是缕空normal/实心,ghost/缕空",

      table: {

        type: { summary: "string" },

        defaultValue: {

          summary: "normal"

        }

      },

      options: ["normal", "ghost"],

      control: {

        type: "select"

      }

    },

    shape: {

      defaultValue: "default",

      description: "按钮形状,default/柔和边角,square/直角边角,circle/圆弧边角",

      table: {

        type: { summary: "string" },

        defaultValue: {

          summary: "default"

        }

      },

      options: ["default", "square", "circle"],

      control: {

        type: "select"

      }

    },

    text: {

      defaultValue: "this is a button",

      description: "按钮内置的文案",

      table: {

        type: { summary: "string" },

        defaultValue: {

          summary: "this is a button"

        }

      },

      control: {

        type: "text"

      }

    },

    disabled: {

      defaultValue: false,

      description: "是否禁用",

      table: {

        type: { summary: "boolean" },

        defaultValue: {

          summary: "false"

        }

      },

      control: {

        type: "boolean"

      }

    },

    onClick: {

      defaultValue: "",

      description: "函数",

      table: {

        type: {

          summary: "function"

        },

        defaultValue: {

          summary: "() => {}"

        }

      },

      control: {

        type: null

      }

    },

    isBgGrey: {

      defaultValue: true,

      description:

        "当按钮禁用时,按钮背景是否置灰;此属性仅当disabled为true时生效",

      table: {

        type: {

          summary: "boolean"

        },

        defaultValue: {

          summary: "true"

        }

      },

      control: {

        type: "boolean"

      }

    },

    isInline: {

      defaultValue: false,

      description: "是否行内元素(可以理解为是否非独占一行)",

      table: {

        type: {

          summary: "boolean"

        },

        defaultValue: {

          summary: "false"

        }

      },

      control: {

        type: "boolean"

      }

    },

    size: {

      defaultValue: "small",

      description: "按钮的大小,large/大,small/小",

      table: {

        type: {

          summary: "string"

        },

        defaultValue: {

          summary: "small"

        }

      },

      options: ["small", "large"],

      control: {

        type: "select"

      }

    },

    style: {

      defaultValue: {},

      description: "自定义样式",

      table: {

        type: {

          summary: "object"

        },

        defaultValue: {

          summary: "例如marginLeft:50px添加到后面"

        }


```

需要注意的点就是那些参数对应的是哪里,下面讲解一下就知道了


对应的效果如下图


对应上面图的按钮字样


argTypes就是右侧的这些参数


这张图对应了 argTypes底下代码的解释

好到这里就结束了,看不懂的小伙伴也不要灰心喔,欢迎评论区评论交流。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,547评论 6 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,399评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,428评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,599评论 1 274
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,612评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,577评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,941评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,603评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,852评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,605评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,693评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,375评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,955评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,936评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,172评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 43,970评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,414评论 2 342

推荐阅读更多精彩内容