🛠️ Installation

ShadowGlow is available on Maven Central. Add the dependency to your build.gradle.kts (or build.gradle) file:

Kotlin DSL (build.gradle.kts):

dependencies {
    implementation("me.trishiraj:shadowglow:2.0.0") 
}

Groovy DSL (build.gradle):

dependencies {
    implementation 'me.trishiraj:shadowglow:2.0.0'
}

🚀 Usage Guide

Applying a shadow is as simple as using the Modifier.shadowGlow() extension.

Basic Solid Color Shadow

import androidx.compose.ui.Modifier
import androidx.compose.material3.Text
import androidx.compose.foundation.background
import androidx.compose.foundation.layout.padding
import androidx.compose.ui.graphics.Color
import androidx.compose.ui.unit.dp
import me.trishiraj.shadowGlow // Import the extension

// ...

Text(
    text = "Solid Shadow",
    modifier = Modifier
        .shadowGlow(
            color = Color.Black.copy(alpha = 0.5f),
            borderRadius = 8.dp,
            blurRadius = 10.dp,
            offsetX = 4.dp,
            offsetY = 4.dp
        )
        .background(Color.White) // Apply background to the composable itself
        .padding(16.dp)
)

Basic Gradient Shadow

import me.trishiraj.shadowGlow
// Import the extension
// ... other necessary imports

Text(
    text = "Gradient Shadow",
    modifier = Modifier
        .shadowGlow(
            gradientColors = listOf(Color.Magenta.copy(alpha = 0.6f), Color.Blue.copy(alpha = 0.6f)),
            borderRadius = 12.dp,
            blurRadius = 16.dp,
            offsetY = 8.dp
        )
        .background(Color.White)
        .padding(16.dp)
)

⚙️ Customization Deep Dive

ShadowGlow offers a rich set of parameters to tailor your shadows:

Common Parameters (for both solid and gradient shadows)

• borderRadius: Dp = 0.dp: The corner radius for the shadow shape.
• blurRadius: Dp = 8.dp: The primary blur radius for the shadow.
• offsetX: Dp = 0.dp: Static horizontal offset of the shadow.
• offsetY: Dp = 4.dp: Static vertical offset of the shadow.
• spread: Dp = 0.dp: Expands or contracts the shadow's boundaries before blurring. Positive values expand.
• blurStyle: ShadowBlurStyle = ShadowBlurStyle.NORMAL:
  • ShadowBlurStyle.NORMAL: Standard blur.
  • ShadowBlurStyle.SOLID: Solid, sharp-edged shadow (blur has no effect).
  • ShadowBlurStyle.OUTER: Blurs only the outer edge of the shadow.
  • ShadowBlurStyle.INNER: Blurs only the inner edge of the shadow (can create interesting inset effects if spread is negative).
• enableGyroParallax: Boolean = false: Set to true to enable the gyroscope-driven parallax effect.
• parallaxSensitivity: Dp = 4.dp: The maximum displacement (in Dp) for the parallax effect when the device is tilted.
• enableBreathingEffect: Boolean = false: Set to true to enable the breathing (pulsating blur) animation.
• breathingEffectIntensity: Dp = 4.dp: The maximum additional blur radius applied during one cycle of the breathing animation. The blur will animate between blurRadius and blurRadius + breathingEffectIntensity.
• breathingDurationMillis: Int = 1500: The duration (in milliseconds) for one full cycle of the breathing animation (e.g., expand and contract).

Glow Trail Effect

These parameters control the animated trail that can be drawn around the shape's border.

• enableGlowTrail: Boolean = false: Set to true to enable the animated glow trail.
• glowTrailWidth: Dp = 8.dp: The stroke width of the trail.
• glowTrailBlurRadius: Dp = 16.dp: The blur radius applied to the trail itself.
• glowTrailLengthDegrees: Float = 60f: The length of the trail segment, expressed in degrees (out of 360).
• glowTrailDurationMillis: Int = 2500: The time it takes for the trail to complete one full loop around the shape.
• glowTrailClockwise: Boolean = true: The direction of the trail animation.
• glowTrailAlpha: Float = 1f: The alpha transparency of the trail.

Solid Color Shadow Specific

• color: Color = Color.Black.copy(alpha = 0.4f): The solid color of the shadow.

Gradient Shadow Specific

• gradientColors: List<Color>: A list of colors to create the linear gradient.
• gradientStartFactorX: Float = 0f: The X-coordinate start factor for the gradient (0.0 for left, 1.0 for right of the composable).
• gradientStartFactorY: Float = 0f: The Y-coordinate start factor for the gradient (0.0 for top, 1.0 for bottom).
• gradientEndFactorX: Float = 1f: The X-coordinate end factor for the gradient.
• gradientEndFactorY: Float = 1f: The Y-coordinate end factor for the gradient.
• gradientColorStops: List<Float>? = null: Optional list of relative positions (0.0 to 1.0) for each color in gradientColors. If null, colors are distributed evenly.
• alpha: Float = 1.0f: Overall alpha transparency for the gradient shadow (0.0f to 1.0f).

Example: Fully Featured Shadow

import me.trishiraj.shadowGlow
import me.trishiraj.shadowGlow.ShadowBlurStyle
// ... other necessary imports

Text(
    text = "Feature-Rich Shadow",
    modifier = Modifier
        .shadowGlow(
            color = Color.Green.copy(alpha = 0.7f),
            borderRadius = 20.dp,
            blurRadius = 12.dp,
            offsetX = (-4).dp,
            offsetY = 8.dp,
            spread = 2.dp,
            blurStyle = ShadowBlurStyle.OUTER,
            enableGyroParallax = true,
            parallaxSensitivity = 6.dp,
            enableBreathingEffect = true,
            breathingEffectIntensity = 5.dp,
            breathingDurationMillis = 2000,
            enableGlowTrail = true,
            glowTrailWidth = 10.dp,
            glowTrailBlurRadius = 20.dp,
            glowTrailLengthDegrees = 90f,
            glowTrailDurationMillis = 2000,
            glowTrailClockwise = false,
            glowTrailAlpha = 0.8f
        )
        .background(Color.DarkGray)
        .padding(24.dp)
)

📚 API Reference

The primary API is the Modifier.shadowGlow() extension function. It has two overloads:

1. shadowGlow(color: Color, ...): For solid color shadows.
2. shadowGlow(gradientColors: List<Color>, ...): For gradient shadows.

Refer to the "Customization Deep Dive" section above for details on all available parameters and their default values. For more in-depth information, please refer to the KDoc comments within the source code. Or simply refer to the sample app given within app > src > ...MainActivity.kt

🙌 Contributing

Contributions are welcome! Whether it's bug reports, feature requests, or pull requests, please feel free to contribute.

1. Fork the repository.
2. Create your feature branch (git checkout -b feature/AmazingFeature).
3. Commit your changes (git commit -m 'Add some AmazingFeature').
4. Push to the branch (git push origin feature/AmazingFeature).
5. Open a Pull Request.

📜 License

ShadowGlow is licensed under the Apache License, Version 2.0. See the LICENSE file for details.