ryansimon / informer Goto Github PK

Handle Android network errors with elegance

License: Apache License 2.0

Java 100.00%

android-library android-ui error-handler networking

informer's Introduction

Informer

Handle network errors with elegance by providing users with error messages they can interact with. Use a simple API for showing inline and Snackbar messages to give network errors consistency across your app.

Usage

Setting up Informer is pretty straightforward. Check out the sample app for setup.

Configure

Make sure you reference jitpack.io in your root build.gradle file

allprojects {
    repositories {
        ...
        maven { url "https://jitpack.io" }
    }
}

Then add Informer to your dependencies

dependencies {
    compile 'com.github.ryansimon:informer:1.0.1'
}

Todo

Add additional examples and more thorough documentation.

License

Copyright 2016 Ryan Simon

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.

informer's People

Contributors

Stargazers

Watchers

Forkers

tonykazanjian

informer's Issues

colorPrimary should not be used for the default action button colors

Looking at the Snackbar Material Design specs, though not explicitly noted, it seems the Snackbar action button text color should be using colorAccent instead of colorPrimary.

NetworkErrorMessage Snackbar and Inline should have an option to globally set actionTextColor

Currently, you can set an actionTextColor override for the Snackbar and Inline error messages, but this has to be done on each instance of the Snackbar and Inline messages.

There should be a way to globally set a default for developers that want consistency across their app, and don't want to use the libraries default usage of colorAccent

Investigate the feasibility of adding a feature that allows developers to test the error callbacks without having to use real errors from the server

Add ability to have padding/margin added by default to the inline error layout

The "No Internet Connection" error action button doesn't send user to WiFi settings on Nougat

NetworkErrorHandler should have a flag to prevent it from being automatically dismissed when the action button is clicked

Just as a sample, the current configuration for action buttons is like this

private static void configureNoNetworkView(@NonNull final Context context,
                                               @NonNull final TextView errorMessage,
                                               @NonNull final TextView actionButton,
                                               @NonNull final NetworkErrorHandler networkErrorHandler) {
        errorMessage.setText(networkErrorHandler.mNoInternetText);
        actionButton.setText(networkErrorHandler.mNoInternetActionText);
        actionButton.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                context.startActivity(new Intent(Settings.ACTION_WIFI_SETTINGS));
                networkErrorHandler.dismiss();
            }
        });
    }

I propose a flag on the builder called autoDismissMsgOnActionClick with a default value of false. Which would revise the above code like so

private static void configureNoNetworkView(@NonNull final Context context,
                                               @NonNull final TextView errorMessage,
                                               @NonNull final TextView actionButton,
                                               @NonNull final NetworkErrorHandler networkErrorHandler) {
        errorMessage.setText(networkErrorHandler.mNoInternetText);
        actionButton.setText(networkErrorHandler.mNoInternetActionText);
        actionButton.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                context.startActivity(new Intent(Settings.ACTION_WIFI_SETTINGS));
                if(autoDismissMsgOnActionClick) networkErrorHandler.dismiss();
            }
        });
    }

The builder method would look like this

public Builder autoDismissMsgOnActionClick(boolean autoDismissMsgOnActionClick) {
            mAutoDismissMsgOnActionClick= autoDismissMsgOnActionClick;
            return this;
        }

This would solve for the use case where the user clicks the action button, but returns to the app with no changes. This is most apparent when shutting internet connection off, clicking the action button to go to wifi settings, and then coming back to the app without having turned the wifi on.

The network message is gone, and the screen is left blank. Though it's solvable by running the network code onResume again, it's a bit inconvenient.