鸿蒙NEXT开发土司工具类（ArkTs）

鸿蒙布道师2025-04-06 19:22
复制代码 
import promptAction from '@ohos.promptAction';

/**
 * TODO Toast默认样式参数
 * author: 鸿蒙布道师
 * since: 2025/04/02
 */
export class ToastConfig {
  duration: number = 2000; // 显示时长(1500ms-10000ms)
  duration_short: number = 1500; // 显示时长(1500ms)
  duration_long: number = 10000; // 显示时长(10000ms)
  showMode: promptAction.ToastShowMode = promptAction.ToastShowMode.DEFAULT; // 是否显示在应用之上
  alignment?: Alignment; // 对齐方式，默认值：undefined，默认底部偏上位置
  bottom: string | number = '80vp'; // 设置弹窗底部边框距离导航条的高度
  offset: Offset = { dx: 0, dy: 0 }; // 在对齐方式上的偏移，默认值：{dx:0, dy:0}
  textColor: ResourceColor = Color.White; // 文本提示框文本颜色，默认值：Color.Black
  backgroundColor: ResourceColor = '#CC000000'; // 文本提示框背板颜色，默认值：Color.Transparent
  backgroundBlurStyle: BlurStyle = BlurStyle.NONE; // 文本提示框背板模糊材质，默认值：BlurStyle.COMPONENT_ULTRA_THICK
  shadow: ShadowOptions | ShadowStyle = ShadowStyle.OUTER_DEFAULT_MD; // 文本提示框背板阴影，默认值：ShadowStyle.OUTER_DEFAULT_MD
}

/**
 * TODO Toast基本参数类
 * author: 鸿蒙布道师
 * since: 2025/04/02
 */
export class ToastOptions {
  duration?: number; // 显示时长(1500ms-10000ms)
  showMode?: promptAction.ToastShowMode; // 是否显示在应用之上
  alignment?: Alignment; // 对齐方式，默认值：undefined，默认底部偏上位置
  bottom?: string | number; // 设置弹窗底部边框距离导航条的高度
  offset?: Offset; // 在对齐方式上的偏移，默认值：{dx:0, dy:0}
  textColor?: ResourceColor; // 文本提示框文本颜色，默认值：Color.Black
  backgroundColor?: ResourceColor; // 文本提示框背板颜色，默认值：Color.Transparent
  backgroundBlurStyle?: BlurStyle; // 文本提示框背板模糊材质，默认值：BlurStyle.COMPONENT_ULTRA_THICK
  shadow?: ShadowOptions | ShadowStyle; // 文本提示框背板阴影，默认值：ShadowStyle.OUTER_DEFAULT_MD
}

/**
 * TODO 土司工具类
 * author: 鸿蒙布道师
 * since: 2025/04/02
 */
export class ToastUtil {
  private static defaultConfig: ToastConfig = new ToastConfig(); // 默认样式

  /**
   * 设置默认统一样式
   * @param configs 回调函数，用于修改默认配置
   */
  static setDefaultConfig(configs: (config: ToastConfig) => void): void {
    configs(ToastUtil.defaultConfig);
  }

  /**
   * 弹出土司，默认时长为2s，距离底部默认为80vp
   * @param message 提示消息
   * @param options 可选参数（显示时长、距离屏幕底部的位置、是否显示在应用之上等）
   */
  static showToast(message: string | Resource, options: ToastOptions = {}): void {
    ToastUtil.show(message, options, 0);
  }

  /**
   * 弹出土司，时长为1.5s，距离底部默认为80vp
   * @param message 提示消息
   * @param options 可选参数（距离屏幕底部的位置、是否显示在应用之上等）
   */
  static showShort(message: string | Resource, options: ToastOptions = {}): void {
    ToastUtil.show(message, options, 1);
  }

  /**
   * 弹出土司，时长为10s，距离底部默认为80vp
   * @param message 提示消息
   * @param options 可选参数（距离屏幕底部的位置、是否显示在应用之上等）
   */
  static showLong(message: string | Resource, options: ToastOptions = {}): void {
    ToastUtil.show(message, options, 2);
  }

  /**
   * 内部方法：统一处理 Toast 的显示逻辑
   * @param message 提示消息
   * @param options 可选参数
   * @param type 类型标识（0: 默认，1: 短时间，2: 长时间）
   */
  private static show(message: string | Resource, options: ToastOptions, type: number): void {
    if (!message || (typeof message === 'string' && message.trim() === '')) {
      console.warn('ToastUtil: Empty or invalid message provided.');
      return;
    }

    const finalOptions = ToastUtil.initToastDefault(options, type);

    promptAction.showToast({
      message,
      duration: finalOptions.duration,
      showMode: finalOptions.showMode,
      alignment: finalOptions.alignment,
      bottom: finalOptions.bottom,
      offset: finalOptions.offset,
      textColor: finalOptions.textColor,
      backgroundColor: finalOptions.backgroundColor,
      backgroundBlurStyle: finalOptions.backgroundBlurStyle,
      shadow: finalOptions.shadow,
    });
  }

  /**
   * 初始化 ToastOptions 参数
   * @param options 用户传入的选项
   * @param type 类型标识（0: 默认，1: 短时间，2: 长时间）
   * @returns 合并后的完整选项
   */
  private static initToastDefault(options: ToastOptions, type: number): ToastOptions {
    const defaultDuration =
      type === 1 ? ToastUtil.defaultConfig.duration_short :
        type === 2 ? ToastUtil.defaultConfig.duration_long :
        ToastUtil.defaultConfig.duration;

    return {
      duration: options.duration ?? defaultDuration,
      showMode: options.showMode ?? ToastUtil.defaultConfig.showMode,
      alignment: options.alignment ?? ToastUtil.defaultConfig.alignment,
      bottom: options.bottom ?? ToastUtil.defaultConfig.bottom,
      offset: options.offset ?? ToastUtil.defaultConfig.offset,
      textColor: options.textColor ?? ToastUtil.defaultConfig.textColor,
      backgroundColor: options.backgroundColor ?? ToastUtil.defaultConfig.backgroundColor,
      backgroundBlurStyle: options.backgroundBlurStyle ?? ToastUtil.defaultConfig.backgroundBlurStyle,
      shadow: options.shadow ?? ToastUtil.defaultConfig.shadow,
    };
  }
}

代码如下：

TypeScript 复制代码 
import promptAction from '@ohos.promptAction';

/**
 * TODO Toast默认样式参数
 * author: 鸿蒙布道师
 * since: 2025/04/02
 */
export class ToastConfig {
  duration: number = 2000; // 显示时长(1500ms-10000ms)
  duration_short: number = 1500; // 显示时长(1500ms)
  duration_long: number = 10000; // 显示时长(10000ms)
  showMode: promptAction.ToastShowMode = promptAction.ToastShowMode.DEFAULT; // 是否显示在应用之上
  alignment?: Alignment; // 对齐方式，默认值：undefined，默认底部偏上位置
  bottom: string | number = '80vp'; // 设置弹窗底部边框距离导航条的高度
  offset: Offset = { dx: 0, dy: 0 }; // 在对齐方式上的偏移，默认值：{dx:0, dy:0}
  textColor: ResourceColor = Color.White; // 文本提示框文本颜色，默认值：Color.Black
  backgroundColor: ResourceColor = '#CC000000'; // 文本提示框背板颜色，默认值：Color.Transparent
  backgroundBlurStyle: BlurStyle = BlurStyle.NONE; // 文本提示框背板模糊材质，默认值：BlurStyle.COMPONENT_ULTRA_THICK
  shadow: ShadowOptions | ShadowStyle = ShadowStyle.OUTER_DEFAULT_MD; // 文本提示框背板阴影，默认值：ShadowStyle.OUTER_DEFAULT_MD
}

/**
 * TODO Toast基本参数类
 * author: 鸿蒙布道师
 * since: 2025/04/02
 */
export class ToastOptions {
  duration?: number; // 显示时长(1500ms-10000ms)
  showMode?: promptAction.ToastShowMode; // 是否显示在应用之上
  alignment?: Alignment; // 对齐方式，默认值：undefined，默认底部偏上位置
  bottom?: string | number; // 设置弹窗底部边框距离导航条的高度
  offset?: Offset; // 在对齐方式上的偏移，默认值：{dx:0, dy:0}
  textColor?: ResourceColor; // 文本提示框文本颜色，默认值：Color.Black
  backgroundColor?: ResourceColor; // 文本提示框背板颜色，默认值：Color.Transparent
  backgroundBlurStyle?: BlurStyle; // 文本提示框背板模糊材质，默认值：BlurStyle.COMPONENT_ULTRA_THICK
  shadow?: ShadowOptions | ShadowStyle; // 文本提示框背板阴影，默认值：ShadowStyle.OUTER_DEFAULT_MD
}

/**
 * TODO 土司工具类
 * author: 鸿蒙布道师
 * since: 2025/04/02
 */
export class ToastUtil {
  private static defaultConfig: ToastConfig = new ToastConfig(); // 默认样式

  /**
   * 设置默认统一样式
   * @param configs 回调函数，用于修改默认配置
   */
  static setDefaultConfig(configs: (config: ToastConfig) => void): void {
    configs(ToastUtil.defaultConfig);
  }

  /**
   * 弹出土司，默认时长为2s，距离底部默认为80vp
   * @param message 提示消息
   * @param options 可选参数（显示时长、距离屏幕底部的位置、是否显示在应用之上等）
   */
  static showToast(message: string | Resource, options: ToastOptions = {}): void {
    ToastUtil.show(message, options, 0);
  }

  /**
   * 弹出土司，时长为1.5s，距离底部默认为80vp
   * @param message 提示消息
   * @param options 可选参数（距离屏幕底部的位置、是否显示在应用之上等）
   */
  static showShort(message: string | Resource, options: ToastOptions = {}): void {
    ToastUtil.show(message, options, 1);
  }

  /**
   * 弹出土司，时长为10s，距离底部默认为80vp
   * @param message 提示消息
   * @param options 可选参数（距离屏幕底部的位置、是否显示在应用之上等）
   */
  static showLong(message: string | Resource, options: ToastOptions = {}): void {
    ToastUtil.show(message, options, 2);
  }

  /**
   * 内部方法：统一处理 Toast 的显示逻辑
   * @param message 提示消息
   * @param options 可选参数
   * @param type 类型标识（0: 默认，1: 短时间，2: 长时间）
   */
  private static show(message: string | Resource, options: ToastOptions, type: number): void {
    if (!message || (typeof message === 'string' && message.trim() === '')) {
      console.warn('ToastUtil: Empty or invalid message provided.');
      return;
    }

    const finalOptions = ToastUtil.initToastDefault(options, type);

    promptAction.showToast({
      message,
      duration: finalOptions.duration,
      showMode: finalOptions.showMode,
      alignment: finalOptions.alignment,
      bottom: finalOptions.bottom,
      offset: finalOptions.offset,
      textColor: finalOptions.textColor,
      backgroundColor: finalOptions.backgroundColor,
      backgroundBlurStyle: finalOptions.backgroundBlurStyle,
      shadow: finalOptions.shadow,
    });
  }

  /**
   * 初始化 ToastOptions 参数
   * @param options 用户传入的选项
   * @param type 类型标识（0: 默认，1: 短时间，2: 长时间）
   * @returns 合并后的完整选项
   */
  private static initToastDefault(options: ToastOptions, type: number): ToastOptions {
    const defaultDuration =
      type === 1 ? ToastUtil.defaultConfig.duration_short :
        type === 2 ? ToastUtil.defaultConfig.duration_long :
        ToastUtil.defaultConfig.duration;

    return {
      duration: options.duration ?? defaultDuration,
      showMode: options.showMode ?? ToastUtil.defaultConfig.showMode,
      alignment: options.alignment ?? ToastUtil.defaultConfig.alignment,
      bottom: options.bottom ?? ToastUtil.defaultConfig.bottom,
      offset: options.offset ?? ToastUtil.defaultConfig.offset,
      textColor: options.textColor ?? ToastUtil.defaultConfig.textColor,
      backgroundColor: options.backgroundColor ?? ToastUtil.defaultConfig.backgroundColor,
      backgroundBlurStyle: options.backgroundBlurStyle ?? ToastUtil.defaultConfig.backgroundBlurStyle,
      shadow: options.shadow ?? ToastUtil.defaultConfig.shadow,
    };
  }
}
相关推荐
石山岭11 小时前
自己动手写了一个 Android 虚拟定位 App：GPSSimulate 技术实
android·前端
杉氧13 小时前
副作用 (Side Effects) 全攻略：如何像大师一样掌控 Composable 的生命周期？
android·架构·android jetpack
ONEDAY17 小时前
HarmonyOS 深色模式适配实践：从资源、WebView 到网络图统一处理
harmonyos
Kapaseker18 小时前
Kotlin Toolchain 0.11 发布：主要是把 Amper 干没了
android·kotlin
三少爷的鞋19 小时前
Android 现代架构不需要事件总线进阶篇
android
杉氧1 天前
深入理解 Compose 重组机制：快照系统如何驱动 UI 精准刷新？
android·架构·android jetpack
召钱熏1 天前
状态枚举正确≠渲染正确：一个语音按钮的状态机边界修复实录
android·前端
杉氧1 天前
深度解析：Jetpack Compose 核心架构与底层原理 —— 十年安卓老兵的“破茧重生”
android·架构·android jetpack
通玄1 天前
Jetpack Compose 入门系列（七）：ViewModel 与界面状态管理
android
落魄Android在线炒饭1 天前
Android Framework 开发技巧：android.jar 生成与系统快速编译验证
android
热门推荐
012026 年 AI 编程工具终极横评：Cursor vs Claude Code vs Copilot vs Windsurf022026年6月AI大模型全景报告：GPT-5.6、Claude Opus 4.8、Gemini 3.5，中美AI三足鼎立谁主沉浮？032026年6月AI行业全景：从百模大战到Agent元年，这30天发生了什么？04GitHub 镜像站点05Trae国际版与国内版深度测评：AI原生IDE的双生花06飞书长连接_事件订阅（接收消息，审批任务状态变更）07【AI】2026 年具身智能模型和世界模型总结08Claude Code、Codex、Cursor三分天下：2026年AI编程Agent生态全景剖析092026 AI 编程工具终极实战指南：Cursor vs Claude Code vs Copilot，开发者该怎么选？102026年AI架构实战：彻底解决OpenAI接口超时与封号，Python调用GPT-5.2/Sora2企业级架构详解（附源码+压测报告）