Skip to content

Latest commit

 

History

History
70 lines (61 loc) · 3.29 KB

PlaceholderView.md

File metadata and controls

70 lines (61 loc) · 3.29 KB
Raw

PlaceholderView

A view which you would inside a layout as a placeholder for showing some content which could take time to process and show. For example: Lets say you perform search on your data and then show the results inside a layout, if search returned zero results, this view can be used to describe it, instead of showing empty view. Other use cases would be to show failure messages for a long running operation, and many more.

Usage

Assuming you already have configured jitpack and added the dependency for this library in your project gradle files, simply add this in your layout to include it.

<com.corphish.widgets.ktx.PlaceholderView
       android:layout_width="wrap_content"
       android:layout_height="wrap_content"/>
Tip

To center this view in the layout, or to make it appear in the center of the screen, use RelativeLayout as parent, and then set the android:layout_centerInParent property of the PlaceholderView to true, as shown:

<RelativeLayout
    xmlns:android="http://schemas.android.com/apk/res/android"
    android:layout_width="match_parent"
    android:layout_height="match_parent">  
    
    <com.corphish.widgets.ktx.PlaceholderView
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:layout_centerInParent="true"/>

</RelativeLayout>

Properties Supported

  • app:titleText : Sets the title text.
  • app:descriptionText : Sets the description text.
  • app:animation : Raw resource id for the lottie animation.
  • app:animationLooped : Boolean indicating whether animation must be looped or not.
  • app:animationScaleType : Scale type of the animation view.
  • app:animationWidth : Animation width.
  • app:animationHeight : Animation height.
  • app:titleSize : Sets the text size of title. Default is 18sp.
  • app:descriptionSize : Sets the text size of description. Default is 12sp.
  • app:titleStyle : Sets the text style of title.
  • app:descriptionStyle : Sets the text style of description.

Methods

Most of the methods are used up by properties. See the source file for reference. Additionally there are getTitleTextView(), getDescriptionTextView() and getAnimationView() methods which return the respective TextViews and AppCompatImageViews, on which you can do other actions that it supports.

Screenshot

Code
<?xml version="1.0" encoding="utf-8"?>
<RelativeLayout
    xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    xmlns:tools="http://schemas.android.com/tools"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    tools:context="com.corphish.keyvalueviewtest.MainActivity">  
    

    <com.corphish.widgets.ktx.PlaceholderView
        android:layout_margin="4dp"
        app:titleText="Nothing here"
        app:descriptionText="But John Cena! He could be here"
        app:titleStyle="bold"
        app:titleSize="20sp"
        app:animation="@raw/empty"
        app:descriptionSize="14sp"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:layout_centerInParent="true"/>

</RelativeLayout>