React

关注公众号 jb51net

关闭
首页 > 网络编程 > JavaScript > javascript类库 > React > React骨架屏

React实现骨架屏的示例代码

作者：不cong明的亚子

这篇文章主要为大家详细介绍了如何通过React自动化实现骨架屏,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下

背景

最近有在项目中使用到骨架屏这个东西，由于项目中使用了antd组件库，所以想当然的就使用了它里面的Skeleton组件；

但是，使用中，在写完业务代码之后，还需要针对性的处理一下骨架屏相关的代码

目的

减少骨架屏占用开发时间，最好是自动化生成相关页面的骨架屏

技术栈

react @16.8 >=

sass

实现

开发一个相对自动化的骨架屏组件，只需要在使用骨架屏的业务组件中引入该组件，那么就会自动根据当前的dom结构，生成对应的骨架屏结构。

这里博主自己开发了一款组件，暂且是麻麻得，不过目前是符合我所使用的场景，后续再根据业务继续更新迭代，不过也欢迎大家一起来帮忙完善。

示例代码

暂且使用组件的方式如下，当然感兴趣的可以拿到源码，自己在修改成想要的方式

import { useState, Fragment, useEffect } from 'react';
import { AutoSkeleton, Button } from 'gyp-gao-ui';

export default () => {
  const [isShow, setIsShow] = useState(true);
  const [loading, setLoading] = useState(false);

  const handleFresh = () => {
    setLoading(true);
    setTimeout(() => {
      setLoading(false);
    }, 2000);
  };

  /** 模拟请求 */
  useEffect(() => {
    handleFresh();
  }, []);

  return (
    <>
      <Button text="点击刷新" onClick={handleFresh}></Button>

      <h1>大家也可以尝试自己去更新dom元素，看看生成的骨架屏是否中意</h1>
      <div>
        {isShow && (
          <Fragment>
            <p>这是一个段落</p>
            <p>这是一个段落</p>
            <img src="https://zos.alipayobjects.com/rmsportal/jkjgkEfvpUPVyRjUImniVslZfWPnJuuZ.png" />
            <div
              style={{
                marginTop: '20px',
                display: 'flex',
                alignItems: 'center',
                justifyContent: 'space-between',
              }}
            >
              <button>显示</button>
              <p>这是一个段落</p>
              <img src="https://zos.alipayobjects.com/rmsportal/jkjgkEfvpUPVyRjUImniVslZfWPnJuuZ.png" />
            </div>
            <div>
              <button>显示</button>
              <p>这是一个段落</p>
              <img src="https://zos.alipayobjects.com/rmsportal/jkjgkEfvpUPVyRjUImniVslZfWPnJuuZ.png" />

              <div>
                <button>显示</button>
                <p>这是一个段落</p>
                <img src="https://zos.alipayobjects.com/rmsportal/jkjgkEfvpUPVyRjUImniVslZfWPnJuuZ.png" />
                <div
                  style={{
                    marginTop: '20px',
                    display: 'flex',
                    alignItems: 'center',
                    justifyContent: 'space-between',
                  }}
                >
                  <button>显示</button>
                  <p>这是一个段落</p>
                  <img src="https://zos.alipayobjects.com/rmsportal/jkjgkEfvpUPVyRjUImniVslZfWPnJuuZ.png" />
                </div>
              </div>
            </div>
          </Fragment>
        )}
        <AutoSkeleton
          loading={loading}
          onLoadingSuccess={() => {
            setIsShow(true);
          }}
          onComplete={() => {
            setIsShow(false);
          }}
        />
      </div>
    </>
  );
};

核心思路

在某一小块独立的组件中，生成对应的骨架屏。 从使用中，可以看到博主在使用的时候，是吧AutoSkeleton组件与内容通过一个Fragment组件隔离开来，共同存在于一个容器（div）中;

将骨架屏中的组件进行抽离，细分颗粒。 从市面上常用骨架屏来看，无非就是文本和图片两种类型，然后再进行一系列的演变，分成不同的骨架屏中的小组件，这里博主只分为了Text和Image两种类型骨架屏小组件；

比较粗暴的通过html标签的不同，分为了以上两种小组件，分类代码

/** 为text类型的标签类型组合 */
export const textTypes = ['p', 'span', 'a', 'button', 'input', 'textarea', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6', 'div', 'li', 'ul', 'ol', 'pre', 'code', 'blockquote', 'cite','strong', 'em','mark', 'del', 'ins','sub','sup','small', 'big']

​​​​​​​/** 为image类型的标签类型组合 */
export const imageTypes = ['img','svg', 'picture', 'video', 'audio']

生成骨架屏，通过遍历容器中的内容节点。不同分类，渲染不同的小组件，这里需要特别处理的是，如果当前组件是div，并且存在children，那么就继续生成小组件。

核心代码

生成骨架屏组件

import React, { useEffect, useRef, useState } from 'react';
import { comp_className } from '../constants';
import './index.scss';
import { Image, Text, imageTypes, textTypes } from './skeleton';
import { nanoid } from 'nanoid';

export interface IAutoSkeletonProps {
  /** 生成骨架屏完成 */
  onComplete?: () => void;
  /**
   * 加载中
   * @default true
   */
  loading: boolean;
  /** 加载完成回调 */
  onLoadingSuccess?: () => void;
}

function AutoSkeleton(props: IAutoSkeletonProps) {
  const { onComplete, loading = true, onLoadingSuccess } = props;
  const [showMenu, setShowMenu] = useState(false);
  const [currentPoint, setCurrentPoint] = useState<{ x: number; y: number }>({
    x: 0,
    y: 0,
  });
  const currentRef = useRef<HTMLDivElement>(null);
  const [skeleton, setSkeleton] = useState<any>();
  const genSkeleton = () => {
    if (!currentRef.current) return;
    const parent = currentRef.current.parentElement;
    if (!parent) return;
    /** 除了骨架屏内容以外的元素 */
    const targetElements = Array.from(parent.children).filter(
      (o) => !o.className.includes(comp_className + 'auto-skeleton'),
    );

    const getSkeletonSon = (elements: Element[], parent: Element) => {
      const child = elements
        .map((k) => {
          if (k.children.length > 0 && k.nodeName.toLowerCase() === 'div') {
            return getSkeletonSon(Array.from(k.children), k);
          }
          if (imageTypes.includes(k.nodeName.toLowerCase())) {
            return <Image key={nanoid()} />;
          }
          if (textTypes.includes(k.nodeName.toLowerCase())) {
            return <Text key={nanoid()} />;
          }

          return null;
        })
        .filter((k) => k !== null);
      const style = getComputedStyle(parent);
      return (
        <div
          key={nanoid()}
          style={{
            display: 'flex',
            width: style.width,
            flexDirection:
              style.flexDirection && style.display === 'flex'
                ? (style.flexDirection as any)
                : 'column',
            justifyContent: style.justifyContent,
            alignItems: style.alignItems,
            gap: style.gap === 'normal' ? '12px' : style.gap,
          }}
        >
          {child}
        </div>
      );
    };

    const getSkeletonChild = (elements: Element[]) => {
      return elements
        .map((o) => {
          if (o.children.length > 0 && o.nodeName.toLowerCase() === 'div') {
            return getSkeletonSon(Array.from(o.children), o);
          }
          if (imageTypes.includes(o.nodeName.toLowerCase())) {
            return <Image key={nanoid()} />;
          }
          if (textTypes.includes(o.nodeName.toLowerCase())) {
            return <Text key={nanoid()} />;
          }

          return null;
        })
        .filter((o) => o !== null);
    };

    const skeletonContent = getSkeletonChild(targetElements);

    setSkeleton(skeletonContent);
    setTimeout(() => {
      onComplete && onComplete();
      setShowMenu(false);
    }, 0);
  };

  useEffect(() => {
    if (loading) {
      genSkeleton();
    } else {
      onLoadingSuccess && onLoadingSuccess();
    }
  }, [loading]);

  return (
    loading && (
      <div
        className={`${comp_className}auto-skeleton`}
        ref={currentRef}
      >
        {skeleton}
      </div>
    )
  );
}

export default AutoSkeleton;

涉及到样式，这里博主也贴一下代码，骨架屏的样式还是比较复杂的

index.scss

.xxx-auto-skeleton {
  width: 100%;
  height: 100%;
  display: flex;
  flex-direction: column;
  gap: 12px;

  &-image {
    flex: 0 0 auto; // 防止被挤压
    width: 80px;
    height: 80px;
    background: linear-gradient(
      90deg,
      rgba(190, 190, 190, 0.2) 25%,
      rgba(129, 129, 129, 0.24) 37%,
      rgba(190, 190, 190, 0.2) 63%
    );
    border-radius: 8px;
    animation: xxx-skeleton-loading 1.4s ease infinite;
    background-size: 200% 100%;
    background-position: 100% 50%;
    background-position-x: 180%;
  }

  &-text {
    width: 100%;
    height: 32px;
    border-radius: 4px;

    background: linear-gradient(
      90deg,
      rgba(190, 190, 190, 0.2) 25%,
      rgba(129, 129, 129, 0.24) 37%,
      rgba(190, 190, 190, 0.2) 63%
    );
    animation: xxx-skeleton-loading 1.4s ease-in-out infinite;
    background-size: 200% 100%;
    background-position: 100% 50%;
    background-position-x: 180%;
  }

  @keyframes xxx-skeleton-loading {
    to {
        background-position-x: -20%;
      }
  }
}

小组件的代码就比较简单，只是为了后续维护，抽离出来，这里以Text举例

import React from 'react';
import { comp_className } from '../../constants';
import '../index.scss';

​​​​​​​export default function TextSkeleton() {
    return (
        <div className={`${comp_className}auto-skeleton-text`}></div>
    )
}

写在最后

以上如果大家认真跟完之后，应该是可以跟博主一样，拥有同样的效果！

不过呢，怕有些小伙伴为了麻烦，博主也很贴心的把我的组件库发布了，可以直接npm仓库去下载

npm i -S gyp-gao-ui

到此这篇关于React实现骨架屏的示例代码的文章就介绍到这了,更多相关React骨架屏内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:
阅读全文