Skip to content

Commit a68cac4

Browse files
authored
Deprecate org.jetbrains.compose.ui.tooling.preview.Preview (#5453)
Deprecate `org.jetbrains.compose.ui.tooling.preview.Preview` annotation in favor of `androidx.compose.ui.tooling.preview.Preview` Fixes [CMP-4869](https://youtrack.jetbrains.com/issue/CMP-4869/Reduce-variety-of-Preview-annotations) ## Release Notes ### Highlights - Multiple Platforms - Deprecate `org.jetbrains.compose.ui.tooling.preview.Preview` annotation in favor of `androidx.compose.ui.tooling.preview.Preview` to reduce variety of Preview annotations
1 parent c5b371f commit a68cac4

File tree

5 files changed

+29
-0
lines changed

5 files changed

+29
-0
lines changed

components/ui-tooling-preview/library/src/androidMain/kotlin/org/jetbrains/compose/ui/tooling/preview/PreviewParameter.android.kt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,4 +20,9 @@ package org.jetbrains.compose.ui.tooling.preview
2020
* Interface to be implemented by any provider of values that you want to be injected as @[Preview]
2121
* parameters. This allows providing sample information for previews.
2222
*/
23+
@Deprecated(
24+
"Use androidx.compose.ui.tooling.preview.PreviewParameterProvider from " +
25+
"org.jetbrains.compose.ui:ui-tooling-preview module instead",
26+
ReplaceWith("PreviewParameterProvider", "androidx.compose.ui.tooling.preview.PreviewParameterProvider")
27+
)
2328
actual typealias PreviewParameterProvider<T> = androidx.compose.ui.tooling.preview.PreviewParameterProvider<T>

components/ui-tooling-preview/library/src/commonMain/kotlin/org/jetbrains/compose/ui/tooling/preview/Preview.kt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,11 @@ package org.jetbrains.compose.ui.tooling.preview
4545
@Retention(AnnotationRetention.BINARY)
4646
@Target(AnnotationTarget.ANNOTATION_CLASS, AnnotationTarget.FUNCTION)
4747
@Repeatable
48+
@Deprecated(
49+
"Use androidx.compose.ui.tooling.preview.Preview from " +
50+
"org.jetbrains.compose.ui:ui-tooling-preview module instead",
51+
ReplaceWith("Preview", "androidx.compose.ui.tooling.preview.Preview")
52+
)
4853
annotation class Preview(
4954
val name: String = "",
5055
val group: String = "",

components/ui-tooling-preview/library/src/commonMain/kotlin/org/jetbrains/compose/ui/tooling/preview/PreviewParameter.kt

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,11 @@ import kotlin.reflect.KClass
2222
* Interface to be implemented by any provider of values that you want to be injected as @[Preview]
2323
* parameters. This allows providing sample information for previews.
2424
*/
25+
@Deprecated(
26+
"Use androidx.compose.ui.tooling.preview.PreviewParameterProvider from " +
27+
"org.jetbrains.compose.ui:ui-tooling-preview module instead",
28+
ReplaceWith("PreviewParameterProvider", "androidx.compose.ui.tooling.preview.PreviewParameterProvider")
29+
)
2530
expect interface PreviewParameterProvider<T> {
2631
/**
2732
* [Sequence] of values of type [T] to be passed as @[Preview] parameter.
@@ -41,6 +46,11 @@ expect interface PreviewParameterProvider<T> {
4146
* parameter.
4247
* @param limit Max number of values from [provider] to inject to this parameter.
4348
*/
49+
@Deprecated(
50+
"Use androidx.compose.ui.tooling.preview.PreviewParameter from " +
51+
"org.jetbrains.compose.ui:ui-tooling-preview module instead",
52+
ReplaceWith("PreviewParameter", "androidx.compose.ui.tooling.preview.PreviewParameter")
53+
)
4454
annotation class PreviewParameter(
4555
val provider: KClass<out PreviewParameterProvider<*>>,
4656
val limit: Int = Int.MAX_VALUE

components/ui-tooling-preview/library/src/nonAndroidMain/kotlin/org/jetbrains/compose/ui/tooling/preview/PreviewParameter.nonAndroid.kt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,11 @@ package org.jetbrains.compose.ui.tooling.preview
2020
* Interface to be implemented by any provider of values that you want to be injected as @[Preview]
2121
* parameters. This allows providing sample information for previews.
2222
*/
23+
@Deprecated(
24+
"Use androidx.compose.ui.tooling.preview.PreviewParameterProvider from " +
25+
"org.jetbrains.compose.ui:ui-tooling-preview module instead",
26+
ReplaceWith("PreviewParameterProvider", "androidx.compose.ui.tooling.preview.PreviewParameterProvider")
27+
)
2328
actual interface PreviewParameterProvider<T> {
2429
/**
2530
* [Sequence] of values of type [T] to be passed as @[Preview] parameter.

gradle-plugins/compose/src/main/kotlin/org/jetbrains/compose/ComposePlugin.kt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,10 @@ abstract class ComposePlugin : Plugin<Project> {
113113

114114
object CommonComponentsDependencies {
115115
val resources = composeDependency("org.jetbrains.compose.components:components-resources")
116+
@Deprecated(
117+
"Use org.jetbrains.compose.ui:ui-tooling-preview module instead",
118+
ReplaceWith("compose.preview")
119+
)
116120
val uiToolingPreview = composeDependency("org.jetbrains.compose.components:components-ui-tooling-preview")
117121
}
118122

0 commit comments

Comments
 (0)