Skip to content

Commit

Permalink
Prepare 3.0.0-alpha03.
Browse files Browse the repository at this point in the history
  • Loading branch information
colinrtwhite committed Jan 21, 2024
1 parent 3e50907 commit 313ad26
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 4 deletions.
8 changes: 8 additions & 0 deletions CHANGELOG.md
@@ -1,5 +1,13 @@
# Changelog

## [3.0.0-alpha03] - January 20, 2024

- **Breaking**: `coil-network` has been renamed to `coil-network-ktor`. Additionally, there is a new `coil-network-okhttp` artifact that depends on OkHttp and doesn't require specifying a Ktor engine.
- Depending on which artifact you import you can reference the `Fetcher.Factory` manually using `KtorNetworkFetcherFactory` or `OkHttpNetworkFetcherFactory`.
- Support loading `NSUrl` on Apple platforms.
- Add `clipToBounds` parameter to `AsyncImage`.
- [For the full list of important changes, check out the upgrade guide.](https://coil-kt.github.io/coil/upgrading_to_coil3/)

## [3.0.0-alpha02] - January 10, 2024

- **Breaking**: `coil-gif`, `coil-network`, `coil-svg`, and `coil-video`'s packages have been updated so all their classes are part of `coil.gif`, `coil.network`, `coil.svg`, and `coil.video` respectively. This helps avoid class name conflicts with other artifacts.
Expand Down
1 change: 1 addition & 0 deletions coil-core/src/androidMain/baseline-prof.txt
Expand Up @@ -1017,6 +1017,7 @@ HSPLcoil3/util/RealNetworkObserver;->onConnectivityChange(Landroid/net/Network;Z
Lcoil3/util/RealNetworkObserver$networkCallback$1;
HSPLcoil3/util/RealNetworkObserver$networkCallback$1;-><init>(Lcoil3/util/RealNetworkObserver;)V
HSPLcoil3/util/RealNetworkObserver$networkCallback$1;->onAvailable(Landroid/net/Network;)V
PLcoil3/util/RealNetworkObserver$networkCallback$1;->onLost(Landroid/net/Network;)V
Lcoil3/util/ServiceLoaderComponentRegistry;
HSPLcoil3/util/ServiceLoaderComponentRegistry;-><clinit>()V
HSPLcoil3/util/ServiceLoaderComponentRegistry;-><init>()V
Expand Down
16 changes: 13 additions & 3 deletions docs/upgrading_to_coil3.md
Expand Up @@ -38,11 +38,21 @@ The `coil-compose` artifact's APIs are mostly unchanged. You can continue using

## Network Images

**IMPORTANT** Coil's network image support was extracted into a separate artifact, `coil-network`, and now depends on [Ktor](https://ktor.io/) instead of [OkHttp](https://square.github.io/okhttp/). This means `coil` and `coil-core` no longer support network URLs by default and you'll need to import `coil-network` and [import a Ktor engine](https://ktor.io/docs/http-client-engines.html). Import these artifacts to continue loading images from network URLs:
**IMPORTANT** Coil's network image support was extracted out of `coil-core`. To load images from a network URL in Coil 3.0 you'll need to import a separate artifact, either:

- Import `coil-network-okhttp` if you prefer using [OkHttp](https://square.github.io/okhttp/). OkHttp is Android/JVM-only.

```kotlin
implementation("io.coil-kt.coil3:coil:[coil-version]")
implementation("io.coil-kt.coil3:coil-network-okhttp:[coil-version]")
```

- Import `coil-network-ktor` and a [Ktor engine](https://ktor.io/docs/http-client-engines.html) if you prefer using [Ktor](https://ktor.io/).

```kotlin
implementation("io.coil-kt.coil3:coil-network:3.0.0-alpha02")
implementation("io.ktor:ktor-client-okhttp:2.3.7")
implementation("io.coil-kt.coil3:coil:[coil-version]")
implementation("io.coil-kt.coil3:coil-network-ktor:[coil-version]")
implementation("io.ktor:ktor-client-android:[ktor-version]")
```

Check out the [`samples`](https://github.com/coil-kt/coil/tree/3.x/samples/compose) repository for examples.
Expand Down
2 changes: 1 addition & 1 deletion gradle.properties
Expand Up @@ -29,7 +29,7 @@ SONATYPE_HOST=DEFAULT
RELEASE_SIGNING_ENABLED=true

POM_GROUP_ID=io.coil-kt.coil3
POM_VERSION=3.0.0-SNAPSHOT
POM_VERSION=3.0.0-alpha03

POM_DESCRIPTION=An image loading library for Android and Compose Multiplatform.
POM_INCEPTION_YEAR=2019
Expand Down

0 comments on commit 313ad26

Please sign in to comment.