whitecloakph / statelayout

A flexible, easy to use, all in one state layout library.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Statelayout

A flexible, easy to use, all in one state layout library.

Setup

Using Gradle

compile 'com.whitecloak.statelayout:statelayout:0.1.1@aar'

Using Maven

<dependency>
  <groupId>com.whitecloak.statelayout</groupId>
  <artifactId>statelayout</artifactId>
  <version>0.1.5</version>
  <type>pom</type>
</dependency>

A quick overview:

  • Loading / Content / Error / Empty
  • Error / Empty Click Listener
  • Define custom layout
  • Define custom view by id
  • More to come...

How to use

Using XML

<com.whitecloak.statelayout.StateLayout
    android:id="@+id/state_layout"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    app:contentView="@+id/recycler_view"
    app:layout_behavior="@string/appbar_scrolling_view_behavior">

    <android.support.v7.widget.RecyclerView
        android:id="@+id/recycler_view"
        android:layout_width="match_parent"
        android:layout_height="match_parent" />

</com.whitecloak.statelayout.StateLayout>

Switching State

Set state to nothing

mStateLayout.showNothing();

Set state to loading

mStateLayout.showLoading();

Set state to content

mStateLayout.showContent();

Set state to error

mStateLayout.showError();

Set state to error with message

mStateLayout.showError("Something wen't wrong");

Set state to empty

mStateLayout.showEmpty();

Set state to empty with error

mStateLayout.showEmpty("No content found");

Listeners

Add action/click listener when state is empty or error

Set error listener

stateLayout.setErrorListener(new StateLayout.ActionListener() {
    @Override
    public void onAction() {
        // DO SOMETHING
    }
});

Set empty listener

stateLayout.setEmptyListener(new StateLayout.ActionListener() {
    @Override
    public void onAction() {
        // DO SOMETHING
    }
});

Set Error or Empty listener

stateLayout.setErrorEmptyListener(new StateLayout.ActionListener() {
    @Override
    public void onAction() {
        // DO SOMETHING
    }
});

License

Copyright 2017 White Cloak Technologies, Inc

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.

About

A flexible, easy to use, all in one state layout library.

License:Apache License 2.0


Languages

Language:Java 100.0%