Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/amirisback/frogo-notification
Frogo Notification - Easy Way For Create Notification
https://github.com/amirisback/frogo-notification
android android-application android-development android-library android-notification android-notifications kotlin library notification-service notifications
Last synced: 14 days ago
JSON representation
Frogo Notification - Easy Way For Create Notification
- Host: GitHub
- URL: https://github.com/amirisback/frogo-notification
- Owner: amirisback
- License: apache-2.0
- Created: 2020-12-26T04:04:30.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2022-03-28T17:05:35.000Z (over 2 years ago)
- Last Synced: 2024-10-09T19:25:58.743Z (25 days ago)
- Topics: android, android-application, android-development, android-library, android-notification, android-notifications, kotlin, library, notification-service, notifications
- Language: Kotlin
- Homepage: https://amirisback.github.io/frogo-notification/
- Size: 25 MB
- Stars: 52
- Watchers: 3
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-project-catalogue - Click Here
README
## Alert
- Please Move To [FrogoSDK](github.com/frogobox/frogo-sdk)
- Not Developed Again
## About This Project
[](https://android-arsenal.com/details/1/8318)
[](https://jitpack.io/#amirisback/frogo-notification)
[](https://github.com/amirisback/frogo-notification/actions/workflows/android-ci.yml)
[](https://github.com/amirisback/frogo-notification/actions/workflows/detekt-analysis.yml)
- Privacy Policy [Click Here](https://github.com/amirisback/frogo-notification/blob/master/PRIVACY-POLICY.md)
- LICENSE [Click Here](https://github.com/amirisback/frogo-notification/blob/master/LICENSE)
- SDK for your notification problem to make easier developing android apps
- frogo-notification is under huge large development
- Notification with singleton method
- Simple and eazy to use
- With many feature
- Full documentation
- Custom Layout Notification
## Screenshoot Sample
Simple Notification
Stack Notification
Custom Notification (1)
Custom Notification (2)
## Version Release
This Is Latest Release
$version_release = 1.1.1
What's New??
* Update Build Gradle Version *
## Download this project
### Step 1. Add the JitPack repository to your build file (build.gradle : Project)
#### Groovy Gradle
// Add it in your root build.gradle at the end of repositories:
allprojects {
repositories {
...
maven { url 'https://jitpack.io' }
}
}
#### Kotlin DSL Gradle
```kotlin
// Add it in your root build.gradle.kts at the end of repositories:
allprojects {
repositories {
...
maven { url = uri("https://jitpack.io") }
}
}
```
### Step 2. Add the dependency (build.gradle : Module)
#### Groovy Gradle
dependencies {
// library frogo-notification
implementation 'com.github.amirisback:frogo-notification:1.1.1'
}
#### Kotlin DSL Gradle
dependencies {
// library frogo-notification
implementation("com.github.amirisback:frogo-notification:1.1.1")
}
### Step 3. Implement frogo-notification (Simple Notification)
```kotlin
FrogoNotification.Inject(this) // Intialize for Context
.setChannelId(CHANNEL_ID) // Intialize for Channel ID
.setChannelName(CHANNEL_NAME) // Initialize for Channel Name
.setContentIntent(pendingIntent) // Initialize for Content Intent
.setSmallIcon(R.drawable.ic_frogo_notif) // Initialize for Small Icon
.setLargeIcon(R.drawable.ic_frogo_notif) // Initialize for Large Icon
.setContentTitle(resources.getString(R.string.content_title)) // Initialize for Content Title
.setContentText(resources.getString(R.string.content_text)) // Initialize for Content Text
.setSubText(resources.getString(R.string.subtext)) // Initialize for Sub Text
.setupAutoCancel() // Initialize for Auto Cancel
.build() // Build the Frogo Notification
.launch(NOTIFICATION_ID) // Notify the Frogo Notification
```
## Feature frogo-notification
### Simple Notification
```kotlin
FrogoNotification.Inject(this) // Intialize for Context
.setChannelId(CHANNEL_ID) // Intialize for Channel ID
.setChannelName(CHANNEL_NAME) // Initialize for Channel Name
.setContentIntent(pendingIntent) // Initialize for Content Intent
.setSmallIcon(R.drawable.ic_frogo_notif) // Initialize for Small Icon
.setLargeIcon(R.drawable.ic_frogo_notif) // Initialize for Large Icon
.setContentTitle(resources.getString(R.string.content_title)) // Initialize for Content Title
.setContentText(resources.getString(R.string.content_text)) // Initialize for Content Text
.setSubText(resources.getString(R.string.subtext)) // Initialize for Sub Text
.setupAutoCancel() // Initialize for Auto Cancel
.build() // Build the Frogo Notification
.launch(NOTIFICATION_ID) // Notify the Frogo Notification
```
### Custom Layout (NEW FEATURE)
```kotlin
val collapsed = object : FrogoNotifCustomContentViewListener {
override fun setupCustomView(): Int {
return R.layout.notification_collapsed
}
override fun setupComponent(context: Context, customView: RemoteViews) {
customView.apply{
setTextViewText(R.id.text_view_collapsed_1, "Hello World!")
}
}
}
val expanded = object : FrogoNotifCustomContentViewListener {
override fun setupCustomView(): Int {
return R.layout.notification_expanded
}
override fun setupComponent(context: Context, customView: RemoteViews) {
customView.apply {
setImageViewResource(R.id.image_view_expanded, R.drawable.ic_android)
setOnClickPendingIntent(R.id.image_view_expanded, clickPendingIntent)
}
}
}
FrogoNotification.Inject(this) // Intialize for Context
.setChannelId(FrogoApp.CHANNEL_ID) // Intialize for Channel ID
.setChannelName(FrogoApp.CHANNEL_NAME) // Initialize for Channel Name
.setSmallIcon(R.drawable.ic_android) // Initialize for Small Icon
.setCustomContentView(collapsed)
.setCustomBigContentView(expanded)
.build() // Build the Frogo Notification
.launch(FrogoApp.NOTIFICATION_ID) // Notify the Frogo Notification
```
### With Action Replay
```kotlin
FrogoNotification.Inject(this)
.setChannelId(CHANNEL_ID)
.setChannelName(CHANNEL_NAME as String)
.setSmallIcon(R.drawable.ic_frogo_notif)
.setContentTitle(getString(R.string.notif_title))
.setContentText(getString(R.string.notif_content))
.setupShowWhen()
.setupActionRemoteInput(object : FrogoNotifActionRemoteInputListener {
override fun setRemoteInputResultKey(): String {
return KEY_REPLY
}
override fun setRemoteInputLabel(): String {
return getString(R.string.notif_action_reply)
}
override fun setActionIcon(): Int {
return R.drawable.ic_frogo_send
}
override fun setActionTitle(): String {
return getString(R.string.notif_action_reply)
}
override fun setActionIntent(): PendingIntent? {
return getReplyPendingIntent()
}
override fun setAllowGeneratedReplies(): Boolean {
return true
}
})
.build()
.launch(mNotificationId)
```
### With Inbox Style (Stack)
```kotlin
val frogoNotification = FrogoNotification.Inject(this)
.setChannelId(CHANNEL_ID)
.setChannelName(CHANNEL_NAME)
.setSmallIcon(R.drawable.ic_frogo_email)
.setGroup(GROUP_KEY_EMAILS)
.setContentIntent(pendingIntent)
.setupAutoCancel()
// Check if NotificationID is smaller than Max Notif
if (idNotification < MAX_NOTIFICATION) {
stackNotif[idNotification].message?.let {
frogoNotification
.setContentTitle("New Email from " + stackNotif[idNotification].sender)
.setContentText(it)
.setLargeIcon(R.drawable.ic_frogo_notif)
}
} else {
frogoNotification
.setContentTitle("$idNotification new emails")
.setContentText("[email protected]")
.setGroupSummary()
.setupInboxStyle(object : FrogoNotifInboxStyleListener {
override fun addLine1(): String {
return "New Email from " + stackNotif[idNotification].sender
}
override fun addLine2(): String {
return "New Email from " + stackNotif[idNotification - 1].sender
}
override fun setBigContentTitle(): String {
return "$idNotification new emails"
}
override fun setSummaryText(): String {
return "mail@frogobox"
}
})
}
frogoNotification
.build()
.launch(idNotification)
```
### With Frogo Style
```kotlin
FrogoNotification.Inject(this) // Intialize for Context
.setSmallIcon(R.drawable.ic_frogo_notif) // Initialize for Small Icon
.setupWithFrogoStyle()
.build() // Build the Frogo Notification
.launch(NOTIFICATION_ID) // Notify the Frogo Notification
```
### For Documentation
- Method with description [Click Here](https://github.com/amirisback/frogo-notification/blob/master/frogonotification/src/main/java/com/frogobox/frogonotification/IFrogoNotification.kt)
- Simple Notification [Click Here](https://github.com/amirisback/frogo-notification/blob/master/app/src/main/java/com/frogobox/notification/simple/MainActivity.kt)
- With Action Replay [Click Here](https://github.com/amirisback/frogo-notification/blob/master/app/src/main/java/com/frogobox/notification/custom/NotificationService.kt)
- With Inbox Style (Stack) [Click Here](https://github.com/amirisback/frogo-notification/blob/master/app/src/main/java/com/frogobox/notification/stack/StackNotifActivity.kt)
## Colaborator
Very open to anyone, I'll write your name under this, please contribute by sending an email to me
- Mail To [email protected]
- Subject : Github _ [Github-Username-Account] _ [Language] _ [Repository-Name]
- Example : Github_amirisback_kotlin_admob-helper-implementation
Name Of Contribute
- Muhammad Faisal Amir
- Waiting List
- Waiting List
Waiting for your contribute
## Attention !!!
- Please enjoy and don't forget fork and give a star
- Don't Forget Follow My Github Account
