基于TypeScript与React Hooks开发的通用组件库

项目地址:react-draggable-layer

技术博客:https://www.linxiangjun.com

前言

2019年以来,越来越多的公司与项目都选择使用强类型语言TypeScript作为主要语言,可以预见的是2020年TypeScript将成为前端开发所需要具备的能力之一。

目前前端工程师使用最多的无疑问是微软开源的VSCode,它本身提供的功能并不多,但是通过支持插件的方式使得其具备了IDE的强大能力。同时,VSCode是使用TypeScript基于Eletron开发的,使得它对于TypeScript的支持非常的强大。如果你使用的编辑器是VSCode,那么项目中完全使用TypeScript编程将会大大的提高编程效率,甚至使用一段时间后你会发现,已经渐渐离不开TypeScript。

应用新的语言还是语法都会面临着许多困难和陷阱,这个时候如果能够参考一些现成的写法肯定会带来收益。这也是我写这篇文章的初衷。

下面是react-draggable-layer使用到的一些技术细节:

  • TypeScript
  • React Hooks
  • React Portals
  • emotion
  • Babel

实现

效果动画

Portals

实现一个弹层类组件,React提供了Portals方法,能够将子节点渲染到存在于父组件以外的DOM节点上。我们先实现一个封装了Portals方法的通用组件:

components/Portal.jsx

import React, { useEffect, useRef } from "react";
import ReactDOM from "react-dom";

interface PortalProps {
  children: React.ReactElement;
}

const Portal: React.FC<PortalProps> = props => {
  // 使用useRef创建ref对象,可以用来保存节点
  const { current: el } = useRef(document.createElement("div"));

  // 等同于类组件的componentDidMount方法
  useEffect(() => {
    const root = document.getElementById("root");
    if (root) {
      root.appendChild(el);
    }

    // 组件销毁后记得移除div
    return () => {
      if (root) {
        root.removeChild(el);
      }
    };
  }, []);

  return ReactDOM.createPortal(props.children, el);
};

export default Portal;

css-in-js

有了Portal组件之后在可拖拽弹层组件中引入,这样组件在使用时就可以挂载到root节点下。在组件中样主要是以css-in-js的方式来实现的,它的优点有:

  1. 不需要引入css样式文件或者css预处理器
  2. 可避免因为样式名冲突带来的全局污染问题
  3. 不需要各种繁琐的命名规则

这并不是说它就没有缺点的,同样的,使用css-in-js来开发会使得很多高阶css用法非常的复杂,所以需要根据项目情况来辩证的思考与选择。不过对于此项目来说css-in-js就非常的合适,它使得我们可以将更多的精力放在组件化上面。另外这里推荐下emotion这个库。

React.FC

这里先来基于项目说一下TypeScript开发React函数式组件的规范:

interface DraggableLayerProps {
  children?: React.ReactElement;
  titleName?: string;
  visible?: boolean;
  onClose?: () => void;
}

const DraggableLayer: React.FC<DraggableLayerProps> = props => <Component />

export default DraggableLayer

使用函数式组件时需要将组件申明为React.FC类型,也就是Functional Component的意思,另外props需要申明各个参数的类型,然后通过泛型传递给React.FC

draggable

可拖拽功能的实现是基于实时计算组件x轴与y轴的距离来实现的,具体代码比较简洁:

let initX = 0;
let initY = 0;
let isMouseDown = false;

const handleMouseDown = (e: MouseEvent) => {
    isMouseDown = true;
    initX = e.offsetX;
    initY = e.offsetY;
    draggableRef.current.style.opacity = 0.5;
  };

  const handleMouseMove = (e: MouseEvent) => {
    if (isMouseDown) {
      const x = e.clientX - initX;
      const y = e.clientY - initY;
      draggableRef.current.style.left = `${x}px`;
      draggableRef.current.style.top = `${y}px`;
    }
  };

  const handleMouseUp = () => {
    isMouseDown = false;
    if (draggableRef && draggableRef.current) {
      draggableRef.current.style.opacity = 1;
    }
  };

稳健性

在组件获取props时有很多可选的参数,比如titleName,因为使用了TypeScript,所以对可选参数进行赋值操作时提示错误信息,这点在开发时能够有效的避免出错。另外,组件销毁后需要在useEffectreturn回调函数中清除绑定的event。这些细节需要注意。

总结

非常欢迎尝试本项目,可以直接使用npm install react-draggable-layer来使用,有好的建议也希望能够收到提交的issues。一些更加详细的使用说明在项目中的README文件中。如果本文或者项目对你有帮助的话,非常高兴您能够点下star支持。

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

推荐阅读更多精彩内容