feat: add custom animator support (Roadmap #4)

- Enabled custom Interpolator support in ShineButton and ShineView
- Added custom FiniteAnimationSpec support in ShineButtonCompose
- Updated README.md and versioned to 0.6.0
- Updated CHANGELOG.md and marked Roadmap #4 as complete

Author: ChadCSong

CHANGELOG.md

@@ -2,6 +2,16 @@
 
 All notable changes to this project will be documented in this file.
 
+## [0.6.0] - 2026-06-13
+
+### Added
+- **Custom Animators Support**: Introduced ability to set custom `Interpolator` in View version and `AnimationSpec` in Compose version.
+- Added `setInterpolator(Interpolator)` method to `ShineButton`.
+- Exposed `shineAnimationSpec` and `scaleAnimationSpec` in `ShineButtonCompose`.
+
+### Changed
+- Bumped version to 0.6.0.
+
 ## [0.5.0] - 2026-06-13
 
 ### Added

README.md

@@ -38,7 +38,7 @@ allprojects {
 
 ```gradle
 dependencies {
-    implementation 'com.github.ChadCSong:ShineButton:v0.4.1'
+    implementation 'com.github.ChadCSong:ShineButton:v0.6.0'
 }
 ```
 
@@ -48,7 +48,7 @@ Add the dependency to your `app/build.gradle` file:
 
 ```gradle
 dependencies {
-    implementation 'com.sackcentury:shinebutton:0.4.1'
+    implementation 'com.sackcentury:shinebutton:0.6.0'
 }
 ```
 
@@ -58,7 +58,7 @@ dependencies {
 <dependency>
   <groupId>com.sackcentury</groupId>
   <artifactId>shinebutton</artifactId>
-  <version>0.4.1</version>
+  <version>0.6.0</version>
   <type>aar</type>
 </dependency>
 ```

gradle.properties

@@ -17,8 +17,8 @@
 # http://www.gradle.org/docs/current/userguide/multi_project_builds.html#sec:decoupled_projects
 # org.gradle.parallel=true
 org.gradle.jvmargs=-Xmx1536M
-VERSION_NAME=0.5.0
-VERSION_CODE=15
+VERSION_NAME=0.6.0
+VERSION_CODE=16
 POM_GROUP_ID=com.sackcentury
 POM_DESCRIPTION=This is a UI lib for Android. Effects like shining.
 POM_URL=https://github.com/ChadCSong/ShineButton

shinebuttonlib/build.gradle

@@ -8,8 +8,8 @@ android {
     defaultConfig {
         minSdkVersion 21
         targetSdkVersion 34
-        versionCode 15
-        versionName "0.5.0"
+        versionCode 16
+        versionName "0.6.0"
 
     }
 

shinebuttonlib/src/main/java/com/sackcentury/shinebuttonlib/ShineButton.kt

@@ -14,6 +14,7 @@ import android.util.Log
 import android.view.View
 import android.view.ViewGroup
 import android.view.Window
+import android.view.animation.Interpolator
 import android.view.animation.LinearInterpolator
 import androidx.core.content.res.ResourcesCompat
 import com.sackcentury.shinebuttonlib.listener.SimpleAnimatorListener
@@ -250,6 +251,10 @@ class ShineButton : PorterShapeImageView {
         shineParams.shineSize = size
     }
 
+    fun setInterpolator(interpolator: Interpolator) {
+        shineParams.customInterpolator = interpolator
+    }
+
     override fun setOnClickListener(l: OnClickListener?) {
         if (l is OnButtonClickListener) {
             super.setOnClickListener(l)

shinebuttonlib/src/main/java/com/sackcentury/shinebuttonlib/ShineButtonCompose.kt

@@ -10,41 +10,30 @@ import androidx.compose.runtime.*
 import androidx.compose.ui.Alignment
 import androidx.compose.ui.Modifier
 import androidx.compose.ui.geometry.Offset
-import androidx.compose.ui.geometry.Size
 import androidx.compose.ui.graphics.Color
-import androidx.compose.ui.graphics.ImageBitmap
-import androidx.compose.ui.graphics.Paint
-import androidx.compose.ui.graphics.PaintingStyle
-import androidx.compose.ui.graphics.drawscope.Stroke
-import androidx.compose.ui.graphics.drawscope.drawIntoCanvas
-import androidx.compose.ui.graphics.nativeCanvas
-import androidx.compose.ui.graphics.painter.Painter
-import androidx.compose.ui.res.imageResource
+import androidx.compose.ui.graphics.graphicsLayer
+import androidx.compose.ui.graphics.vector.ImageVector
+import androidx.compose.ui.graphics.vector.rememberVectorPainter
 import androidx.compose.ui.unit.Dp
 import androidx.compose.ui.unit.dp
 import kotlin.math.PI
 import kotlin.math.cos
 import kotlin.math.sin
 
-import androidx.compose.ui.graphics.drawscope.drawIntoCanvas
-import androidx.compose.ui.graphics.nativeCanvas
-import androidx.compose.ui.graphics.vector.ImageVector
-import androidx.compose.ui.graphics.vector.rememberVectorPainter
-import androidx.compose.ui.graphics.graphicsLayer
-import androidx.compose.ui.graphics.drawscope.translate
-
 /**
  * A native Jetpack Compose implementation of the ShineButton.
  *
  * @param isChecked The current checked state.
  * @param onCheckedChange Callback when the state changes.
- * @param modifier Modifier for the button.
  * @param shape The Vector image to use for the button icon (e.g., Icons.Default.Favorite).
+ * @param modifier Modifier for the button.
  * @param btnColor Base color of the button (unchecked).
  * @param btnFillColor Color when the button is checked.
  * @param shineColor Primary color for shine particles.
  * @param shineSize Size of the button.
  * @param shineCount Number of shine particles.
+ * @param shineAnimationSpec Custom finite animation spec for the shine particle effect.
+ * @param scaleAnimationSpec Custom finite animation spec for the icon scale effect.
  */
 @Composable
 fun ShineButtonCompose(
@@ -58,7 +47,9 @@ fun ShineButtonCompose(
     shineSize: Dp = 50.dp,
     shineCount: Int = 8,
     animDuration: Int = 1000,
-    allowRandomColor: Boolean = false
+    allowRandomColor: Boolean = false,
+    shineAnimationSpec: FiniteAnimationSpec<Float>? = null,
+    scaleAnimationSpec: FiniteAnimationSpec<Float>? = null
 ) {
     val interactionSource = remember { MutableInteractionSource() }
     val painter = rememberVectorPainter(image = shape)
@@ -69,7 +60,7 @@ fun ShineButtonCompose(
     val shineProgress by transition.animateFloat(
         transitionSpec = {
             if (targetState) {
-                tween(durationMillis = animDuration, easing = LinearOutSlowInEasing)
+                shineAnimationSpec ?: tween(durationMillis = animDuration, easing = LinearOutSlowInEasing)
             } else {
                 tween(durationMillis = 0)
             }
@@ -82,7 +73,7 @@ fun ShineButtonCompose(
     val scale by transition.animateFloat(
         transitionSpec = {
             if (targetState) {
-                keyframes {
+                scaleAnimationSpec ?: keyframes {
                     durationMillis = 500
                     0.4f at 0
                     1.1f at 250
@@ -95,7 +86,6 @@ fun ShineButtonCompose(
         label = "Scale"
     ) { checked ->
         // To satisfy Compose's UnusedTransitionTargetStateParameter lint, we must read the state parameter.
-        // The scale naturally returns to 1.0f in both checked/unchecked idle states.
         if (checked) 1.0f else 1.0f
     }
 

shinebuttonlib/src/main/java/com/sackcentury/shinebuttonlib/ShineView.kt

@@ -10,6 +10,7 @@ import android.graphics.RectF
 import android.util.AttributeSet
 import android.view.View
 import android.view.ViewGroup
+import android.view.animation.Interpolator
 import com.sackcentury.shinebuttonlib.interpolator.QuartOutInterpolator
 import com.sackcentury.shinebuttonlib.listener.SimpleAnimatorListener
 import java.util.*
@@ -68,6 +69,7 @@ class ShineView : View {
     private var shineSize = 0
     private var allowRandomColor = false
     private var enableFlashing = false
+    private var customInterpolator: Interpolator? = null
 
     private val rectF = RectF()
     private val rectFSmall = RectF()
@@ -95,6 +97,7 @@ class ShineView : View {
     constructor(context: Context, shineButton: ShineButton, shineParams: ShineParams) : super(context) {
         initShineParams(shineParams, shineButton)
         this.shineAnimator = ShineAnimator(animDuration, shineDistanceMultiple, clickAnimDuration)
+        this.shineAnimator?.interpolator = customInterpolator ?: QuartOutInterpolator()
         this.shineButton = shineButton
 
         // Main shine particles paint
@@ -123,7 +126,7 @@ class ShineView : View {
         // Click splash animation (expanding circle)
         clickAnimator = ValueAnimator.ofFloat(0f, 1.1f).apply {
             duration = clickAnimDuration
-            interpolator = QuartOutInterpolator()
+            interpolator = customInterpolator ?: QuartOutInterpolator()
             addUpdateListener { valueAnimator ->
                 clickValue = valueAnimator.animatedValue as Float
                 invalidate()
@@ -255,6 +258,7 @@ class ShineView : View {
         var smallShineOffsetAngle = 20f
         var smallShineColor = 0
         var shineSize = 0
+        var customInterpolator: Interpolator? = null
     }
 
     /**
@@ -272,6 +276,7 @@ class ShineView : View {
         smallShineColor = shineParams.smallShineColor
         bigShineColor = shineParams.bigShineColor
         shineSize = shineParams.shineSize
+        customInterpolator = shineParams.customInterpolator
 
         if (smallShineColor == 0) {
             smallShineColor = colorRandom[6]