Features

• Modular Design: Easily integrate into your existing Compose projects.
• Customizability: Fully customizable UI components with support for custom icons, colors, and typography.
• Simplicity: Minimal setup required—get started with just a few lines of code.
• Animation Ready: Animate your banners for a more engaging user experience.
• Lightweight: Minimal impact on your build size and runtime performance.

Samples

Here's how it looks:

Installation

Compose Alert Banner is available as a Gradle dependency on mavenCentral. You can add it to your project by including the following in your build.gradle.kts file:

repositories {
    mavenCentral()
}

dependencies {
    implementation("com.mofeejegi.alert:alert-banner-compose:<latest-version>")
}

Replace <latest-version> with the current release version available in the Releases section.

Usage

Integrating the alert banner into your Compose application is straightforward. Below is a simple example to get you started:

@Composable
fun MyApp() {
    MaterialTheme {
        AlertBanner(darkTheme = false) { // Declare this at the root of your application

            // This is accessible at any part of your application
            val alertManager = rememberAlertManager()

            Column(modifier = Modifier.fillMaxSize()) {
                Button(onClick = { alertManager.show("Error", AlertBannerType.Error) }) {
                    Text("Show Error Alert")
                }

                Button(onClick = { alertManager.show("Success", AlertBannerType.Success) }) {
                    Text("Show Success Alert")
                }
            }
        }
    }
}

Configuration & Customization

Compose Alert Banner offers multiple configuration options:

• Theme Customization: Override default color schemes and typography.
• Icon Support: Use any Material Icon or your own custom vector to match your design.
• Animation: Configure entrance and exit animations for the banner.
• Callbacks: Implement custom click or dismiss callbacks to run your own business logic.

Contributing

Contributions, issues, and feature requests are welcome! Please:

1. Fork the repository.
2. Create a branch (git checkout -b feature/YourFeature).
3. Commit your changes (git commit -am 'Add new feature').
4. Push to the branch (git push origin feature/YourFeature).
5. Open a pull request describing your changes.

Be sure to follow the existing code style and include tests where applicable.

License

This project is licensed under the Apache License 2.0. See the LICENSE file for details.

Contact

For questions or suggestions, open an issue or reach out directly:

• Maintainer: mofeejegi