Skip to content

Commit c3f734d

Browse files
committed
Release 1.5.0
1 parent 01f1ac7 commit c3f734d

4 files changed

Lines changed: 27 additions & 4 deletions

File tree

CHANGELOG.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
# CHANGELOG
22

3+
## 1.5.0
4+
_2021-07-03_
5+
6+
Introduce the `deferred-resources-compose-adapter` artifact for Jetpack Compose UI. This provides
7+
APIs for resolving existing Deferred Resources types in a Compose UI context. For example,
8+
`rememberResolvedColor` resolves a `DeferredColor` as an `androidx.compose.ui.graphics.Color`.
9+
10+
Compile with Kotlin 1.5.10 and AndroidX Core-KTX 1.5.0.
11+
312
## 1.4.0
413
_2021-04-23_
514

README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,7 @@ repository](https://oss.sonatype.org/#view-repositories;snapshots~browsestorage)
1818
```groovy
1919
implementation "com.backbase.oss.deferredresources:deferred-resources:$version"
2020
implementation "com.backbase.oss.deferredresources:deferred-resources-view-extensions:$version"
21-
22-
// Experimental, unstable Compose adapter is available only as a snapshot:
23-
implementation "com.backbase.oss.deferredresources:deferred-resources-compose-adapter:$version-SNAPSHOT"
21+
implementation "com.backbase.oss.deferredresources:deferred-resources-compose-adapter:$version"
2422
```
2523

2624
## Use
@@ -96,6 +94,7 @@ val icon: Painter = rememberResolvedPainter(deferredDrawable)
9694
```
9795

9896
All of these APIs are marked as `@ExperimentalComposeAdapter` and should not be considered stable.
97+
Their behavior and binary compatibility are not guaranteed.
9998

10099
## License
101100
```

build.gradle

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ buildscript {
3838

3939
ext {
4040
publishGroup = 'com.backbase.oss.deferredresources'
41-
libraryVersion = '1.5.0-SNAPSHOT'
41+
libraryVersion = '1.5.0'
4242
minSdk = 14
4343
minSdkCompose = 21
4444
targetSdk = 30

docs/index.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,20 @@ val deferredPlurals: DeferredPlurals = deferredFormattedPlurals.withFormatArgs("
6969

7070
All text-related types can eventually be converted to `DeferredText` through similar extensions.
7171

72+
### Jetpack Compose UI
73+
74+
For each Deferred Resources type, the experimental `deferred-resource-compose-adapter` library
75+
offers a `remember*` function to resolve the Deferred item to a standard Compose UI type.
76+
77+
```kotlin
78+
val color: Color = rememberResolvedColor(deferredColor)
79+
val size: Dp = rememberResolvedDp(deferredDimension)
80+
val icon: Painter = rememberResolvedPainter(deferredDrawable)
81+
```
82+
83+
All of these APIs are marked as `@ExperimentalComposeAdapter` and should not be considered stable.
84+
Their behavior and binary compatibility are not guaranteed.
85+
7286
## Import
7387

7488
To use Deferred Resources, add the library as a dependency to your Android module:
@@ -77,5 +91,6 @@ To use Deferred Resources, add the library as a dependency to your Android modul
7791
dependencies {
7892
implementation "com.backbase.oss.deferredresources:deferred-resources:$version"
7993
implementation "com.backbase.oss.deferredresources:deferred-resources-view-extensions:$version"
94+
implementation "com.backbase.oss.deferredresources:deferred-resources-compose-adapter:$version"
8095
}
8196
```

0 commit comments

Comments
 (0)