# DialogHub

**Repository Path**: hongyu/dialoghub

## Basic Information

- **Project Name**: DialogHub
- **Description**: HarmonyOS通用弹窗解决方案
- **Primary Language**: TypeScript
- **License**: Apache-2.0
- **Default Branch**: dev
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 10
- **Created**: 2025-02-13
- **Last Updated**: 2025-02-13

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# DialogHub简介
DialogHub作为HarmonyOS的弹窗场景解决方案，聚焦解决应用内弹窗相关问题的场景实现。

DialogHub底层对系统OverlayManager和BindSheet进行封装，提供了页面级弹窗、键盘避让、弹窗生命周期管理、弹窗模板创建、全局弹窗生命周期管理等能力。

开发者在开发过程中无需关心底层实现，仅关心应用场景，根据场景选择不同类型弹窗即可。
# 特性
- 提供页面级弹窗能力，支持页面切换或导航时，自动隐藏旧页面的弹窗
- 提供弹窗管理能力（包含弹窗状态查询、弹窗生命周期监听、弹窗拦截）
- 支持通过链式调用的方式快速创建弹窗（提供Toast、Popup等多种类型的默认弹窗）
- 支持自定义弹窗模板能力（支持将弹窗内容、样式、行为、生命周期等配置属性保存至模板内）
- 支持多种配置属性（包含弹窗层级、手势透传、弹窗动画等）
- 支持弹窗显示过程中修改属性（包含弹窗内容、弹窗样式等）
# 依赖系统版本
- HarmonyOS 5.0.0 Release及以上
- 手机版本： Next.0.0.71及以上
# 项目版本信息
当前最新版本

| 名称               | 说明       | 版本号        | 发布状态 |
|------------------|----------|------------|-----|
| @hadss/DialogHub | 全局弹窗管理框架 | 1.0.0-rc.0 | 已发布 |
# 下载安装
## 使用ohpm安装依赖
````
ohpm install @hadss/dialoghub
````
# DialogHub框架使用说明
[查看说明](https://gitee.com/hadss/DialogHub/blob/dev/hadss_dialog/README.md)
# DialogHub接口和属性列表
[查看详情](https://gitee.com/hadss/dialoghub/blob/dev/docs/Reference.md)
# SampleCode
[Sample示例代码](https://gitee.com/hadss/DialogHubSample)
# FAQ
[查看详情](https://gitee.com/hadss/dialoghub/blob/dev/docs/FAQ.md)
# 原理介绍
本解决方案依赖HarmonyOS原生能力OverlayManager以及BindSheet。
# 贡献代码
使用过程中发现任何问题都可以提[Issue](https://gitee.com/hadss/dialoghub/issues)，当然，也非常欢迎发[PullRequest](https://gitee.com/hadss/dialoghub/pulls)参与共建。
# 约束与限制
- 本示例仅支持标准系统上运行，支持设备：华为手机。
- HarmonyOS系统： HarmonyOS 5.0.0 Release及以上。
- DevEco Studio版本：DevEco Studio 5.0.0 Release及以上。
- HarmonyOS SDK版本： HarmonyOS 5.0.0 Release SDK及以上。
# 开源协议
本项目基于[Apache License 2.0](https://gitee.com/hadss/dialoghub/blob/dev/LICENSE)，请自由享受和参与开源。