https://github.com/Karn/notify

Simplified notification construction and delivery for Android.
https://github.com/Karn/notify

android android-notifications kotlin kotlin-android kotlin-library notifications

Last synced: 16 days ago
JSON representation

Simplified notification construction and delivery for Android.

• Host: GitHub
• URL: https://github.com/Karn/notify
• Owner: Karn
• License: mit
• Created: 2018-04-20T14:06:02.000Z (about 6 years ago)
• Default Branch: develop
• Last Pushed: 2022-12-23T16:41:24.000Z (over 1 year ago)
• Last Synced: 2024-02-23T01:32:52.295Z (4 months ago)
• Topics: android, android-notifications, kotlin, kotlin-android, kotlin-library, notifications
• Language: Kotlin
• Homepage:
• Size: 3.95 MB
• Stars: 822
• Watchers: 7
• Forks: 59
• Open Issues: 19
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md

Lists

• awesome-kotlin - notify - Simplified notification construction and delivery for Android. (Libraries)
• awesome-kotlin - notify - Simplified notification construction and delivery for Android. (Libraries)

README

        
![Notify](./docs/assets/notify-logo.svg)

## Notify

Simplified notification construction for Android.

[![Kotlin](https://img.shields.io/badge/Kotlin-1.3.11-blue.svg?style=flat-square)](http://kotlinlang.org)

[![AndroidX](https://img.shields.io/badge/AndroidX-1.0-6ab344.svg?style=flat-square)](https://developer.android.com/jetpack/androidx/)

[![Build Status](https://img.shields.io/travis/Karn/notify.svg?style=flat-square)](https://travis-ci.org/Karn/notify)

[![Codecov](https://img.shields.io/codecov/c/github/karn/notify.svg?style=flat-square)](https://codecov.io/gh/Karn/notify)

[![GitHub (pre-)release](https://img.shields.io/github/release/karn/notify/all.svg?style=flat-square)

](./../../releases)

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2FKarn%2Fnotify.svg?type=small)](https://app.fossa.io/projects/git%2Bgithub.com%2FKarn%2Fnotify?ref=badge_small)

Notify is a Fluent API for Android notifications which lets you build notifications without worrying how they'll look across devices or API versions. You can bring deterministic notifications to your Android projects with clarity & ease so you can finally stop fighting Developer documentation and get back to dev work that really matters.

#### GETTING STARTED

Notify (pre-)releases are available via JitPack. It is recommended that  a specific release version is selected when using the library in production as there may be breaking changes at anytime.

> **Tip:** Test out the canary channel to try out features by using the latest develop snapshot; `develop-SNAPSHOT`.

```Groovy

// Project level build.gradle

// ...

repositories {

    maven { url 'https://jitpack.io' }

}

// ...

// Module level build.gradle

dependencies {

    // Replace version with release version, e.g. 1.0.0-alpha, -SNAPSHOT

    implementation "io.karn:notify:[VERSION]"

}

```

#### USAGE

The most basic case is as follows:

```Kotlin

Notify

    .with(context)

    .content { // this: Payload.Content.Default

        title = "New dessert menu"

        text = "The Cheesecake Factory has a new dessert for you to try!"

    }

    .show()

```

![Basic usecase](./docs/assets/default.svg)

If you run into a case in which the library does not provide the requisite builder functions you can get the `NotificationCompat.Builder` object and continue to use it as you would normally by calling `NotifyCreator#asBuilder()`.

> **Tip:** You can view other notification styles on the [Notification Types](./docs/types.md) docs page.

> **Tip:** Advanced usage topics are documented [here](./docs/advanced.md).

#### CONTRIBUTING

There are many ways to [contribute](./.github/CONTRIBUTING.md), you can

- submit bugs,

- help track issues,

- review code changes.