WhatsNew开源项目教程

WhatsNew开源项目教程

WhatsNew🎉 WhatsNew automatically displays a short description of the new features when users update your app项目地址:https://gitcode.com/gh_mirrors/wha/WhatsNew

---

项目介绍

WhatsNew 是一个轻量级的 Android 库，旨在帮助开发者优雅地展示应用程序的新增功能或更新说明。通过自定义视图，它可以让你以吸引用户注意力的方式展示每次应用更新时的重要变化点，提升用户体验。项目由 TonnyL 开发并维护，在 GitHub 上托管，地址为 https://github.com/TonnyL/WhatsNew。

项目快速启动

要快速启动并运行 WhatsNew，首先确保你的开发环境已配置好 Android Studio 和必要的 SDK。接下来，按照以下步骤操作：

添加依赖

在你的 build.gradle(Module: app) 文件中的 dependencies 部分添加 WhatsNew 的依赖：

dependencies {
    implementation 'com.tonyielim.whatsnew:whatsnew:$latestVersion'
}

这里的 $latestVersion 需要替换为实际的最新版本号，你可以在项目的Release页面找到最新的版本。

初始化并显示 WhatsNew 页面

在你需要展示新功能介绍的地方调用以下代码示例：

val whatsNewDialog = WhatsNew.Builder(this)
    .setPages(
        WhatsNewPage.Builder()
            .setTitle("版本 1.0")
            .setDescription("我们加入了夜间模式!")
            .setImage(R.drawable.ic_night_mode)
            .build(),
        WhatsNewPage.Builder()
            .setTitle("版本 1.1")
            .setDescription("提升了性能，让浏览更流畅。")
            .build()
    )
    .isAnimated(true)
    .showSkipButton(true)
    .finishOnTouchOutside(true)
    .build()

whatsNewDialog.show(supportFragmentManager, "TAG")

这段代码创建了一个包含两个页面的新功能对话框，展示了两个版本的更新信息，并设置了动画效果、跳过按钮等。

应用案例和最佳实践

在应用中集成 WhatsNew 时，最佳实践包括：

• 适时展示：选择恰当的时机展示 WhatsNew，比如应用升级后首次打开。
• 个性化设计：利用库提供的定制能力，使界面与应用的整体风格一致。
• 简洁明了：保持新特性描述简短清晰，避免信息过载。
• 交互性：通过动画和其他交互元素增加用户的参与度。

典型生态项目

虽然 WhatsNew 本身专注于提供更新提示功能，但其可以与其他 Android 生态系统中的组件结合使用，如：

• Firebase Remote Config: 动态控制是否显示 WhatsNew，以及展示的内容，根据不同版本或用户群体定制体验。
• Glide 或 Picasso: 用于加载更新说明页的图片资源，提高图片加载效率和用户体验。
• SharedPreferences: 存储用户是否已经查看过特定版本的标记，避免重复展示。

通过这样的整合，你可以构建出更加丰富和个性化的应用更新体验。

---

此教程提供了基本的指导来帮助你快速上手WhatsNew库。记得查阅项目GitHub页面获取最新的文档和详细信息，以便深入学习和定制。

WhatsNew🎉 WhatsNew automatically displays a short description of the new features when users update your app项目地址:https://gitcode.com/gh_mirrors/wha/WhatsNew