https://github.com/GIGAMOLE/ComposeShadowsPlus
ComposeShadowsPlus: Elevate your Android Compose UI with stunning custom shadows
https://github.com/GIGAMOLE/ComposeShadowsPlus
android android-compose android-library android-ui design-tools jetpack-compose kotlin kotlin-android modifiers sample-app
Last synced: 20 days ago
JSON representation
ComposeShadowsPlus: Elevate your Android Compose UI with stunning custom shadows
- Host: GitHub
- URL: https://github.com/GIGAMOLE/ComposeShadowsPlus
- Owner: GIGAMOLE
- License: mit
- Created: 2023-06-13T08:46:47.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-19T13:37:48.000Z (about 1 year ago)
- Last Synced: 2024-08-02T19:38:04.729Z (9 months ago)
- Topics: android, android-compose, android-library, android-ui, design-tools, jetpack-compose, kotlin, kotlin-android, modifiers, sample-app
- Language: Kotlin
- Homepage: https://www.linkedin.com/in/gigamole/
- Size: 29.7 MB
- Stars: 171
- Watchers: 1
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
- awesome-list - GIGAMOLE/ComposeShadowsPlus - ComposeShadowsPlus: Elevate your Android Compose UI with stunning custom shadows (Kotlin)
README
 | [Setup Guide](#setup)
| [Report new issue](https://github.com/GIGAMOLE/ComposeShadowsPlus/issues/new)
# ComposeShadowsPlus
`ComposeShadowsPlus` is a powerful Android Compose library that empowers developers with the ability to easily create and customize stunning, high-quality shadows for
their UI elements.
Features:
- Android Compose custom shadows with offset, color, and spread support.
- `NativePaint.setShadowLayer(...)` & `View.LAYER_TYPE_SOFTWARE` based custom shadow.
- `RenderScript` & `ScriptIntrinsicBlur` based custom shadow.
- Advanced [sample app](#sample-app).
## Sample App
| RSBlur | SoftLayer | Elevation | Alpha Content |
|-|-|-|-|
| 
| 
| 
| 
|
Download or clone this repository to discover the sample app.
## Setup
Add to the root `build.gradle.kts`:
``` groovy
allprojects {
repositories {
...
maven("https://jitpack.io")
}
}
```
Add to the package `build.gradle.kts`:
``` groovy
dependencies {
implementation("com.github.GIGAMOLE:ComposeShadowsPlus:{latest-version}")
}
```
Latest version: .
Also, it's possible to download the latest artifact from the [releases page](https://github.com/GIGAMOLE/ComposeShadowsPlus/releases).
## Guide
`ComposeShadowsPlus` provides two custom shadow `Modifiers`: [RSBlurShadow](#rsblurshadow) and [SoftLayerShadow](#softlayershadow).
`ComposeShadowsPlus` common params:
| Param | Description |
|-|-|
|`radius`|The shadow radius.|
|`color`|The shadow color.|
|`shape`|The shadow shape.|
|`spread`|The shadow positive or negative spread.|
|`offset`|The shadow offset.|
|`isAlphaContentClip`|Indicates if shadow is clipped for alpha content.|
`ShadowsPlusDefaults` contains default values of custom shadows.
You can use `Modifier.shadowsPlus(...)` to set the custom shadows with the `ShadowsPlusType` enum.
### RSBlurShadow
`RSBlurShadow` uses `RenderScript` and `ScriptIntrinsicBlur` to blur the shadow content to simulate the shadow.
`RSBlurShadow` more params:
| Param | Description |
|-|-|
|`alignRadius`|The exponential align radius indicator.|
To apply `RSBlurShadow` use `Modifier.rsBlurShadow(...)`.
### SoftLayerShadow
`SoftLayerShadow` uses `NativePaint.setShadowLayer(...)` to apply the native shadow layer to the shadow content.
To render `SoftLayerShadow`, Android devices with API < 28(P), need to use `View.LAYER_TYPE_SOFTWARE`. It's recommended to use `SoftLayerShadowContainer` to handle this
automatically.
To apply `SoftLayerShadow` use `Modifier.softLayerShadow(...)`.
### Elevation
To use clipped shadow for alpha content with `elevation`(Android Compose `.shadow(...)`), wrap your content with `AlphaContentElevationShadow`.
If you want the clipped `elevation` as `Modifier` use [shadow-gadgets library](https://github.com/zed-alpha/shadow-gadgets).
## License
MIT License. See the [LICENSE](https://github.com/GIGAMOLE/ComposeShadowsPlus/blob/master/LICENSE) file for more details.
## Credits
Special thanks to the [GoDaddy](https://github.com/godaddy) for the amazing [color picker library](https://github.com/godaddy/compose-color-picker).
## Author:
[Basil Miller](https://www.linkedin.com/in/gigamole/)
[[email protected]](mailto:[email protected])