https://github.com/malekkamel/apphead
Head View like Facebook Messenger for Android.
https://github.com/malekkamel/apphead
android facebook facebookmessenger java java-8 kotlin kotlin-android kotlin-language kotlin-library view
Last synced: 5 months ago
JSON representation
Head View like Facebook Messenger for Android.
- Host: GitHub
- URL: https://github.com/malekkamel/apphead
- Owner: MalekKamel
- License: apache-2.0
- Created: 2019-11-08T14:47:20.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2020-02-23T20:04:00.000Z (almost 6 years ago)
- Last Synced: 2024-10-09T11:04:32.966Z (over 1 year ago)
- Topics: android, facebook, facebookmessenger, java, java-8, kotlin, kotlin-android, kotlin-language, kotlin-library, view
- Language: Kotlin
- Homepage:
- Size: 16.9 MB
- Stars: 72
- Watchers: 2
- Forks: 12
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
AppHead
===========
[]( https://android-arsenal.com/details/1/7974 )
Head View like Facebook Messenger for Android.
#### Gradle:
```groovy
allprojects {
repositories {
...
maven { url "https://jitpack.io" }
}
}
dependencies {
implementation 'com.github.ShabanKamell:AppHead:x.y.z'
}
```
(Please replace x, y and z with the latest version numbers: [](https://jitpack.io/#ShabanKamell/AppHead))
### Usage
The most simple usage
``` kotlin
AppHead.create(R.drawable.ic_messenger) {
headView { onClick {..} }
}.show(activity)
```
Or using builders (proper for Java)
``` kotlin
builder = Head.Builder(R.drawable.icon).headView(HeadView.Args().onClick {..})
AppHead(builder).show(activity)
```
All available options
``` kotlin
AppHead.create(R.drawable.ic_messenger_red) {
headView {
layoutRes(R.layout.app_head_red, R.id.headImageView)
onClick {..}
onLongClick {..}
alpha(0.9f)
allowBounce(false)
onFinishInflate {..}
setupImage {..}
onDismiss {..}
dismissOnClick(false)
preserveScreenLocation(false)
}
badgeView {
count("100")
position(BadgeView.Position.TOP_END)
}
dismissView {
alpha(0.5f)
scaleRatio(1.0)
drawableRes(R.drawable.ic_dismiss)
onFinishInflate {..}
setupImage {..}
}
}.show(this)
```
Or using builders (proper for Java)
``` kotlin
// build HeadView
val headViewArgs = HeadView.Args()
.layoutRes(R.layout.app_head_red, R.id.headImageView)
.onClick {..}
.onLongClick {..}
.alpha(0.8f)
.allowBounce(false)
.onFinishInflate {..}
.setupImage {..}
.onDismiss {..}
.dismissOnClick(false)
.preserveScreenLocation(false)
// build DismissView
val dismissViewArgs = DismissView.Args()
.alpha(0.5f)
.scaleRatio(1.0)
.drawableRes(R.drawable.ic_dismiss)
.onFinishInflate {..}
.setupImage {..}
// build BadgeView
val badgeViewArgs = BadgeView.Args()
.layoutRes(R.layout.badge_view, R.id.tvCount)
.position(BadgeView.Position.TOP_END)
.count("3333")
val builder = Head.Builder(R.drawable.ic_messenger_red)
.headView(headViewArgs)
.dismissView(dismissViewArgs)
.badgeView(badgeViewArgs)
AppHead(builder).show(activity)
```
### Components
AppHead has 3 main components
- [ ] **HeadView**: the draggable & dismissable view.
- [ ] **DimissView**: the view at the bottom that acts as bounds within which the **HeadView** can be dimissed.
- [ ] **BadgeView**(optinal): displays the number of notifications.
### Customize Components Layouts
In addition to configuring all options of the components, you also can define full custom components layouts.
To customize `HeadView`, `DimissView` or `BadgeView`
you must define the rootview as `HeadView`, `DimissView` or `BadgeView`
``` xml
```
``` xml
```
``` xml
```
### Options & Default Values
#### Headview.Args
| **Option** | **Type** | **Default** |
| ------------------------------ | --------------------------- | ----------------------------- |
| **layoutRes** | Layout Res | R.layout.app_head |
| **imageViewId** | ID Res | R.layout.ivHead |
| **drawableRes** | Drawable Res | 0(REQUIRED |
| **alpha** | Float | 1f |
| **allowBounce** | Boolean | true |
| **preserveScreenLocation** | Boolean | true |
| **dismissOnClick** | Boolean | true |
| **setupImage** | ((ImageView) -> Unit)? | null |
| **onFinishInflate** | ((HeadView) -> Unit)? | null |
| **onClick** | ((HeadView) -> Unit)? | null |
| **onLongClick** | ((HeadView) -> Unit)? | null |
| **onDismiss** | ((HeadView) -> Unit)? | null |
#### DismissView.Args
| **Option** | **Type** | **Default** |
| ------------------------------ | --------------------------- | ----------------------------- |
| **layoutRes** | Layout Res | R.layout.dismiss_view |
| **imageViewId** | ID Res | R.layout.ivDismiss |
| **drawableRes** | Drawable Res | R.drawable.ic_dismiss_apphead |
| **scaleRatio** | Double | 1.5 |
| **alpha** | Float | 1f |
| **setupImage** | ((ImageView) -> Unit)? | null |
| **onFinishInflate** | ((DismissView) -> Unit)? | null |
#### BadgeView.Args
| **Option** | **Type** | **Default** |
| ------------------------------ | --------------------------- | ----------------------------- |
| **layoutRes** | Layout Res | R.layout.badge_view |
| **count** | String | "" |
| **countTextViewId** | ID Res | R.id.tvCount |
| **position** | BadgeView.Position | BadgeView.Position.TOP_END |
#### Look at 'sample' module for the full code. For more advanced example.
## Credit
[henrychuangtw/Android-ChatHead](https://github.com/henrychuangtw/Android-ChatHead)
### 🛡 License
click to reveal License
```
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```