added doc for pinRecompose function

neophron88 · Jul 21, 2024 · 9378fab · 9378fab
1 parent 2bd5c7d
commit 9378fab
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 5 deletions.
diff --git a/pinview/build.gradle.kts b/pinview/build.gradle.kts
@@ -60,4 +60,8 @@ publishing {
             }
         }
     }
-}
+    repositories {
+        maven { url = uri("https://jitpack.io") }
+    }
+}
+
diff --git a/pinview/src/main/java/com/pulchukur/pinview/PinView.kt b/pinview/src/main/java/com/pulchukur/pinview/PinView.kt
@@ -208,7 +208,14 @@ class PinView @JvmOverloads constructor(
             handleInputSourceTextChange(pinsInputSource.text)
         }
     }
-
+    /**
+     *
+     * This method should be called when [pinItemLayout], [pinCount], [pinDecorationLayout] or [pinDecorationPositions] changed.
+     *
+     * Also when added new visual behavior by calling [pinAddVisualBehaviorProducer] function. Otherwise the changes will not be applied.
+     *
+     * Note, keep calling this function to a minimum, as it will reinflate pinview items if there are any changes.
+     */
     fun pinRecompose() {
         if (
             changeInfo.isPinItemLayoutChanged
@@ -258,8 +265,8 @@ class PinView @JvmOverloads constructor(
     private fun MutableList<VisualBehaviorProducer>.produceBehaviors(viewId: Int): List<EachItemTargetBehaviors> {
         return map { producer ->
             _pinItems.mapIndexed { position, itemRoot ->
-                val targetView = itemRoot.findViewById<View>(viewId)
-                    ?: error("View with such id not found")
+                val targetView: View? = itemRoot.findViewById(viewId)
+                targetView ?: error("View with such id not found")
                 producer.createVisualBehavior(position, targetView)
             }
         }

diff --git a/sample/build.gradle.kts b/sample/build.gradle.kts
@@ -40,7 +40,7 @@ dependencies {
     implementation("androidx.core:core-ktx:1.13.1")
     implementation("androidx.appcompat:appcompat:1.7.0")
     implementation("com.google.android.material:material:1.12.0")
-    implementation("com.github.neophron88:PinView:1.4.2")
+    implementation("com.github.neophron88:PinView:1.0")
     testImplementation("junit:junit:4.13.2")
     androidTestImplementation("androidx.test.ext:junit:1.1.5")
     androidTestImplementation("androidx.test.espresso:espresso-core:3.5.1")
-Original file line number
+Diff line change
@@ Expand Up / @@ -60,4 +60,8 @@ publishing { @@
                 }
             }
         }
-    }
+        repositories {
+            maven { url = uri("https://jitpack.io") }
+        }
+    }