CMP-1108: Deprecate resources in `compose.ui` in favour of the new resource library #1457

terrakok · 2024-07-18T14:08:55Z

To work with resources in the desktop compose the recommended way is to use the special resources library.

Fixes https://youtrack.jetbrains.com/issue/CMP-1108

Migration snippet

To read java resources by path as Painters you may use:

@Composable
internal fun painterResource(
    resourcePath: String
): Painter = when (resourcePath.substringAfterLast(".")) {
    "svg" -> rememberSvgResource(resourcePath)
    "xml" -> rememberVectorXmlResource(resourcePath)
    else -> rememberBitmapResource(resourcePath)
}

@Composable
internal fun rememberBitmapResource(path: String): Painter {
    return remember(path) { BitmapPainter(readResourceBytes(path).decodeToImageBitmap()) }
}

@Composable
internal fun rememberVectorXmlResource(path: String): Painter {
    val density = LocalDensity.current
    val imageVector = remember(density, path) { readResourceBytes(path).decodeToImageVector(density) }
    return rememberVectorPainter(imageVector)
}

@Composable
internal fun rememberSvgResource(path: String): Painter {
    val density = LocalDensity.current
    return remember(density, path) { readResourceBytes(path).decodeToSvgPainter(density) }
}

private object ResourceLoader
private fun readResourceBytes(resourcePath: String) =
    ResourceLoader.javaClass.classLoader.getResourceAsStream(resourcePath).readAllBytes()

Release Notes

Breaking changes - Resources

Deprecate resources in compose.ui in favour of the new resource library

compose/ui/ui/src/desktopMain/kotlin/androidx/compose/ui/res/DesktopSvgResources.desktop.kt

MatkovIvan · 2024-07-18T16:32:41Z

compose/ui/ui/src/desktopMain/kotlin/androidx/compose/ui/res/PainterResources.desktop.kt

-@ExperimentalComposeUiApi
+@Deprecated("Migrate to the compose resources library")


We don't need to

Remove experimental

Deprecate experimental (just remove)

We cannot delete these function because they are being used in non experimental public API 🤷
Example:

//non experimental fun painterResource(resourcePath: String, loader: ResourceLoader): Painter //non experimental private fun rememberSvgResource( resourcePath: String, loader: ResourceLoader = ResourceLoader.Default ): Painter //experimental internal inline fun <T> useResource( resourcePath: String, loader: ResourceLoader, block: (InputStream) -> T ): T

Can we make it internal then?

terrakok · 2024-08-28T09:10:47Z

Checked with Compose 1.7.0 and Kotlin 2.0.20.
Found two problems:

CMP-6543 java.lang.NoSuchMethodError: 'void java.io.InputStream.skipNBytes(long)' Fixed
CMP-6541 Compose resource accessors aren't generated when Kotlin JVM plugin is applied there is easy workaround

(button's texts, scroll items and a logo use compose resources)

…source library

MatkovIvan

Removing experimental marks still doesn't LGTM. We can just remove it instead of committing for endless "deprecation" compatibility support

igordmn · 2024-08-30T13:20:55Z

Removing experimental marks still doesn't LGTM. We can just remove it instead of committing for endless "deprecation"

We can do that for the experimental API, but we should move the implementation inside non-experimental API

igordmn · 2024-09-03T10:48:53Z

compose/ui/ui/src/desktopMain/kotlin/androidx/compose/ui/res/PainterResources.desktop.kt

@@ -50,7 +50,7 @@ import org.xml.sax.InputSource
 * @param loader  resources loader
 * @return [Painter] used for drawing the loaded resource
 */
-@OptIn(ExperimentalComposeUiApi::class)
+@Deprecated("Migrate to the Compose resources library. See https://www.jetbrains.com/help/kotlin-multiplatform-dev/compose-images-resources.html")
 @Composable
 fun painterResource(


Besides painterResource, we need to deprecate in another PR:

fun Font( resource: String, weight: FontWeight = FontWeight.Normal, style: FontStyle = FontStyle.Normal ): Font = ResourceFont(resource, weight, style)

@terrakok, we need to do that as soon as possible. painterResource and Font technically of one kind of features, better to deprecated them in one release.

Why? The resource: String is not a file path here. It is a name in the system

It is actually a file path. See

compose-multiplatform-core/compose/desktop/desktop/samples/src/jvmMain/kotlin/androidx/compose/desktop/examples/example1/Main.jvm.kt

Line 152 in eece65f

Font("NotoSans-Italic.ttf")

compose/ui/ui/src/desktopMain/kotlin/androidx/compose/ui/res/DesktopSvgResources.desktop.kt

…ClassLoaderResourceLoader.

compose/ui/ui/src/desktopMain/kotlin/androidx/compose/ui/res/Resources.desktop.kt

igordmn · 2024-09-03T13:27:48Z

compose/ui/ui/src/desktopMain/kotlin/androidx/compose/ui/res/Resources.desktop.kt

-@ExperimentalComposeUiApi
-class ClassLoaderResourceLoader : ResourceLoader {
-    override fun load(resourcePath: String): InputStream {
+@Deprecated("Migrate to the Compose resources library. See https://www.jetbrains.com/help/kotlin-multiplatform-dev/compose-images-resources.html")


Suggested change

@Deprecated("Migrate to the Compose resources library. See https://www.jetbrains.com/help/kotlin-multiplatform-dev/compose-images-resources.html")

igordmn · 2024-09-03T13:28:07Z

Let's wait for a second approval

Nohus · 2024-09-22T10:59:02Z

@terrakok I believe this broke org.jetbrains.compose.animatedimage.loadResourceAnimatedImage. You can no longer load gifs from composeResources/files/image.gif. You have to instead move them to the normal non-Compose resources/image.gif. That's an unannounced breaking change in org.jetbrains.compose.components:components-animatedimage-desktop:1.7.0-beta02 that I found out about by user reports of crashing.

terrakok · 2024-09-23T09:06:39Z

I checked it with the code and it works:

@Composable
internal fun App() = AppTheme {
    val (gif, setGif) = remember { mutableStateOf<AnimatedImage?>(null) }
    LaunchedEffect(Unit) {
        setGif(loadAnimatedImage(Res.getUri("files/olaf.gif")))
    }
    if (gif != null) {
        Image(
            modifier = Modifier.size(100.dp),
            bitmap = gif.animate(),
            contentDescription = null
        )
    }
}

If you have a problem then file an issue on the YouTrack, please

terrakok requested a review from igordmn July 18, 2024 14:08

igordmn requested a review from m-sasha July 18, 2024 15:40

igordmn reviewed Jul 18, 2024

View reviewed changes

MatkovIvan reviewed Jul 18, 2024

View reviewed changes

terrakok added 2 commits August 30, 2024 11:05

CMP-1108: Deprecate resources in compose.ui in favour of the new re…

32c2c0e

…source library

Add an url to the doc for the resources deprecation message.

7668150

terrakok force-pushed the k.tskh/CMP-1108 branch from 037d679 to 7668150 Compare August 30, 2024 09:20

terrakok requested review from MatkovIvan and igordmn and removed request for m-sasha August 30, 2024 09:25

Delete the experimental annotation from deprecated methods.

07cd351

MatkovIvan reviewed Aug 30, 2024

View reviewed changes

Add ReplaceWith suggestions for deprecated methods.

dddb9b6

igordmn reviewed Sep 3, 2024

View reviewed changes

terrakok added 2 commits September 3, 2024 14:08

Delete experimental FileResourceLoader and make private experimental …

12d8fc9

…ClassLoaderResourceLoader.

Add a link to the migration snippet in painter's deprecation methods.

8c81a2f

igordmn reviewed Sep 3, 2024

View reviewed changes

compose/ui/ui/src/desktopMain/kotlin/androidx/compose/ui/res/Resources.desktop.kt Outdated Show resolved Hide resolved

compose/ui/ui/src/desktopMain/kotlin/androidx/compose/ui/res/Resources.desktop.kt Outdated Show resolved Hide resolved

Delete internal experimental methods.

f97c16f

igordmn reviewed Sep 3, 2024

View reviewed changes

igordmn approved these changes Sep 3, 2024

View reviewed changes

terrakok requested a review from MatkovIvan September 3, 2024 15:24

Delete a deprecation message on the private ClassLoaderResourceLoader.

6cd108f

MatkovIvan approved these changes Sep 4, 2024

View reviewed changes

Dump updated resources API.

b34d814

terrakok merged commit bd28372 into jb-main Sep 4, 2024
6 checks passed

terrakok deleted the k.tskh/CMP-1108 branch September 4, 2024 10:17

rock3r mentioned this pull request Sep 14, 2024

Upgrade to CMP 1.7.0-beta02 JetBrains/jewel#594

Closed

JetBrains locked and limited conversation to collaborators Sep 23, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

CMP-1108: Deprecate resources in `compose.ui` in favour of the new resource library #1457

CMP-1108: Deprecate resources in `compose.ui` in favour of the new resource library #1457

terrakok commented Jul 18, 2024 •

edited

Loading

MatkovIvan Jul 18, 2024

terrakok Aug 30, 2024

MatkovIvan Sep 3, 2024

terrakok commented Aug 28, 2024 •

edited

Loading

MatkovIvan left a comment

igordmn commented Aug 30, 2024 •

edited

Loading

igordmn Sep 3, 2024

igordmn Sep 3, 2024

terrakok Sep 3, 2024 •

edited

Loading

igordmn Sep 3, 2024

igordmn Sep 3, 2024

igordmn commented Sep 3, 2024

Nohus commented Sep 22, 2024 •

edited

Loading

terrakok commented Sep 23, 2024

		@ExperimentalComposeUiApi
		@Deprecated("Migrate to the compose resources library")

CMP-1108: Deprecate resources in compose.ui in favour of the new resource library #1457

CMP-1108: Deprecate resources in compose.ui in favour of the new resource library #1457

Conversation

terrakok commented Jul 18, 2024 • edited Loading

Migration snippet

Release Notes

Breaking changes - Resources

MatkovIvan Jul 18, 2024

Choose a reason for hiding this comment

terrakok Aug 30, 2024

Choose a reason for hiding this comment

MatkovIvan Sep 3, 2024

Choose a reason for hiding this comment

terrakok commented Aug 28, 2024 • edited Loading

MatkovIvan left a comment

Choose a reason for hiding this comment

igordmn commented Aug 30, 2024 • edited Loading

igordmn Sep 3, 2024

Choose a reason for hiding this comment

igordmn Sep 3, 2024

Choose a reason for hiding this comment

terrakok Sep 3, 2024 • edited Loading

Choose a reason for hiding this comment

igordmn Sep 3, 2024

Choose a reason for hiding this comment

igordmn Sep 3, 2024

Choose a reason for hiding this comment

igordmn commented Sep 3, 2024

Nohus commented Sep 22, 2024 • edited Loading

terrakok commented Sep 23, 2024

CMP-1108: Deprecate resources in `compose.ui` in favour of the new resource library #1457

CMP-1108: Deprecate resources in `compose.ui` in favour of the new resource library #1457

terrakok commented Jul 18, 2024 •

edited

Loading

terrakok commented Aug 28, 2024 •

edited

Loading

igordmn commented Aug 30, 2024 •

edited

Loading

terrakok Sep 3, 2024 •

edited

Loading

Nohus commented Sep 22, 2024 •

edited

Loading