OneTapCompose使用指南

OneTapCompose使用指南

OneTapComposeThis library allow you to easily integrate One-Tap Sign in with Google in your project with Jetpack Compose. It keeps away all the boilerplate code.项目地址:https://gitcode.com/gh_mirrors/on/OneTapCompose

---

项目介绍

OneTapCompose 是一个致力于简化 Google 单击登录集成过程的库，专为 Jetpack Compose 设计。通过这个库，开发者能够轻松地在他们的应用中添加 Google 的凭证管理器功能，而无需处理复杂的设置和逻辑。它隐藏了所有的样板代码，并提供了一个简洁的 API 来获取基本的用户信息，包括一个新的 OneTapGoogleButton 可组合项，允许高度定制。为了保证用户体验，开发者应自己实现对 One Tap 登录提示的速率限制，以防止因连续取消导致的 24 小时内不再提示的问题。

---

项目快速启动

添加依赖

首先，在你的模块级 build.gradle 文件中加入以下依赖：

dependencies {
    implementation("com.github.stevdza-san:OneTapCompose:1.0.14")
}

// 确保已在settings.gradle文件中添加了JitPack仓库
dependencyResolutionManagement {
    repositories {
        maven { url 'https://jitpack.io' }
    }
}

配置与调用

1. 在 Google Cloud Platform 上创建一个新的项目，并获得OAuth客户端ID（同时需涵盖Android和Web）。
2. 在你的 Kotlin 代码中，使用 rememberOneTapSignInState 来管理状态，并调用 OneTapSignInWithGoogle() 函数配置单击登录：

import com.stevdza_san.onetapcompose.*

val state = rememberOneTapSignInState()
OneTapSignInWithGoogle(
    state = state,
    clientId = "YOUR_CLIENT_ID", // 替换为你的Client ID
    onTokenIdReceived = { tokenId ->
        Log.d("LOG", tokenId)
    },
    onDialogDismissed = { message ->
        Log.d("LOG", message)
    }
)

// 触发One-Tap对话框
Button(onClick = { state.open() }) {
    Text(text = "立即登录")
}

---

应用案例与最佳实践

• 个性化登录界面：利用 OneTapGoogleButton 的自定义属性，调整按钮样式以匹配应用的UI设计语言。
• 用户体验优化：实施合理的触发策略，避免在短时间内频繁向用户显示登录提示，提升用户体验。
• 错误处理：合理捕获并处理 onDialogDismissed 中的反馈，为用户提供清晰的错误信息或引导。

---

典型生态项目结合示例

虽然OneTapCompose专注于Jetpack Compose环境下的Google登录，其与其他技术栈的结合并不直接在本库内体现。然而，该库可以很容易地被任何基于Jetpack Compose构建的应用所采纳，特别是在那些寻求快速、无缝的Google登录体验的社交应用、云同步工具或者任何需要用户认证的现代化Android应用程序中。

例如，你可以在一个使用Compose构建的博客阅读应用中，利用OneTapCompose轻松添加一键登录功能，从而加速用户的账户注册与登录流程，提高用户体验。

---

此文档提供了快速入门OneTapCompose的基本步骤和一些实践建议，帮助开发者高效地将Google的单击登录服务集成到他们使用Jetpack Compose构建的应用中。

OneTapComposeThis library allow you to easily integrate One-Tap Sign in with Google in your project with Jetpack Compose. It keeps away all the boilerplate code.项目地址:https://gitcode.com/gh_mirrors/on/OneTapCompose