Browse Source

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
pull/5454/head v1.10.0+dev3080
Nikita Lipsky 2 months ago committed by GitHub
parent
commit
a68cac47c2
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
  1. 5
      components/ui-tooling-preview/library/src/androidMain/kotlin/org/jetbrains/compose/ui/tooling/preview/PreviewParameter.android.kt
  2. 5
      components/ui-tooling-preview/library/src/commonMain/kotlin/org/jetbrains/compose/ui/tooling/preview/Preview.kt
  3. 10
      components/ui-tooling-preview/library/src/commonMain/kotlin/org/jetbrains/compose/ui/tooling/preview/PreviewParameter.kt
  4. 5
      components/ui-tooling-preview/library/src/nonAndroidMain/kotlin/org/jetbrains/compose/ui/tooling/preview/PreviewParameter.nonAndroid.kt
  5. 4
      gradle-plugins/compose/src/main/kotlin/org/jetbrains/compose/ComposePlugin.kt

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

@ -20,4 +20,9 @@ package org.jetbrains.compose.ui.tooling.preview @@ -20,4 +20,9 @@ package org.jetbrains.compose.ui.tooling.preview
* Interface to be implemented by any provider of values that you want to be injected as @[Preview]
* parameters. This allows providing sample information for previews.
*/
@Deprecated(
"Use androidx.compose.ui.tooling.preview.PreviewParameterProvider from " +
"org.jetbrains.compose.ui:ui-tooling-preview module instead",
ReplaceWith("PreviewParameterProvider", "androidx.compose.ui.tooling.preview.PreviewParameterProvider")
)
actual typealias PreviewParameterProvider<T> = androidx.compose.ui.tooling.preview.PreviewParameterProvider<T>

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

@ -45,6 +45,11 @@ package org.jetbrains.compose.ui.tooling.preview @@ -45,6 +45,11 @@ package org.jetbrains.compose.ui.tooling.preview
@Retention(AnnotationRetention.BINARY)
@Target(AnnotationTarget.ANNOTATION_CLASS, AnnotationTarget.FUNCTION)
@Repeatable
@Deprecated(
"Use androidx.compose.ui.tooling.preview.Preview from " +
"org.jetbrains.compose.ui:ui-tooling-preview module instead",
ReplaceWith("Preview", "androidx.compose.ui.tooling.preview.Preview")
)
annotation class Preview(
val name: String = "",
val group: String = "",

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

@ -22,6 +22,11 @@ import kotlin.reflect.KClass @@ -22,6 +22,11 @@ import kotlin.reflect.KClass
* Interface to be implemented by any provider of values that you want to be injected as @[Preview]
* parameters. This allows providing sample information for previews.
*/
@Deprecated(
"Use androidx.compose.ui.tooling.preview.PreviewParameterProvider from " +
"org.jetbrains.compose.ui:ui-tooling-preview module instead",
ReplaceWith("PreviewParameterProvider", "androidx.compose.ui.tooling.preview.PreviewParameterProvider")
)
expect interface PreviewParameterProvider<T> {
/**
* [Sequence] of values of type [T] to be passed as @[Preview] parameter.
@ -41,6 +46,11 @@ expect interface PreviewParameterProvider<T> { @@ -41,6 +46,11 @@ expect interface PreviewParameterProvider<T> {
* parameter.
* @param limit Max number of values from [provider] to inject to this parameter.
*/
@Deprecated(
"Use androidx.compose.ui.tooling.preview.PreviewParameter from " +
"org.jetbrains.compose.ui:ui-tooling-preview module instead",
ReplaceWith("PreviewParameter", "androidx.compose.ui.tooling.preview.PreviewParameter")
)
annotation class PreviewParameter(
val provider: KClass<out PreviewParameterProvider<*>>,
val limit: Int = Int.MAX_VALUE

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

@ -20,6 +20,11 @@ package org.jetbrains.compose.ui.tooling.preview @@ -20,6 +20,11 @@ package org.jetbrains.compose.ui.tooling.preview
* Interface to be implemented by any provider of values that you want to be injected as @[Preview]
* parameters. This allows providing sample information for previews.
*/
@Deprecated(
"Use androidx.compose.ui.tooling.preview.PreviewParameterProvider from " +
"org.jetbrains.compose.ui:ui-tooling-preview module instead",
ReplaceWith("PreviewParameterProvider", "androidx.compose.ui.tooling.preview.PreviewParameterProvider")
)
actual interface PreviewParameterProvider<T> {
/**
* [Sequence] of values of type [T] to be passed as @[Preview] parameter.

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

@ -113,6 +113,10 @@ abstract class ComposePlugin : Plugin<Project> { @@ -113,6 +113,10 @@ abstract class ComposePlugin : Plugin<Project> {
object CommonComponentsDependencies {
val resources = composeDependency("org.jetbrains.compose.components:components-resources")
@Deprecated(
"Use org.jetbrains.compose.ui:ui-tooling-preview module instead",
ReplaceWith("compose.preview")
)
val uiToolingPreview = composeDependency("org.jetbrains.compose.components:components-ui-tooling-preview")
}

Loading…
Cancel
Save