https://github.com/clistery/bottomnavigationex
An android lib for enhancing BottomNavigationView.(Extended from BottomNavigationViewEx)
https://github.com/clistery/bottomnavigationex
android bottomnavigationbar bottomnavigationview kotlin
Last synced: 4 months ago
JSON representation
An android lib for enhancing BottomNavigationView.(Extended from BottomNavigationViewEx)
- Host: GitHub
- URL: https://github.com/clistery/bottomnavigationex
- Owner: CListery
- License: mit
- Created: 2021-08-31T08:06:34.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-08-14T07:04:36.000Z (over 1 year ago)
- Last Synced: 2025-02-14T21:12:22.165Z (about 1 year ago)
- Topics: android, bottomnavigationbar, bottomnavigationview, kotlin
- Language: Kotlin
- Homepage: https://clistery.github.io/BottomNavigationEx/
- Size: 2.67 MB
- Stars: 56
- Watchers: 2
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# BottomNavigationEx
[中文文档](./doc/README.zh-cn.md)
[](https://jitpack.io/#CListery/BottomNavigationEx)  
> An android library that enhances BottomNavigationView. (Continuation of [~~BottomNavigationViewEx(obsolete)~~](https://github.com/ittianyu/BottomNavigationViewEx))
## [APIs](./doc/API.md)
## [Example](./doc/example.md)
## Dependencies
### Gradle
1. Ex library
```groovy
implementation 'io.github.clistery:bottomnavigationex-ex:x.x.x'
```
2. Version base on `material`
- `material`1.10.x
```groovy
implementation 'io.github.clistery:bottomnavigationex-110x:x.x.x'
```
- `material`1.9.x
```groovy
implementation 'io.github.clistery:bottomnavigationex-19x:x.x.x'
```
- `material`1.8.x
```groovy
implementation 'io.github.clistery:bottomnavigationex-18x:x.x.x'
```
- `material`1.7.x
```groovy
implementation 'io.github.clistery:bottomnavigationex-17x:x.x.x'
```
- `material`1.6.x
```groovy
implementation 'io.github.clistery:bottomnavigationex-16x:x.x.x'
```
- `material`1.5.x
```groovy
implementation 'io.github.clistery:bottomnavigationex-15x:x.x.x'
```
- `material`1.4.x
```groovy
implementation 'io.github.clistery:bottomnavigationex-14x:x.x.x'
```
- `material`1.3.x
```groovy
implementation 'io.github.clistery:bottomnavigationex-13x:x.x.x'
```
3. Add the following configuration in `gradle.properties`
```properties
android.useAndroidX=true
android.enableJetifier=true
```
### USE
- Adding a custom widget in `xml`
```xml
```
- Binding view in `Activity`
```java
BottomNavigationViewEx bnve = (BottomNavigationViewEx) findViewById(R.id.bnve);
```
- Disable all animations
```java
bnve.enableAnimation(false);
bnve.enableLabelVisibility(false);
bnve.enableItemHorizontalTranslation(false);
```
- Custom text and icon size
```java
bnve.setIconSize(widthDp, heightDp);
bnve.setTextSize(sp);
```
- Binding with ViewPager
```java
// set adapter
adapter = new VpAdapter(getSupportFragmentManager(), fragments);
bind.vp.setAdapter(adapter);
// binding with ViewPager
bind.bnve.setupWithViewPager(bind.vp);
```
- Binding with ViewPager2
```java
// set adapter
adapter = new Vp2Adapter(getSupportFragmentManager());
bind.vp.setAdapter(adapter);
// binding with ViewPager
bind.bnve.setupWithViewPager2(bind.vp);
```
- Add badge view
```java
BadgeDrawable bd = bind.bnve.getRealView().getOrCreateBadge(R.id.i_friends);
bd.setNumber(1);
bd.setHorizontalOffset(12);
bd.setVerticalOffset(2);
```
- Dynamic Menu Item
```kotlin
val menuCount: Int = max((Math.random() * 30).toInt(), 1)
bnve.configDynamic(menuCount) { menu, index ->
menu.add(0, index, index, "menu${index}")
.setIcon(R.drawable.ic_favorite_black_24dp)
}
```
- About support Android 15 Edge-To-Edge effect
- [Display content edge-to-edge in views](https://developer.android.com/develop/ui/views/layout/edge-to-edge)
- [Handle edge-to-edge enforcements in Android 15](https://developer.android.com/codelabs/edge-to-edge)
- For the usage of the original BottomNavigationView obtained through getRealView, please refer to [Official Documentation](https://developer.android.com/reference/com/google/android/material/bottomnavigation/BottomNavigationView)
- For more usage, please refer to demo.
## License
```license
MIT License
Copyright (c) 2022 clistery
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.
```
