A wrapper view for your layout's different loading states

Loading Layout for Android

Loading layout is a container view that manages easy switching between loading, completed and other states of your screen with a single line. It takes away the boilerplate of setting view.setVisibility on all your various views when the state of your screen transitions between loading/loading overlay/ completed/error/empty states.

Usage

1. Add it to your XML layout and add in your various layouts as direct children of LoadingLayout.
2. Make sure to add in android:tag to your elements corresponding to what you'd like them to represent:

Your layout should end up looking something like this:

<com.valartech.loadinglayout.LoadingLayout
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        >

        <!--  Empty      -->
        <TextView
            android:tag="@string/ll_empty"            
            ...
            />

        <!--   Loading     -->
        <ProgressBar
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:layout_gravity="center"
            android:tag="@string/ll_loading" />

        <!--   Completed     -->
        <FrameLayout
            android:layout_width="match_parent"
            android:layout_height="match_parent"
            android:tag="@string/ll_complete">
          ...
        </FrameLayout>

        <!--    Error    -->
        <TextView
            android:layout_width="match_parent"
            android:layout_height="match_parent"
            android:tag="@string/ll_error"
            android:text="@string/error"
            />
    </com.valartech.loadinglayout.LoadingLayout>

3. And now chunks of code like this:

   loadingView?.visibility = View.VISIBLE
   completeView?.visibility = View.GONE
   emptyView?.visibility = View.GONE
   errorView?.visibility = View.GONE

can be replaced by loadingLayout.setState(LOADING)

Adding to your project

//in your project-level build.gradle
allprojects {
    repositories { //not under buildscript
        maven { url "https://jitpack.io" } 
    }
}

//in your app module's build.gradle
dependencies {
    implementation "com.valartech:loading-layout:${version}"
}

Custom XML attributes

Tips

• You're free to use a single view (like a ProgressBar) or a container of views(like a ConstraintLayout) as a child of the LoadingLayout.
• The LOADING_OVERLAY is a special state that shows the loading state over the completed state, with a tint applied over it. It also prevents button clicks from reaching the completed layout.
• Use tools:default_state to quickly check how different view states would look within your layout.

Caveat

This library does add in an extra view into your layout hierarchy, and would thus cause a slight hit in performance. We have not seen this be a noticeable issue in our apps even on complex views, but use as per your discretion on deeply nested layouts.

GitHub

https://github.com/valartech/loading-layout