Merge pull request #34 from a914-gowtham/refactor/ratingbar_usage

Refactor/ratingbar usage
a914-gowtham · May 27, 2023 · 490ed44 · 490ed44
2 parents 8741e11 + f873706
commit 490ed44
Show file tree

Hide file tree

Showing 8 changed files with 230 additions and 295 deletions.
diff --git a/README.md b/README.md
@@ -6,7 +6,7 @@ A ratingbar for jetpack compose
 [![](https://jitpack.io/v/a914-gowtham/compose-ratingbar/month.svg)](https://jitpack.io/#a914-gowtham/compose-ratingbar)
 
 
-<img src="https://github.com/a914-gowtham/compose-ratingbar/blob/main/demo_1.gif" width="340" height="260"/>
+<img src="https://github.com/a914-gowtham/compose-ratingbar/blob/refactor/ratingbar_usage/demo_1.gif" width="340" height="260"/>
 
 Download
 --------
@@ -19,7 +19,7 @@ repositories {
 
 // App build.gradle
 dependencies {
-   implementation 'com.github.a914-gowtham:compose-ratingbar:1.3.1'
+   implementation 'com.github.a914-gowtham:compose-ratingbar:1.3.3'
   //mavenCentral
   // implementation 'io.github.a914-gowtham:compose-ratingbar:1.2.3'
 
@@ -30,46 +30,45 @@ dependencies {
 ```kotlin
    import androidx.compose.runtime.*
 
-   var rating: Float by remember { mutableStateOf(initialRating) }
+   var rating: Float by remember { mutableStateOf(3.2f) }
 
    RatingBar(
        value = rating,
-       config = RatingBarConfig()
-           .style(RatingBarStyle.HighLighted),
+       style = RatingBarStyle.Fill(),
        onValueChange = {
-           rating = it
+           ratingOne = it
        },
        onRatingChanged = {
            Log.d("TAG", "onRatingChanged: $it")
        }
    )
 ```
 
-Ratingbar composable can be customized using  [RatingBarConfig](https://github.com/a914-gowtham/compose-ratingbar/blob/main/ratingbar/src/main/java/com/gowtham/ratingbar/RatingBarConfig.kt) class as shown below:
+#### Other optional params:
 ```kotlin
-        RatingBarConfig()
-                .activeColor(Color.Yellow)
-                .hideInactiveStars(true)
-                .inactiveColor(Color.LightGray)
-                .inactiveBorderColor(Color.Blue)
-                .stepSize(StepSize.HALF)
-                .numStars(10)
-                .isIndicator(true)
-                .size(24.dp)
-                .horizontalPadding(6.dp)
-                .style(RatingBarStyle.HighLighted)
+  fun RatingBar(
+      value: Float,
+      modifier: Modifier = Modifier,
+      numOfStars: Int = 5,
+      size: Dp = 32.dp,
+      horizontalPadding: Dp = 6.dp,
+      isIndicator: Boolean = false,
+      stepSize: StepSize = StepSize.ONE,
+      hideInactiveStars: Boolean = false,
+      style: RatingBarStyle,
+      onValueChange: (Float) -> Unit,
+      onRatingChanged: (Float) -> Unit
+)
 ```
 
-## Customization
+## More Customization✨
 
 <img src="https://github.com/a914-gowtham/compose-ratingbar/blob/main/customization_demo.gif" width="340" height="260"/>
 
+Icon can be changed using ```painterEmpty``` ```painterFilled``` params.
 ```kotlin
         RatingBar(
             value = rating,
-            config = RatingBarConfig()
-                .horizontalPadding(2.dp)
-                .size(32.dp),
             painterEmpty = painterResource(id = R.drawable.icon_empty),
             painterFilled = painterResource(id = R.drawable.icon_filled),
             onValueChange = {

diff --git a/app/src/main/java/com/gowtham/compose_ratingbar/MainActivity.kt b/app/src/main/java/com/gowtham/compose_ratingbar/MainActivity.kt
@@ -6,7 +6,9 @@ import androidx.activity.ComponentActivity
 import androidx.activity.compose.setContent
 import androidx.compose.foundation.layout.Arrangement
 import androidx.compose.foundation.layout.Column
+import androidx.compose.foundation.layout.Spacer
 import androidx.compose.foundation.layout.fillMaxSize
+import androidx.compose.foundation.layout.height
 import androidx.compose.material.MaterialTheme
 import androidx.compose.material.Surface
 import androidx.compose.runtime.Composable
@@ -16,12 +18,12 @@ import androidx.compose.runtime.saveable.rememberSaveable
 import androidx.compose.runtime.setValue
 import androidx.compose.ui.Alignment
 import androidx.compose.ui.Modifier
+import androidx.compose.ui.res.painterResource
 import androidx.compose.ui.tooling.preview.Preview
 import androidx.compose.ui.unit.dp
 import com.gowtham.compose_ratingbar.MainActivity.Companion.initialRating
 import com.gowtham.compose_ratingbar.ui.theme.JetpackComposeTheme
 import com.gowtham.ratingbar.RatingBar
-import com.gowtham.ratingbar.RatingBarConfig
 import com.gowtham.ratingbar.RatingBarStyle
 import com.gowtham.ratingbar.StepSize
 
@@ -51,22 +53,32 @@ fun MyApp() {
 
 @Composable
 fun MainScreen() {
-    var rating: Float by rememberSaveable { mutableStateOf(initialRating) }
+    var ratingOne: Float by rememberSaveable { mutableStateOf(1.4f) }
+    var ratingTwo: Float by rememberSaveable { mutableStateOf(initialRating) }
 
     Column(
         modifier = Modifier.fillMaxSize(),
         horizontalAlignment = Alignment.CenterHorizontally,
         verticalArrangement = Arrangement.Center,
     ) {
         RatingBar(
-            value = rating,
-            config = RatingBarConfig()
-                .horizontalPadding(6.dp)
-                .size(28.dp)
-                .stepSize(StepSize.HALF)
-                .style(RatingBarStyle.HighLighted),
+            value = ratingOne,
+            stepSize = StepSize.HALF,
+            style = RatingBarStyle.Fill(),
             onValueChange = {
-                rating = it
+                ratingOne = it
+            },
+            onRatingChanged = {
+                Log.d("TAG", "onRatingChanged: $it")
+            }
+        )
+        Spacer(modifier = Modifier.height(30.dp))
+        RatingBar(
+            value = ratingTwo,
+            painterEmpty = painterResource(id = R.drawable.icon_empty),
+            painterFilled = painterResource(id = R.drawable.icon_filled),
+            onValueChange = {
+                ratingTwo = it
             },
             onRatingChanged = {
                 Log.d("TAG", "onRatingChanged: $it")

diff --git a/demo_1.gif b/demo_1.gif
diff --git a/ratingbar/build.gradle b/ratingbar/build.gradle
@@ -13,7 +13,7 @@ afterEvaluate {
                 from components.release
                 groupId = 'com.gowtham.composeratingbar'
                 artifactId = 'compose-ratingbar'
-                version =  '1.3.1'
+                version =  '1.3.3'
             }
         }
     }