Merge pull request #183 from skydoves/feature/remember-image-states

Implement Glide, Coil, Fresco image states remembering functions

coil/api/coil.api

@@ -60,3 +60,7 @@ public final class com/skydoves/landscapist/coil/LocalCoilProviderKt {
 	public static final fun getLocalCoilImageLoader ()Landroidx/compose/runtime/ProvidableCompositionLocal;
 }
 
+public final class com/skydoves/landscapist/coil/RememberCoilImageStateKt {
+	public static final fun rememberCoilImageState (Lcom/skydoves/landscapist/coil/CoilImageState;Ljava/lang/Object;Landroidx/compose/runtime/Composer;II)Lcom/skydoves/landscapist/coil/CoilImageState;
+}
+

coil/src/main/kotlin/com/skydoves/landscapist/coil/RememberCoilImageState.kt

@@ -0,0 +1,31 @@
+/*
+ * Designed and developed by 2020-2022 skydoves (Jaewoong Eum)
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.skydoves.landscapist.coil
+
+import androidx.compose.runtime.Composable
+import androidx.compose.runtime.remember
+
+/**
+ * Create and remember [CoilImageState].
+ *
+ * @param initialState The initial state of [CoilImageState].
+ * @param key The key that may trigger recomposition.
+ */
+@Composable
+public fun rememberCoilImageState(
+  initialState: CoilImageState = CoilImageState.None,
+  key: Any?
+): CoilImageState = remember(key1 = key) { initialState }

fresco/api/fresco.api

@@ -54,3 +54,7 @@ public final class com/skydoves/landscapist/fresco/LocalFrescoProviderKt {
 	public static final fun getLocalFrescoImageRequest ()Landroidx/compose/runtime/ProvidableCompositionLocal;
 }
 
+public final class com/skydoves/landscapist/fresco/RememberFrescoImageStateKt {
+	public static final fun rememberFrescoImageState (Lcom/skydoves/landscapist/fresco/FrescoImageState;Ljava/lang/Object;Landroidx/compose/runtime/Composer;II)Lcom/skydoves/landscapist/fresco/FrescoImageState;
+}
+

fresco/src/main/kotlin/com/skydoves/landscapist/fresco/RememberFrescoImageState.kt

@@ -0,0 +1,31 @@
+/*
+ * Designed and developed by 2020-2022 skydoves (Jaewoong Eum)
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.skydoves.landscapist.fresco
+
+import androidx.compose.runtime.Composable
+import androidx.compose.runtime.remember
+
+/**
+ * Create and remember [FrescoImageState].
+ *
+ * @param initialState The initial state of [FrescoImageState].
+ * @param key The key that may trigger recomposition.
+ */
+@Composable
+public fun rememberFrescoImageState(
+  initialState: FrescoImageState = FrescoImageState.None,
+  key: Any?
+): FrescoImageState = remember(key1 = key) { initialState }

glide/api/glide.api

@@ -59,3 +59,7 @@ public final class com/skydoves/landscapist/glide/LocalGlideProviderKt {
 	public static final fun getLocalGlideRequestOptions ()Landroidx/compose/runtime/ProvidableCompositionLocal;
 }
 
+public final class com/skydoves/landscapist/glide/RememberGlideImageStateKt {
+	public static final fun rememberGlideImageState (Lcom/skydoves/landscapist/glide/GlideImageState;Ljava/lang/Object;Landroidx/compose/runtime/Composer;II)Lcom/skydoves/landscapist/glide/GlideImageState;
+}
+

glide/src/main/kotlin/com/skydoves/landscapist/glide/RememberGlideImageState.kt

@@ -0,0 +1,31 @@
+/*
+ * Designed and developed by 2020-2022 skydoves (Jaewoong Eum)
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.skydoves.landscapist.glide
+
+import androidx.compose.runtime.Composable
+import androidx.compose.runtime.remember
+
+/**
+ * Create and remember [GlideImageState].
+ *
+ * @param initialState The initial state of [GlideImageState].
+ * @param key The key that may trigger recomposition.
+ */
+@Composable
+public fun rememberGlideImageState(
+  initialState: GlideImageState = GlideImageState.None,
+  key: Any?
+): GlideImageState = remember(key1 = key) { initialState }

landscapist/src/main/kotlin/com/skydoves/landscapist/components/RememberImageComponent.kt

@@ -19,7 +19,7 @@ import androidx.compose.runtime.Composable
 import androidx.compose.runtime.remember
 
 /**
- * Create and remember the new instance of [ImageComponent] that implements [ImagePluginComponent]
+ * Create and remember a new instance of [ImageComponent] that implements [ImagePluginComponent]
  * on the memory.
  *
  * @param block The receiver of an instance of [ImagePluginComponent].