auth-ui

Android App Auth Template(Login, Signup and Forgot Password) UI

Description

Utility for Android App Auth(Login, Signup and Forgot Password) UI

Programming language: Java

Tags: UI     Template     Utility     Android-library     Login     Signup     Customization    

README

auth-ui

Android App Auth(Login, Signup and Forgot Password) UI

You can find Kotlin Version for this library here

What's in the box

• The login, signup and forgot password UI Template for your app
• Easy way to implement
• Play with element visibility
• Setup material theme like Teal, Cyan, Indigo and many more.
• Hide and Show social logins.

<!-- --> <!----> <!----> <!---->

<!---->

<!---->

Basic Form	Signup without Social Platforms	Login without Social Platforms

Themes

CYAN	TEAL	WHITE/DEFAULT

Setup

1. Include in your project

Using Gradle

The Auth UI library is pushed to jcenter, so you need to add the following dependency to your app's build.gradle.

compile 'com.sayagodshala:auth-ui:1.0'

As a module

If you can't include it as gradle dependency, you can also download this GitHub repo and copy the auth-ui folder to your project.

2. Usage

First step in configuring the Auth UI Framework is to place FrameLayout Container in your layout.

<FrameLayout
        android:id="@+id/frame"
        android:layout_width="match_parent"
        android:layout_height="match_parent"/>

Next step is to configure the AuthUISettings.

Example:

AuthUISettings authUISettings = new AuthUISettings();
authUISettings.setSocialPlatformRequired(true);
authUISettings.setAppLogoRequired(true);
authUISettings.setTermsRequired(true);
authUISettings.setSignupRequired(true);
authUISettings.setFacebookLoginRequired(true);
authUISettings.setGoogleLoginRequired(true);
authUISettings.setForgotPasswordRequired(true);
authUISettings.setAppLogo(R.mipmap.my_logo);
authUISettings.setLoginTitle("Login using your registered email and password.");
authUISettings.setSignupTitle("You are just few steps a head. Register and start a head.");
authUISettings.setForgotPasswordTitle("Put in your email id for password reset link");
authUISettings.setLoginTerms("By Logging in I agree to the <b>Terms of Use</b>");
authUISettings.setSignupTerms("By Signing up I agree to the <b>Terms of Use</b>");
authUISettings.setFacebookLoginTitle("Login with Facebook");
authUISettings.setFacebookSignupTitle("Signup with Facebook");
authUISettings.setGoogleLoginTitle("Login with Google");
authUISettings.setGoogleSignupTitle("Signup with Google");
authUISettings.setLoginToggleTitle("Have an account? <b>LOGIN</b>");
authUISettings.setSignupToggleTitle("Don\'t have an account? <b>SIGN UP</b>");
authUISettings.setDefaultView(AuthUIView.LOGIN);
authUISettings.setMaterialTheme(MaterialTheme.CYAN);

Next step is to load the AuthUIFragment in your Activity.

// declare instance of AuthUIFragment
AuthUIFragment authUIFragment;
// load fragment with your own settings or default settings
authUIFragment = AuthUIFragment.newInstance(authUISettings);
**OR**
authUIFragment = AuthUIFragment.newInstanceWithDefaultSettings();

// load authUIFragment into the frame layout
AuthUIFragment.loadFragment(this, authUIFragment, R.id.frame);

Final step is to implement AuthUIFragment.AuthUIFragmentListener interface in your target activity where AuthUIFragment is loaded with corresponding methods.

public class LoginActivity extends AppCompatActivity implements AuthUIFragmentListener {

    @Override
    public void onLoginClicked(AuthUIUser user) {
        switch (user.getLoginType()) {
            case EMAIL:
                Log.d("onLoginClicked", "email : " + user.getEmail() + ", password : " + user.getPassword());
                break;
            case MOBILE:
                Log.d("onLoginClicked", "mobile : " + user.getMobile() + ", password : " + user.getPassword());
                break;
            case EMAIL_OR_MOBILE:
                Log.d("onLoginClicked", "email/mobile : " + user.getEmailOrMobile() + ", password : " + user.getPassword());
                break;
        }
    }

    @Override
    public void onSignupClicked(AuthUIUser user) {
        Log.d("onSignupClicked", "name : " + user.getName() + ", email : " + user.getEmail() + ", mobile : " + user.getMobile() + ", password : " + user.getPassword());
    }

    @Override
    public void onForgotPasswordClicked(AuthUIUser user) {
        Log.d("onForgotPasswordClicked", "email : " + user.getEmail());
        // on successful response of 'forgot password api' call below method to show login view again
        authUIFragment.recallLoginView();
    }

    @Override
    public void onSocialAccountClicked(SocialAccount socialAccount, boolean isRegistration) {
        Log.d("onSocialAccountClicked", "socialAccount : " + socialAccount.name() + ", isRegistration : " + isRegistration);
        switch (socialAccount) {
            case FACEBOOK:
                break;
            case GOOGLE:
                break;
        }
    }

    @Override
    public void onFormValidationError(String error) {
        Log.d("onFormValidationError", "error : " + error);
    }

}

This is the simplest way to configure the library to enable Custom login mode along with Social Platform login modes.

That's it!

More about AuthUISettings

Login Types(EMAIL,MOBILE and EMAIL_OR_MOBILE). Default login type is EMAIL.

authUISettings.setLoginType(LoginType.EMAIL);
**OR**
authUISettings.setLoginType(LoginType.MOBILE);
**OR**
authUISettings.setLoginType(LoginType.EMAIL_OR_MOBILE);

To hide social platforms use below code

authUISettings.setSocialPlatformRequired(false);

To hide App logo

authUISettings.setAppLogoRequired(false);

In case your app only requires login

authUISettings.setSignupRequired(false);

In case your app only requires one of the below

authUISettings.setFacebookLoginRequired(false);
**OR**
authUISettings.setGoogleLoginRequired(false);

In case you want to handle the form validation error message

authUISettings.setHandleFormError(true);
// once it is set to true, implement your logic in 'onFormValidationError(String message)' method of AuthUIFragmentListener interface

In case your app doesn't require forgot password

authUISettings.setForgotPasswordRequired(true);

Set your default view

authUISettings.setDefaultView(AuthUIView.LOGIN);
**OR**
authUISettings.setDefaultView(AuthUIView.SIGNUP);

Supported Themes (Default Theme is WHITE)

authUISettings.setMaterialTheme(MaterialTheme.DEFAULT);
**OR**
authUISettings.setMaterialTheme(MaterialTheme.WHITE);
**OR**
authUISettings.setMaterialTheme(MaterialTheme.RED);

and many more like PINK,PURPLE,DEEP_PURPLE,INDIGO,BLUE,LIGHT_BLUE,CYAN,TEAL,BLUE_GREY,YELLOW,AMBER,BROWN,GREEN and GREY.

Included Libraries

The following third-party libraries were used in this framework.

• GSON library

Contribution

All contributions are welcome. Encounter any issue? Don't hesitate to open an issue

Convention: Master branch would be the development branch. So feel free to fork from the Master branch.

License

Copyright 2017 Codelight Studios

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.