stripe-ui-core/com.stripe.android.uicore.image

Package-level declarations

Types

ImageLruDiskCache

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

class ImageLruDiskCache(context: Context, cacheFolder: String, maxSizeBytes: Long = 10L * 1024 * 1024)

Implementation of disk cache based on DiskLruCache.

ImageLruMemoryCache

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

class ImageLruMemoryCache(val maxSize: Int = (Runtime.getRuntime().maxMemory() / 1024).toInt() / 8)

Implementation of in-memory cache based on LruCache.

NetworkImageDecoder

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

class NetworkImageDecoder

StripeImageLoader

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

class StripeImageLoader(context: Context, logger: Logger = Logger.getInstance(context.isDebuggable()), memoryCache: ImageLruMemoryCache? = ImageLruMemoryCache(), networkImageDecoder: NetworkImageDecoder = NetworkImageDecoder(), diskCache: ImageLruDiskCache? = ImageLruDiskCache( context = context, cacheFolder = "stripe_image_cache" ))

Image loader that fetches images from memory, disk or network and runs cache policy accordingly.

Properties

TEST_TAG_IMAGE_FROM_URL

@VisibleForTesting

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

const val TEST_TAG_IMAGE_FROM_URL: String

Functions

getDrawableFromUri

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

fun Context.getDrawableFromUri(uri: Uri): Drawable?

Given a local Uri created from resource, content or local file, try to create a Drawable from it.

rememberDrawablePainter

@Composable

fun rememberDrawablePainter(drawable: Drawable?): Painter

Remembers Drawable wrapped up as a Painter. This function attempts to un-wrap the drawable contents and use Compose primitives where possible.

StripeImage

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

@Composable

fun StripeImage(url: String, imageLoader: StripeImageLoader, contentDescription: String?, modifier: Modifier = Modifier, contentScale: ContentScale = ContentScale.Fit, colorFilter: ColorFilter? = null, debugPainter: Painter? = null, alignment: Alignment = Alignment.Center, disableAnimations: Boolean = false, errorContent: @Composable BoxWithConstraintsScope.() -> Unit = {}, loadingContent: @Composable BoxWithConstraintsScope.() -> Unit = {})

A composable that executes an image request asynchronously using the provided StripeImageLoader and renders the result.