Skip to content

A Lightweight and Highly-customizable alert library for Android, usable in both Java and Kotlin.

License

Notifications You must be signed in to change notification settings

mooner1022/PeekAlert

Repository files navigation


PeekAlert

A Lightweight and Highly-customizable alert library

PeekAlert can be used on both Java and Kotlin.
See the examples below for more info.

✔ Any PRs are welcome!

Demo

Installation (Gradle)

  • Add jitpack url

Kotlin DSL:

repositories {
    /* ... */
    maven(url = "https://jitpack.io")
}

Groovy DSL:

repositories {
    /* ... */
    maven { url 'https://jitpack.io' }
}
  • Add PeekAlert dependency
dependencies {
    implementation("com.github.mooner1022:PeekAlert:<VERSION>")
}

Usage

Basic usages

Java

PeekAlert peekAlert = PeekAlert.create(this)
                .setDraggable(true)
                .setTitle("Hello, PeekAlert!")
                .setText("Lorem ipsum dolor sit amet, consectetur adipiscing elit.");

peekAlert.peek();

Kotlin

val peekAlert = PeekAlert.create(this)
            .setDraggable(true)
            .setTitle("Hello, PeekAlert!")
            .setText("Lorem ipsum dolor sit amet, consectetur adipiscing elit.")

peekAlert.peek()

Builder for kotlin is also available:

createPeekAlert(this) {
    draggable = true
    title("Hello, PeekAlert Builder!") {
        textColor(res = R.color.black)
    }
    text("Lorem ipsum dolor sit amet, consectetur adipiscing elit.") {
        textSize = 14f
    }
}.peek()

Custom

To be documented...

Get more info at docs

Dokka Docs

License

MIT License

Copyright (c) 2023 Minki Moon

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.