# harmonyXToast

**Repository Path**: StephenTom/harmony-xtoast

## Basic Information

- **Project Name**: harmonyXToast
- **Description**: 提供简单的显示不同类型的Toast。如：text、success、fail、loading。支持API 12
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2024-07-30
- **Last Updated**: 2025-05-13

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# harmonyXToast

#### 介绍
    提供简单的显示不同类型的Toast。如：text、success、fail、loading。手动取消loading。支持API 12

#### 安装教程
```
ohpm install @hong/harmonyxtoast
```

#### 属性说明
```typescript
interface XToastTheme {
  // 文本颜色 默认白色
  textColor: ResourceColor
  // 文本大小 单位 rp
  fontSize: number
  // hud 背景颜色
  hudBgColor: ResourceColor
  // hud 圆角 (默认单位vp)
  hudRadius: number
  // 蒙版的背景颜色
  maskColor: ResourceColor
  // 点击系统返回时，是否隐藏hud
  hideOnTouchSystemBack: boolean
}
```

#### 1.0.2修复问题：解决以下嵌套问题
```typescript
.onClick(() => {
    XToast.loading('测试 toast 加载...111')

    setTimeout(() => {
        XToast.dismiss()
        XToast.loading('测试 toast 加载...222')

        setTimeout(() => {
            XToast.dismiss()
            XToast.loading('测试 toast 加载...333')

            setTimeout(() => {
                XToast.dismiss()
                XToast.showSuccess('测试 toast 成功')
            }, 5000)
        }, 5000)
    }, 5000)
}
```

#### 使用说明
1、初始化 XToast
```typescript
windowStage.loadContent(INDEX_URL, (err) => {
  if (err.code) {
    hilog.error(0x0000, 'testTag', 'Failed to load the content. Cause: %{public}s', JSON.stringify(err) ?? '');
    return;
  }

  // 初始化 xToast
  XToast.initXToast(windowStage.getMainWindowSync().getUIContext())
		 
  hilog.info(0x0000, 'testTag', 'Succeeded in loading the content.');
});
```

2、显示文本提示
```typescript
XToast.showText('测试 toast 文本显示')
```
![img_1.png](preview/text.png)

3、显示成功提示
```typescript
XToast.showSuccess()
```
![img_2.png](preview/success.png)

```typescript
XToast.showSuccess('测试 toast 成功')
```
![img_5.png](preview/success_text.png)

4、显示失败提示
```typescript
XToast.showFail()
```
![img_3.png](preview/fail.png)

```typescript
XToast.showFail('测试 toast 失败')
```
![img_6.png](preview/fail_text.png)

5、显示加载
```typescript
XToast.loading()
```
![img_4.png](preview/loading.png)

```typescript
XToast.loading('测试 toast 加载...')
```
![img_7.png](preview/loading_text.png)

6、特殊toast方式
```typescript
XToast.showSpecialToast({
  msg: '修改昵称成功',
  icon: $r('app.media.icon_dagou'),
  iconWidth: 94,
  iconHeight: 84,
  duration: 2500
})
```
![img_5.png](preview/special.png)

7、取消加载
```typescript
XToast.dismiss()
```