# loading_dialog

**Repository Path**: lyb5834/loading-dialog

## Basic Information

- **Project Name**: loading_dialog
- **Description**: Harmony LoadingDialog
- **Primary Language**: TypeScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 19
- **Forks**: 1
- **Created**: 2024-04-03
- **Last Updated**: 2025-08-25

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# LoadingDialog

#### 介绍

简单易用的 Harmony LoadingDialog

#### 安装教程

执行安装命令
`ohpm install @lyb/loading-dialog`

#### 重要提醒

~~请勿在 `EntryAbility.ets` 文件中调用本库任何方法，不然会导致dialog显示不出来~~
* 如果连续调用dialog，最好加上 `await`

- [x] `2.1.0` 之后换了实现可以在任意地方调用
- [x] 支持加载、更新、关闭自定义视图

#### SDK Support

| SDK版本   | Support   |
|---------|-----------|
| 2.0.0 + | 5.0.0(12) | 
| 1.2.0 - | 4.1.0(11) |

#### 默认样式预览

| 样式       | 预览效果                                  |
|----------|---------------------------------------|
| loading  | ![loading.png](preview/loading.png)   |
| success  | ![success.png](preview/success.png)   |
| failure  | ![failure.png](preview/failure.png)   |
| info     | ![info.png](preview/info.png)         |
| warn     | ![warn.png](preview/warn.png)         |
| toast    | ![toast.png](preview/toast.png)       |
| progress | ![progress.png](preview/progress.png) |

#### 使用说明

###### 基础用法

* 显示 loading
  `LoadingDialog.showLoading('这是一个loading')`
* 显示 success
  `LoadingDialog.showSuccess('这是一个success dialog')`
* 显示 failure
  `LoadingDialog.showFailure('这是一个failure dialog')`
* 显示 info
  `LoadingDialog.showInfo('这是一个info dialog')`
* 显示 progress
  `LoadingDialog.showProgress('正在下载...', this.progress)`
* 隐藏
  `LoadingDialog.hide()`

###### 进阶用法

```
LoadingDialog.showLoading({
                msg: '这是一个loading',
                tintColor: Color.Red,
                textColor: Color.Yellow,
                ...
              })
```

#### 全局参数定义

```
LoadingDialog.setGlobalSettings((setting) => {
      setting.tintColor = Color.White
      setting.textColor = Color.Orange
      ...
    })
```

#### 自定义参数

| 参数                 | 默认值       | 描述                             |
|--------------------|-----------|--------------------------------|
| msg                | ""        | 提示文本                           |
| alignment          | center    | 指示器位置                          |
| offset             | 0，0       | 指示器偏移量                         |
| tintColor          | 白色        | 指示器颜色（图片，progress等等）           |
| textColor          | 白色        | 指示器文字颜色                        |
| hideDelay          | 2000ms    | 指示器自动关闭时间（loading，progress时无效） |
| fontSize           | 16        | 文字大小                           |
| backgroundColor    | #cc000000 | 指示器颜色                          |
| maskColor          | 透明        | 指示器蒙层的颜色                       |
| borderRadius       | 10        | 指示器圆角                          |
| transition         | undefined | 指示器显示/关闭的转场                    |
| successSrc         | 成功图片      | 图片 (最好是svg格式)                  |
| failureSrc         | 失败图片      | 图片 (最好是svg格式)                  |
| infoSrc            | 提示图片      | 图片 (最好是svg格式)                  |
| warnSrc            | 警告图片      | 图片 (最好是svg格式)                  |
| hideOnTouchOutside | false     | 点击dialog外是否隐藏                  |
| hideOnSystemBack   | false     | 系统侧滑返回时是否隐藏                    |
| isModal            | true      | 是否为模态窗口，模态窗口有蒙层，非模态窗口无蒙层       |

#### 开源协议

[MIT License](https://gitee.com/lyb5834/loading-dialog/blob/master/LICENSE)