Rename textComponent composable function to rememberTextComponent

patrykandpatrick · Dec 6, 2023 · 2b703ff · 2b703ff
1 parent 5d229af
commit 2b703ff
Show file tree

Hide file tree

Showing 11 changed files with 35 additions and 31 deletions.
diff --git a/sample/src/main/java/com/patrykandpatrick/vico/sample/previews/ContainedChartsPreview.kt b/sample/src/main/java/com/patrykandpatrick/vico/sample/previews/ContainedChartsPreview.kt
@@ -31,9 +31,9 @@ import com.patrykandpatrick.vico.compose.chart.layer.rememberColumnCartesianLaye
 import com.patrykandpatrick.vico.compose.chart.layer.rememberLineCartesianLayer
 import com.patrykandpatrick.vico.compose.chart.rememberCartesianChart
 import com.patrykandpatrick.vico.compose.component.lineComponent
+import com.patrykandpatrick.vico.compose.component.rememberTextComponent
 import com.patrykandpatrick.vico.compose.component.shape.shader.color
 import com.patrykandpatrick.vico.compose.component.shape.shader.verticalGradient
-import com.patrykandpatrick.vico.compose.component.textComponent
 import com.patrykandpatrick.vico.core.axis.Axis
 import com.patrykandpatrick.vico.core.axis.AxisItemPlacer
 import com.patrykandpatrick.vico.core.axis.AxisPosition.Vertical
@@ -89,14 +89,14 @@ private fun getLineLayer(verticalAxisPosition: Vertical? = null) =
 private val startAxis: Axis<Start>
     @Composable get() =
         rememberStartAxis(
-            label = textComponent(color = Color.Black),
+            label = rememberTextComponent(color = Color.Black),
             itemPlacer = remember { AxisItemPlacer.Vertical.default(maxItemCount = 5) },
         )
 
 private val endAxis: Axis<End>
     @Composable get() =
         rememberEndAxis(
-            label = textComponent(color = Color.DarkGray),
+            label = rememberTextComponent(color = Color.DarkGray),
             itemPlacer = remember { AxisItemPlacer.Vertical.default(maxItemCount = 7) },
         )
 

diff --git a/...in/java/com/patrykandpatrick/vico/sample/previews/LineChartsWithNegativeValuesPreviews.kt b/...in/java/com/patrykandpatrick/vico/sample/previews/LineChartsWithNegativeValuesPreviews.kt
@@ -32,8 +32,8 @@ import com.patrykandpatrick.vico.compose.chart.layer.lineSpec
 import com.patrykandpatrick.vico.compose.chart.layer.rememberLineCartesianLayer
 import com.patrykandpatrick.vico.compose.chart.layout.fullWidth
 import com.patrykandpatrick.vico.compose.chart.rememberCartesianChart
+import com.patrykandpatrick.vico.compose.component.rememberTextComponent
 import com.patrykandpatrick.vico.compose.component.shape.shader.color
-import com.patrykandpatrick.vico.compose.component.textComponent
 import com.patrykandpatrick.vico.core.axis.AxisItemPlacer
 import com.patrykandpatrick.vico.core.chart.layout.HorizontalLayout
 import com.patrykandpatrick.vico.core.chart.values.AxisValueOverrider
@@ -97,7 +97,10 @@ public fun SingleLineChartWithNegativeValuesAndDataLabels() {
                     rememberLineCartesianLayer(
                         lines =
                             listOf(
-                                lineSpec(shader = DynamicShaders.color(Color.DarkGray), dataLabel = textComponent()),
+                                lineSpec(
+                                    shader = DynamicShaders.color(Color.DarkGray),
+                                    dataLabel = rememberTextComponent(),
+                                ),
                             ),
                     ),
                 ),

diff --git a/sample/src/main/java/com/patrykandpatrick/vico/sample/previews/Previews.kt b/sample/src/main/java/com/patrykandpatrick/vico/sample/previews/Previews.kt
@@ -40,11 +40,11 @@ import com.patrykandpatrick.vico.compose.chart.layer.rememberColumnCartesianLaye
 import com.patrykandpatrick.vico.compose.chart.layer.rememberLineCartesianLayer
 import com.patrykandpatrick.vico.compose.chart.rememberCartesianChart
 import com.patrykandpatrick.vico.compose.component.lineComponent
+import com.patrykandpatrick.vico.compose.component.rememberTextComponent
 import com.patrykandpatrick.vico.compose.component.shape.shader.color
 import com.patrykandpatrick.vico.compose.component.shape.shader.fromComponent
 import com.patrykandpatrick.vico.compose.component.shape.shader.verticalGradient
 import com.patrykandpatrick.vico.compose.component.shapeComponent
-import com.patrykandpatrick.vico.compose.component.textComponent
 import com.patrykandpatrick.vico.compose.dimensions.dimensionsOf
 import com.patrykandpatrick.vico.core.axis.horizontal.createHorizontalAxis
 import com.patrykandpatrick.vico.core.axis.vertical.VerticalAxis
@@ -87,7 +87,7 @@ public fun ColumnChartCard(): Unit =
                 startAxis =
                     createVerticalAxis {
                         label =
-                            textComponent(
+                            rememberTextComponent(
                                 color = colors.primary,
                                 textSize = 10.sp,
                                 background =
@@ -153,7 +153,7 @@ public fun LineChartCard(): Unit =
                 startAxis =
                     createVerticalAxis {
                         label =
-                            textComponent(
+                            rememberTextComponent(
                                 color = colors.onSurface,
                                 textSize = 10.sp,
                                 background = shapeComponent(shape = rectShape, color = Color.LightGray),

diff --git a/sample/src/main/java/com/patrykandpatrick/vico/sample/previews/ThresholdLinePreviews.kt b/sample/src/main/java/com/patrykandpatrick/vico/sample/previews/ThresholdLinePreviews.kt
@@ -34,9 +34,9 @@ import com.patrykandpatrick.vico.compose.chart.layer.rememberColumnCartesianLaye
 import com.patrykandpatrick.vico.compose.chart.rememberCartesianChart
 import com.patrykandpatrick.vico.compose.chart.scroll.rememberChartScrollSpec
 import com.patrykandpatrick.vico.compose.component.lineComponent
+import com.patrykandpatrick.vico.compose.component.rememberTextComponent
 import com.patrykandpatrick.vico.compose.component.shape.shader.toDynamicShader
 import com.patrykandpatrick.vico.compose.component.shapeComponent
-import com.patrykandpatrick.vico.compose.component.textComponent
 import com.patrykandpatrick.vico.compose.dimensions.dimensionsOf
 import com.patrykandpatrick.vico.compose.style.LocalChartStyle
 import com.patrykandpatrick.vico.core.chart.decoration.ThresholdLine
@@ -100,7 +100,8 @@ public fun ThresholdLine() {
                             ThresholdLine(
                                 thresholdValue = 2f,
                                 lineComponent = shapeComponent(color = Color.Black),
-                                labelComponent = textComponent(Color.Black, padding = dimensionsOf(horizontal = 8.dp)),
+                                labelComponent =
+                                    rememberTextComponent(Color.Black, padding = dimensionsOf(horizontal = 8.dp)),
                             ),
                         ),
                 ),
@@ -128,7 +129,7 @@ public fun ThresholdLineWithCustomText() {
                                 thresholdLabel = "Threshold line 1 📐",
                                 lineComponent = shapeComponent(color = Color.Black),
                                 labelComponent =
-                                    textComponent(
+                                    rememberTextComponent(
                                         color = Color.White,
                                         lineCount = 3,
                                         background =
@@ -156,7 +157,7 @@ public fun ThresholdLineWithCustomText() {
                                 thresholdLabel = "Threshold line 2 📐",
                                 lineComponent = shapeComponent(color = Color.DarkGray),
                                 labelComponent =
-                                    textComponent(
+                                    rememberTextComponent(
                                         color = Color.White,
                                         lineCount = 3,
                                         background =
@@ -203,7 +204,7 @@ public fun RangedThresholdLine() {
                                 thresholdRange = 2f..3f,
                                 lineComponent = shapeComponent(color = Color.Black.copy(alpha = 0.5f)),
                                 labelComponent =
-                                    textComponent(
+                                    rememberTextComponent(
                                         color = Color.Black,
                                         padding = dimensionsOf(horizontal = 8.dp),
                                     ),
@@ -244,7 +245,7 @@ public fun RangedThresholdLineWithBrushShader() {
                                             ).toDynamicShader(),
                                     ),
                                 labelComponent =
-                                    textComponent(
+                                    rememberTextComponent(
                                         color = Color.Black,
                                         padding = dimensionsOf(horizontal = 8.dp),
                                     ),
@@ -284,7 +285,7 @@ public fun RangedThresholdLineWithComponentShader() {
                                         strokeColor = Color.Black,
                                     ),
                                 labelComponent =
-                                    textComponent(
+                                    rememberTextComponent(
                                         color = Color.Black,
                                         padding = dimensionsOf(horizontal = 8.dp),
                                     ),

diff --git a/sample/src/main/java/com/patrykandpatrick/vico/sample/showcase/Marker.kt b/sample/src/main/java/com/patrykandpatrick/vico/sample/showcase/Marker.kt
@@ -25,8 +25,8 @@ import androidx.compose.ui.graphics.toArgb
 import androidx.compose.ui.unit.dp
 import com.patrykandpatrick.vico.compose.component.lineComponent
 import com.patrykandpatrick.vico.compose.component.overlayingComponent
+import com.patrykandpatrick.vico.compose.component.rememberTextComponent
 import com.patrykandpatrick.vico.compose.component.shapeComponent
-import com.patrykandpatrick.vico.compose.component.textComponent
 import com.patrykandpatrick.vico.compose.dimensions.dimensionsOf
 import com.patrykandpatrick.vico.core.chart.dimensions.HorizontalDimensions
 import com.patrykandpatrick.vico.core.chart.insets.Insets
@@ -52,7 +52,7 @@ internal fun rememberMarker(): Marker {
             )
         }
     val label =
-        textComponent(
+        rememberTextComponent(
             background = labelBackground,
             lineCount = LABEL_LINE_COUNT,
             padding = labelPadding,

diff --git a/sample/src/main/java/com/patrykandpatrick/vico/sample/showcase/charts/Chart2.kt b/sample/src/main/java/com/patrykandpatrick/vico/sample/showcase/charts/Chart2.kt
@@ -27,8 +27,8 @@ import com.patrykandpatrick.vico.compose.axis.vertical.rememberStartAxis
 import com.patrykandpatrick.vico.compose.chart.CartesianChartHost
 import com.patrykandpatrick.vico.compose.chart.layer.rememberColumnCartesianLayer
 import com.patrykandpatrick.vico.compose.chart.rememberCartesianChart
+import com.patrykandpatrick.vico.compose.component.rememberTextComponent
 import com.patrykandpatrick.vico.compose.component.shapeComponent
-import com.patrykandpatrick.vico.compose.component.textComponent
 import com.patrykandpatrick.vico.compose.dimensions.dimensionsOf
 import com.patrykandpatrick.vico.compose.style.ProvideChartStyle
 import com.patrykandpatrick.vico.compose.style.currentChartStyle
@@ -108,7 +108,7 @@ private fun ViewChart2(modelProducer: CartesianChartModelProducer) {
 private fun rememberThresholdLine(): ThresholdLine {
     val line = shapeComponent(color = color2)
     val label =
-        textComponent(
+        rememberTextComponent(
             color = Color.Black,
             background = shapeComponent(Shapes.pillShape, color2),
             padding = thresholdLineLabelPadding,

diff --git a/sample/src/main/java/com/patrykandpatrick/vico/sample/showcase/charts/Chart3.kt b/sample/src/main/java/com/patrykandpatrick/vico/sample/showcase/charts/Chart3.kt
@@ -30,8 +30,8 @@ import com.patrykandpatrick.vico.compose.chart.edges.rememberFadingEdges
 import com.patrykandpatrick.vico.compose.chart.layer.rememberLineCartesianLayer
 import com.patrykandpatrick.vico.compose.chart.layout.fullWidth
 import com.patrykandpatrick.vico.compose.chart.rememberCartesianChart
+import com.patrykandpatrick.vico.compose.component.rememberTextComponent
 import com.patrykandpatrick.vico.compose.component.shapeComponent
-import com.patrykandpatrick.vico.compose.component.textComponent
 import com.patrykandpatrick.vico.compose.dimensions.dimensionsOf
 import com.patrykandpatrick.vico.compose.style.ProvideChartStyle
 import com.patrykandpatrick.vico.core.axis.vertical.VerticalAxis
@@ -68,7 +68,7 @@ private fun ComposeChart3(modelProducer: CartesianChartModelProducer) {
                     guideline = null,
                     horizontalLabelPosition = VerticalAxis.HorizontalLabelPosition.Inside,
                     titleComponent =
-                        textComponent(
+                        rememberTextComponent(
                             color = Color.Black,
                             background = shapeComponent(Shapes.pillShape, color1),
                             padding = axisTitlePadding,
@@ -80,7 +80,7 @@ private fun ComposeChart3(modelProducer: CartesianChartModelProducer) {
             bottomAxis =
                 rememberBottomAxis(
                     titleComponent =
-                        textComponent(
+                        rememberTextComponent(
                             background = shapeComponent(Shapes.pillShape, color2),
                             color = Color.White,
                             padding = axisTitlePadding,

diff --git a/sample/src/main/java/com/patrykandpatrick/vico/sample/showcase/charts/Chart6.kt b/sample/src/main/java/com/patrykandpatrick/vico/sample/showcase/charts/Chart6.kt
@@ -27,8 +27,8 @@ import com.patrykandpatrick.vico.compose.axis.vertical.rememberStartAxis
 import com.patrykandpatrick.vico.compose.chart.CartesianChartHost
 import com.patrykandpatrick.vico.compose.chart.layer.rememberColumnCartesianLayer
 import com.patrykandpatrick.vico.compose.chart.rememberCartesianChart
+import com.patrykandpatrick.vico.compose.component.rememberTextComponent
 import com.patrykandpatrick.vico.compose.component.shapeComponent
-import com.patrykandpatrick.vico.compose.component.textComponent
 import com.patrykandpatrick.vico.compose.dimensions.dimensionsOf
 import com.patrykandpatrick.vico.compose.style.ProvideChartStyle
 import com.patrykandpatrick.vico.compose.style.currentChartStyle
@@ -106,7 +106,7 @@ private fun ViewChart6(modelProducer: CartesianChartModelProducer) {
 @Composable
 private fun rememberThresholdLine(): ThresholdLine {
     val label =
-        textComponent(
+        rememberTextComponent(
             color = Color.Black,
             background = shapeComponent(Shapes.rectShape, color4),
             padding = thresholdLineLabelPadding,

diff --git a/sample/src/main/java/com/patrykandpatrick/vico/sample/showcase/charts/Chart7.kt b/sample/src/main/java/com/patrykandpatrick/vico/sample/showcase/charts/Chart7.kt
@@ -31,9 +31,9 @@ import com.patrykandpatrick.vico.compose.axis.vertical.rememberStartAxis
 import com.patrykandpatrick.vico.compose.chart.CartesianChartHost
 import com.patrykandpatrick.vico.compose.chart.layer.rememberLineCartesianLayer
 import com.patrykandpatrick.vico.compose.chart.rememberCartesianChart
+import com.patrykandpatrick.vico.compose.component.rememberTextComponent
 import com.patrykandpatrick.vico.compose.component.shape.roundedCornerShape
 import com.patrykandpatrick.vico.compose.component.shapeComponent
-import com.patrykandpatrick.vico.compose.component.textComponent
 import com.patrykandpatrick.vico.compose.dimensions.dimensionsOf
 import com.patrykandpatrick.vico.compose.legend.legendItem
 import com.patrykandpatrick.vico.compose.legend.verticalLegend
@@ -120,7 +120,7 @@ private fun rememberLegend() =
                 legendItem(
                     icon = shapeComponent(Shapes.pillShape, chartColor),
                     label =
-                        textComponent(
+                        rememberTextComponent(
                             color = currentChartStyle.axis.axisLabelColor,
                             textSize = legendItemLabelTextSize,
                             typeface = Typeface.MONOSPACE,

diff --git a/vico/compose/src/main/java/com/patrykandpatrick/vico/compose/axis/AxisComponents.kt b/vico/compose/src/main/java/com/patrykandpatrick/vico/compose/axis/AxisComponents.kt
@@ -28,9 +28,9 @@ import androidx.compose.ui.unit.Dp
 import androidx.compose.ui.unit.TextUnit
 import androidx.compose.ui.unit.dp
 import com.patrykandpatrick.vico.compose.component.lineComponent
+import com.patrykandpatrick.vico.compose.component.rememberTextComponent
 import com.patrykandpatrick.vico.compose.component.shape.chartShape
 import com.patrykandpatrick.vico.compose.component.shape.shader.BrushShader
-import com.patrykandpatrick.vico.compose.component.textComponent
 import com.patrykandpatrick.vico.compose.dimensions.dimensionsOf
 import com.patrykandpatrick.vico.compose.style.currentChartStyle
 import com.patrykandpatrick.vico.core.component.shape.LineComponent
@@ -72,7 +72,7 @@ public fun axisLabelComponent(
     typeface: Typeface = currentChartStyle.axis.axisLabelTypeface,
     textAlignment: Layout.Alignment = currentChartStyle.axis.axisLabelTextAlignment,
 ): TextComponent =
-    textComponent(
+    rememberTextComponent(
         color,
         textSize,
         background,
@@ -117,7 +117,7 @@ public fun axisLabelComponent(
     typeface: Typeface = currentChartStyle.axis.axisLabelTypeface,
     textAlignment: Layout.Alignment = currentChartStyle.axis.axisLabelTextAlignment,
 ): TextComponent =
-    textComponent(
+    rememberTextComponent(
         color,
         textSize,
         background,

diff --git a/vico/compose/src/main/java/com/patrykandpatrick/vico/compose/component/Components.kt b/vico/compose/src/main/java/com/patrykandpatrick/vico/compose/component/Components.kt
@@ -237,7 +237,7 @@ public fun overlayingComponent(
     )
 
 /**
- * Creates a [TextComponent].
+ * Creates and remembers a [TextComponent].
  *
  * @param color the text color.
  * @param textSize the text size.
@@ -250,7 +250,7 @@ public fun overlayingComponent(
  * @param textAlignment the text alignment.
  */
 @Composable
-public fun textComponent(
+public fun rememberTextComponent(
     color: Color = Color.Black,
     textSize: TextUnit = DefaultDimens.TEXT_COMPONENT_TEXT_SIZE.sp,
     background: ShapeComponent? = null,