React+Antd全局加载遮罩工具

下面是全局加载遮罩工具,功能:提供show和showWithDelay/hide方法用于显示/延时显示/隐藏遮罩,它还提供loading属性返回是否正在loading。通常用于耗时较长的操作,比如远端api调用。

如何用它,下面是个例子,这个是全局的postAction:

javascript 复制代码
import loadingMask from './loadingMask';
...
// 设置延迟显示加载遮罩(1秒后显示)
  loadingMask.showWithDelay('请求处理中,请稍候...', 1000);

  return axios({
    url: url,
    method: 'post',
    data: parameter,
    headers: { ...signHeader, ...config.headers },
    ...config
  }).then(res => {
    // 请求完成后隐藏加载遮罩
    loadingMask.hide();
    return handleResponse(res);
  }).catch(err => {
    // 请求出错后隐藏加载遮罩
    loadingMask.hide();
    return handleError(err);
  });

如果想实时获得它的loading属性呢?这时候要订阅它的状态变化:

javascript 复制代码
const [loading, setLoading] = useState(loadingMask.loading);
// 订阅 loadingMask 的 loading 状态变化
    useEffect(() => {
        // 订阅 loading 状态变化
        const unsubscribe = loadingMask.subscribeToLoading(setLoading);

        // 组件卸载时取消订阅
        return unsubscribe;
    }, []);
    ...
    <Button
                        block
                        type='submit'
                        color='primary'
                        loading={loading}
                    >
                        删除选中记录
                    </Button>

这时候loadingMask的loading状态变化会立即返回到setLoading,也就会引导起button的重新渲染。

组件代码如下:

javascript 复制代码
import React from 'react';
import { createRoot } from 'react-dom/client';
import { Mask, SpinLoading } from 'antd-mobile';
import styled from 'styled-components';

const LoadingContainer = styled.div`
  display: flex;
  flex-direction: column;
  align-items: center;
  justify-content: center;
  position: absolute;
  top: 50%;
  left: 50%;
  transform: translate(-50%, -50%);
  color: #ffffff;
`;

const LoadingText = styled.div`
  margin-top: 12px;
  font-size: 14px;
`;

/**
 * 全局加载遮罩工具
 * 用于在长时间请求时显示加载遮罩
 */
class LoadingMask {
  constructor() {
    this.container = null;
    this.root = null;
    this.visible = false;
    this.timeoutId = null;
    this.loadingText = '正在加载,请稍候...';
    this._loading = false; // 添加内部 loading 状态
    this._listeners = []; // 添加监听器数组
    this.init();
  }

  /**
   * 初始化加载遮罩容器
   */
  init() {
    // 创建容器元素
    this.container = document.createElement('div');
    this.container.id = 'global-loading-mask-container';
    document.body.appendChild(this.container);
    
    // 创建React 18的root
    this.root = createRoot(this.container);
    
    // 初始渲染
    this.render();
  }

  /**
   * 渲染加载遮罩
   */
  render() {
    if (!this.root) {
      this.init();
      return;
    }

    this.root.render(
      <Mask opacity={0.7} visible={this.visible}>
        <LoadingContainer>
          <SpinLoading color='white' style={{ '--size': '48px' }} />
          <LoadingText>{this.loadingText}</LoadingText>
        </LoadingContainer>
      </Mask>
    );
  }

  /**
   * 显示加载遮罩
   * @param {string} text - 加载提示文本
   */
  show(text) {
    this.loadingText = text || '正在加载,请稍候...';
    this.visible = true;
    this._setLoading(true); // 使用新方法设置 loading 状态
    this.render();
  }

  /**
   * 隐藏加载遮罩
   */
  hide() {
    this.visible = false;
    this._setLoading(false); // 使用新方法设置 loading 状态
    this.render();

    // 清除定时器
    if (this.timeoutId) {
      clearTimeout(this.timeoutId);
      this.timeoutId = null;
    }
  }

  /**
   * 设置延迟显示加载遮罩
   * @param {string} text - 加载提示文本
   * @param {number} delay - 延迟时间(毫秒)
   */
  showWithDelay(text, delay = 1000) {
    // 清除之前的定时器
    if (this.timeoutId) {
      clearTimeout(this.timeoutId);
    }
    
    // 立即设置 loading 状态为 true
    this.loadingText = text || '正在加载,请稍候...';
    this._setLoading(true); // 使用新方法设置 loading 状态

    // 设置新的定时器,只延迟显示遮罩
    this.timeoutId = setTimeout(() => {
      this.visible = true;
      this.render();
    }, delay);
  }

  // 添加设置 loading 状态的方法,并通知监听器
  _setLoading(value) {
    if (this._loading !== value) {
      this._loading = value;
      // 通知所有监听器
      this._listeners.forEach(listener => listener(value));
    }
  };

  // 添加订阅方法
  subscribeToLoading(callback) {
    this._listeners.push(callback);
    // 立即通知当前状态
    callback(this._loading);
    
    // 返回取消订阅的函数
    return () => {
      this._listeners = this._listeners.filter(cb => cb !== callback);
    };
  };
}


// 创建单例实例
const loadingMask = new LoadingMask();

// 添加 loading 属性的 getter
Object.defineProperty(loadingMask, 'loading', {
  get: function() {
    return this._loading;
  }
});

export default loadingMask;
相关推荐
怀旧,24 分钟前
【Python】3.函数与列表
java·前端·python
唐人街都是苦瓜脸1 小时前
uni-app 提供的页面跳转方法详细解释及其区别
前端·uni-app
咔咔库奇2 小时前
性能优化深度实践:突破vue应用性能
前端·vue.js·性能优化
Bingo_BIG2 小时前
甘特图 dhtmlxGantt.js UA实例
javascript·甘特图·ua
编程乐学(Arfan开发工程师)2 小时前
28、请求处理-【源码分析】-请求映射原理
java·前端·spring boot·后端·spring
咔咔库奇2 小时前
前端开源JavaScrip库
前端·开源
_r0bin_3 小时前
前端面试准备2
前端·html
白皎3 小时前
立志成为一名优秀测试开发工程师(第九天)——使用fiddler工具、request库进行接口测试
前端·python·fiddler
召田最帅boy3 小时前
基于URL弹窗的图片链接生成功能技术实现
android·java·javascript
saadiya~3 小时前
Vue3 + Element Plus 实现树形结构的“单选 + 只选叶子节点 + 默认选中第一个子节点”
前端·javascript·vue.js