ImageTool
0.0.2indexedFacilitates image downloading and caching from various sources, offering compose widgets for display, customizable modifiers, alignment, scaling, opacity, and error handling.
8
Stars
—
Used by
dependents
—
Health
/ 100
🖼️ ImageTool
ImageTool is a Kotlin multiplatform library that provides the ability to download and cache images from network, storage and etc. Now library available on Android and IOS platforms
Implementation
For Kotlin DSL :
implementation("io.github.tanexc:imagetool:[version]")
For Groovy DSL :
implementation "io.github.tanexc:imagetool:[version]"
For libs.version.toml :
Add implementation(libs.imagetool) to build.gradle.kts and
[versions]
imagetool-version="version"
#...
[libraries]
#...
imagetool = { module = "io.github.tanexc:imagetool", version.ref = "imagetool-version" }
Usage
At this moment available just one widget to use:
@Composable
fun
model - String URL to get image from network
contentDescription - Description of the image
modififer - Modifier that will be applied to box where image lies
alignment - Optional alignment parameter used to place the ImageBitmap in the given bounds defined by the width and height
contentScale - Represents a rule to apply to scale a source image to be inscribed into the box
alpha - Optional opacity to be applied to the ImageBitmap when it is rendered on screen
colorFilter - Optional ColorFilter to apply for the image when it is rendered
filterQuality - Sampling algorithm applied to the bitmap when it is scaled and drawn into the destination. The default is FilterQuality. Low which scales using a bilinear sampling algorithm
cacheQuality - Optional cache quality parameter used to set quality of cached image. Can be CacheQuality.NoCaching that says image would not be cached
onLoading - Composable that will be displayed on loading. Receives float progress from 0.0 to 1.0
onError - Composable that will be displayed when loading failed. Receives Throwable that represents Exception has been caught
In future
- Add more type to use as model for image
- Add more target platfroms
Tech stack
-
Kotlin Multiplatform and based
Have suggestions or questions?
Contact me here:
Find this repository useful? :heart:
Support it by joining stargazers for this repository. :star:
And follow me!
License
Designed and developed by 2024 Tanexc
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.