From a2379db13a327b4bb17d87a3ada2b5ec1d57ff40 Mon Sep 17 00:00:00 2001 From: AndroidHelp Date: Fri, 26 Apr 2019 11:24:21 +0530 Subject: [PATCH] Create README.md --- README.md | 136 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 136 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..b86eacf --- /dev/null +++ b/README.md @@ -0,0 +1,136 @@ +# BottomNavigationView +Customizable library +### developed in Kotlin + +## Add Library +Using Maven +```` + + com.katariya.bottomnavigation + bottomnavigation + 1.3 + pom + +```` +Using Gradle +```` +compile 'com.katariya.bottomnavigation:bottomnavigation:1.3' +```` +Using Ivy +```` + + + +```` + +## How to Use + Add to XML +```xml + +``` +Add above properties in xml view + 1. tab_background_color : for adding/change tab background color + 2. tab_selected_item_background_color : for adding/change tab selected item color + 3. tab_selected_item_text_color: for adding/change tab selected item text color + 4. tab_unselected_item_text_color: for adding/change tab unselected item text color + 5. tab_item_text_size: for adding/change tab item text size + 6. tab_badge_text_size: for adding/change tab item badge size + 7. tab_badge_background_color: for adding/change tab item badge background color + 8. tab_badge_item_text_color: for adding/change tab item badge item color + 9. tab_badge_background_border_color: for adding/change tab item badge background border color + 10. tab_badge_background_border_size: for adding.change tab item badge background border size + 11. tab_icon_selected_width: for adding/change tab icon width when selected + 12. tab_icon_selected_height: for adding/change tab icon height when selected + 13. tab_icon_unselected_width: for adding/change tab icon width when unselected + 14. tab_icon_unselected_height: for adding/change tab icon height when unselected + 15. tab_margin_in_icon_text_in_selected: for adding/change tab margin between icon and text when selected + 15. tab_margin_in_icon_text_in_unselected: for adding/change tab margin between icon and text when unselected +```` + app:tab_background_color="@color/colorWhite" + app:tab_badge_background_border_color="@color/colorAccent" + app:tab_badge_background_border_size="2" + app:tab_badge_background_color="@color/colorRed" + app:tab_badge_item_text_color="@color/colorBlack" + app:tab_selected_item_background_color="@color/colorGreen" + app:tab_badge_text_size="10" + app:tab_item_text_size="12" + app:tab_selected_item_text_color="@color/colorGrey" + app:tab_unselected_item_text_color="@color/colorBlack" + app:tab_icon_selected_height="50" + app:tab_icon_selected_width="50" + app:tab_icon_unselected_width="55" + app:tab_icon_unselected_height="55" + app:tab_margin_in_icon_text_in_selected="5" + app:tab_margin_in_icon_text_in_unselected="6" +```` +Initialization of BottomNavigationView + +``` + private lateinit var bottomNavigationView: BottomNavigationView + + bottomNavigationView = findViewById(R.id.bottomView) +``` + +#### Add tab item in BottomNavigationView +When you want to show only icon and title: +
First icon will be for unselected state and second icon will be used for selected state + +``` + bottomNavigationView.addChild(R.drawable.ic_chat_icon,R.drawable.ic_chat_icon, getString(R.string.title_chats)) + bottomNavigationView.addChild(R.drawable.ic_contacts_icon,R.drawable.ic_contacts_icon, getString(R.string.title_contacts)) + bottomNavigationView.addChild(R.drawable.ic_man_user_icon,R.drawable.ic_man_user_icon, getString(R.string.title_account)) +``` +When you want to show only icon: +
Add only icon and rest should be null +```` + bottomNavigationView.addChild(R.drawable.ic_chat_icon, null, null) + bottomNavigationView.addChild(R.drawable.ic_contacts_icon, null, null) + bottomNavigationView.addChild(R.drawable.ic_man_user_icon, null, null) +```` +When you want to show only name: +
Add only name and rest should be null +```` + bottomNavigationView.addChild(null, null, getString(R.string.title_chats)) + bottomNavigationView.addChild(null, null, getString(R.string.title_contacts)) + bottomNavigationView.addChild(null, null, getString(R.string.title_account)) +```` +When you pass null for second icon and add first icon as well title +then icon will remain same after click +```` + bottomNavigationView.addChild(R.drawable.ic_chat_icon, null, getString(R.string.title_chats)) +```` +#### Add Listener +```` + bottomNavigationView.initItemListener(this) + + override fun bottomNavigationViewItemClickListener(position: Int) { + if (position == 0) textTitle.text = getString(R.string.title_chats) + if (position == 1) textTitle.text = getString(R.string.title_contacts) + if (position == 2) textTitle.text = getString(R.string.title_account) + // Toast.makeText(applicationContext, "" + position, Toast.LENGTH_SHORT).show() + } +```` + +##### Change Font of tab item + +```` + bottomNavigationView.updateFont("fonts/roboto_medium.ttf") +```` +##### Add Badge in tab +Index: example pass 0 for first item and count is for badge quantity +```` + bottomNavigationView.setBadge(index, count) +```` + +###### Limitations +if you add more item(more then 5,6), some icon or text can be have size/cut/invisible issues + +![Alt text](/screenshots/1.png?raw=true "Optional Title") | ![Alt text](/screenshots/2.png?raw=true "Optional Title") + +![Alt text](/screenshots/3.png?raw=true "Optional Title") | ![Alt text](/screenshots/4.png?raw=true "Optional Title") + +![Alt text](/screenshots/5.png?raw=true "Optional Title") | ![Alt text](/screenshots/6.png?raw=true "Optional Title") +