Merge pull request #37 from cheonjaeung/deprecate-span-integer

Deprecate span modifier with an integer parameter
cheonjaeung · Jan 31, 2025 · b16b9f4 · b16b9f4
2 parents 130c887 + 7bf2eeb
commit b16b9f4
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/docs/span.md b/docs/span.md
@@ -58,6 +58,10 @@ VerticalGrid(columns = SimpleGridCells.Adaptive(30.dp)) {
 
 There is a convenience modifier that just takes an integer span.
 
+!!! warning
+    Span with an integer parameter is deprecated after 2.3.0.
+    Replace it to the span with lambda parameter.
+
 ```kotlin
 HorizontalGrid(rows = SimpleGridCells.Fixed(3)) {
     Item()

diff --git a/grid/src/commonMain/kotlin/com/cheonjaeung/compose/grid/GridScope.kt b/grid/src/commonMain/kotlin/com/cheonjaeung/compose/grid/GridScope.kt
@@ -19,6 +19,11 @@ interface GridScope {
      * at the next line.
      */
     @Stable
+    @Deprecated(
+        "Span modifier with an integer parameter is deprecated. " +
+            "Please use another span modifier with lambda parameter.",
+        ReplaceWith("this.span { span }")
+    )
     fun Modifier.span(span: Int): Modifier
 
     /**