Custom Google SignInButton

Additional

Language
Java
Version
2.0.0 (Jan 30, 2024)
Created
Sep 14, 2017
Updated
Jan 31, 2024
Owner
Shobhit Puri (shobhitpuri)
Contributors
Vadim Kotov (vkotovv)
Shobhit Puri (shobhitpuri)
Hanhan Husna (hahn)
Prakhar Shukla (imprakharshukla)
4
Activity
Badge
Generate
Download
Source code

Problem

You want to add a Google Sign-In button to your Android application. But you want to change the text on the Google Sign-In button or provide custom localization? You would think setting android:text on the com.google.android.gms.common.SignInButton in your layout file would do the trick. However it turns out that that attribute is not available for SignInButton.

Solution

This library helps you add text to Google Sign-In Button easily using standard android:text attribute. It also allows you to set the button theme to dark or light using app:isDarkTheme="true" attribute. It does so following Google's guidelines to create sign-in button.

Light Theme (White) Dark Theme (Blue)

Usage

Add the following to your app module level build.gradle file:

dependencies {
    implementation 'com.github.shobhitpuri:custom-google-signin-button:2.0.0'
}

Also, add the following in the top-level build.gradle file:

allprojects {
    repositories {
        google()
        maven { url "https://jitpack.io" }
        mavenCentral()
    }
}

In your XML Layout, have the following:

<RelativeLayout
    ...
    xmlns:app="http://schemas.android.com/apk/res-auto">

    <com.shobhitpuri.custombuttons.GoogleSignInButton
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:layout_centerInParent="true"
        android:text="@string/google_sign_up"
        app:isDarkTheme="true" />
</RelativeLayout>

Options

  • app:isDarkTheme="{Boolean}" : To switch between blue theme and gray white for the button. The library handles changing of text color and background color. It also handles the change of color on button press or button clicks.
  • android:text="{string}": As usual to set the text on the button.

(dirty) Solutions

On the Stackoverflow, there are obviously questions which have been asked for this issue. One of them is Can I edit the text of sign in button on Google? Many of them suggest using "hacks" like finding the first TextView in the button or finding any TextView in the button. The issue with them is they might stop working if Google updates the implementation.

Google's Suggestion

From documentation, Google suggests creating a custom button as mentioned on Customizing the Sign-In Button. Then it suggests using the branding guidelines as mentioned at Sign-In Branding Guidelines. It includes using custom icons and images int he button, setting text size to specifics, paddings and other do's and don'ts for the logo.

Doing as per Google's suggestion involves some custom work. This small 3.93 KB library does that for you. Please feel free to make pull requests to improve the library. I wanted to create a re-usable solution when I came across this problem while implementing the Sign-In button. Just wanted to share with everyone.

License

MIT License

Copyright (c) 2024 Shobhit Puri

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.