LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright [yyyy] [name of copyright owner]
+   Copyright 2020 Lars Werkman
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

README.md

@@ -1,3 +1,70 @@
-# SkeletonLoading
+# SkeletonLoading 
 
-A simple library to add Skeleton-loading animations to existing layouts and screens.
+[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.larswerkman/skeletonloading/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.larswerkman/skeletonloading/)
+
+
+A simple way to add Drawable based skeleton loading to your Android app.
+
+* Completely compatible with your current layout
+* No custom TextViews or any other views needed.
+* Lifecycle aware
+* Easily extendable
+* Build in Kotlin!
+
+ 
+ 
+
+![](docs/static/example_light.gif) 
+![](docs/static/example_dark.gif)
+
+## Example
+
+```kotlin
+class MainActivity : Activity() {
+
+    override fun onCreate(savedInstanceState: Bundle?) {
+        super.onCreate(savedInstanceState)
+        setContentView(R.layout.activity_main)
+
+        val loading = SkeletonLoading(
+            getDrawable(R.drawable.skeleton)!!,
+            AlphaAnimation(.1f, .6f)
+        )
+
+        loading.register(this)
+
+        val binder = loading.create {
+            sample_text_view.skeleton(SkeletonTextView.TextWidth.LINES, 1.2).bind()
+        }
+
+        binder.show()
+    }
+}
+```
+
+## Download
+```groovy
+dependencies {
+    implementation 'com.larswerkman:skeletonloading:0.0.7'
+    implementation 'com.larswerkman:skeletonloading-views:0.0.7'
+    implementation 'com.larswerkman:skeletonloading-animations:0.0.7'
+}
+```
+
+## License
+
+```text
+Copyright 2020 Lars Werkman
+
+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.
+```

build.gradle

@@ -15,7 +15,7 @@ buildscript {
 
     }
     dependencies {
-        classpath 'com.android.tools.build:gradle:3.6.3'
+        classpath 'com.android.tools.build:gradle:4.0.0'
         classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:${versions.kotlin}"
         classpath "com.vanniktech:gradle-maven-publish-plugin:0.11.1"
     }

gradle.properties

@@ -1,5 +1,5 @@
 GROUP=com.larswerkman
-VERSION_NAME=0.0.5
+VERSION_NAME=0.0.8-SNAPSHOT
 
 POM_DESCRIPTION=Skeleton loading for Android views.
 

gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,6 @@
-#Thu Jan 02 22:35:21 CET 2020
+#Wed Jun 17 10:58:11 CEST 2020
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-5.6.4-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-6.1.1-all.zip

sample/build.gradle

@@ -33,7 +33,7 @@ dependencies {
     implementation fileTree(dir: 'libs', include: ['*.jar'])
     implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:${versions.kotlin}"
     implementation 'androidx.appcompat:appcompat:1.1.0'
-    implementation 'androidx.core:core-ktx:1.2.0'
+    implementation 'androidx.core:core-ktx:1.3.0'
     implementation 'androidx.constraintlayout:constraintlayout:1.1.3'
 
     implementation project(path: ':skeletonloading')

sample/src/main/java/com/larswerkman/skeletonloading/sample/MainActivity.kt

@@ -10,19 +10,19 @@ import kotlinx.android.synthetic.main.activity_main.*
 
 class MainActivity : AppCompatActivity() {
 
-    private lateinit var loading: SkeletonLoading
-
     override fun onCreate(savedInstanceState: Bundle?) {
         super.onCreate(savedInstanceState)
         setContentView(R.layout.activity_main)
 
-        loading = SkeletonLoading(this, R.drawable.skeleton, AlphaAnimation(.1f, .6f))
+        val loading = SkeletonLoading(
+            getDrawable(R.drawable.skeleton)!!,
+            AlphaAnimation(.1f, .6f)
+        )
+
         loading.register(this)
 
         val binder = loading.create {
-            bind(sample_text_view.skeleton(SkeletonTextView.TextWidth.LINES, 1.2))
-            bind(sample_view.skeleton(8F))
-            bind(sample_image_view.skeleton(8F))
+            sample_text_view.skeleton(SkeletonTextView.TextWidth.LINES, 1.2).bind()
         }
 
         sample_text_view.setOnClickListener {

skeletonloading-animations/src/main/java/com/larswerkman/skeletonloading/animations/AlphaAnimation.kt

@@ -7,14 +7,25 @@ import com.larswerkman.skeletonloading.SkeletonAnimation
 import java.util.concurrent.TimeUnit
 import kotlin.math.roundToInt
 
+/**
+ * Animates the skeleton loading drawables alpha value.
+ *
+ * @param start value between 0 ... 1 to which it will animate from
+ * @param end value between 1 ... 0 to which it will animate to
+ * @param duration pair denoting the duration of the animation
+ * @param interpolator defines the rate of change of the animation
+ * @param repeat if the animation should repeat forever
+ */
 class AlphaAnimation(
     @FloatRange(from = 0.0, to = 1.0) start: Float,
     @FloatRange(from = 0.0, to = 1.0) end: Float,
     duration: Pair<Long, TimeUnit> = Pair(1, TimeUnit.SECONDS),
     interpolator: TimeInterpolator? = null,
     repeat: Boolean = true
 ) : SkeletonAnimation(start, end, duration, interpolator, repeat) {
+
     override fun animate(drawable: Drawable, progress: Float) {
         drawable.alpha = (progress * 255f).roundToInt()
     }
+
 }

skeletonloading-views/build.gradle

@@ -21,7 +21,7 @@ android {
 
 dependencies {
     api "org.jetbrains.kotlin:kotlin-stdlib-jdk7:${versions.kotlin}"
-    api 'androidx.core:core-ktx:1.2.0'
+    api 'androidx.core:core-ktx:1.3.0'
     api project(path: ':skeletonloading')
 }
 

skeletonloading-views/src/main/java/com/larswerkman/views/SkeletonImageView.kt

@@ -6,16 +6,31 @@ import com.larswerkman.skeletonloading.ISkeletonView
 import com.larswerkman.skeletonloading.SkeletonAnimation
 import com.larswerkman.views.internal.RoundedDrawableWrapper
 
+/**
+ * Convenient method of creating a [SkeletonImageView] instance for a [ImageView]
+ *
+ * @param radius extra radius that can be added to the skeleton drawable
+ */
 fun ImageView.skeleton(radius: Float = 0F): ISkeletonView {
     return SkeletonImageView(this, radius)
 }
 
+/**
+ * Basic skeleton implementation for [ImageView]'s
+ *
+ * @param view to be put in a loading state
+ * @param radius extra radius that can be added to the skeleton drawable
+ */
 class SkeletonImageView(
     private val view: ImageView,
     private val radius: Float = 0F
 ) : ISkeletonView {
 
     private lateinit var drawable: Drawable
+
+    /**
+     * state of the [ImageView] before the loading state is shown.
+     */
     private var image: Drawable? = null
 
     override fun setup(drawable: Drawable) {