com.cleveroad:loopbar

LoopBar

Meet LoopBar - Tab Bar with Infinite Scrolling for Android by Cleveroad

At Cleveroad we’ve recently come to realize that navigation through categories in an app using nothing but a navigation panel is pretty boring and trivial. That’s why, armed with our designer’s creativity, we introduce you our new component for Android-based applications -- LoopBar. The idea was to make the navigation menu right at fingerprints, in a tab bar. What's more the view has a few specific features that make it stand out from the crowd of similar ones. So, try out the LoopBar library in your app and you’ll see the difference.

If you strive to create an application with unusual looks and navigation, you are welcome to use the LoopBar library. It’s really easy to integrate and can add spice to any app!

If you need more details on how you can use the component and what benefits it provides, read our blog post: Case Study: Loop Bar for Android

Setup and usage

Installation

by gradle :

dependencies {
    implementation "com.cleveroad:loopbar:1.2.0"
}

or just download zip and import module "LoopBar-widget" to be able to modify the sources

Features

View consist from two parts:

• A list of your selectable groups
• Selected view

View can work in three scroll modes: infinite, finite and auto mode. Names of first two speak for itself. In auto mode the list of groups will be infinite if all adapter items didn't fit on screen in other case it will be a static list. Selected view by request could overlay layout on screen on which it placed. Widget has horizontal and vertical layouts and also start or end gravity of selected view.

You are allowed to use any RecyclerView adapter, which you want. Concrete infinite scroll logic is fully encapsulated

Android Studio layouts preview is supported.

Usage

    <com.cleveroad.loopbar.widget.LoopBarView
        android:id="@+id/endlessView"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        app:enls_placeholderId="@id/placeHolder"
        app:enls_orientation="horizontal"
        app:enls_selectionGravity="start"
        app:enls_selectionMargin="10dp"
        app:enls_overlaySize="5dp"
        app:enls_selectionInAnimation="@animator/enls_scale_restore"
        app:enls_selectionOutAnimation="@animator/enls_scale_small"
        app:enls_selectionBackground="@android:color/holo_blue_dark"
        app:enls_menu="@menu/loopbar"
        app:enls_scrollMode="auto"
        app:enls_listBackground="@android:color/holo_orange_dark"
        />

enls_overlaySize & enls_placeholderId are used for overlay feature. Placeholder must be the view lying under the LoopBar. And it's used for setting bounds In layout when selected view has overlay. LoopBar will set width or height for this view by itself (depending of LoopBar orientation), it will be the same as LoopBar has. Without this placeholder the bounds of LoopBar will be limited by selected view (with overlay). And thanks to placeholder the bounds will be limited only by list of groups. You can see an example of overlay usage in sample.

attribute name	Description
enls_overlaySize	A size of selected view overlaying
enls_orientation	Orientation of loopbar view. Can be verticalLeft, verticalRight, horizontalBottom, horizontalTop. Default verticalLeft
enls_placeholderId	An id of view on which you should use layout:above or other attributes of RelativeLayouts, because LoopBarView will have increased height in this case. See more in sample
enls_selectionGravity	A gravity of selection view. Can be vertical or horizontal. Default horizontal
enls_selectionMargin	A margin of selectionView from bounds of view. Default 5dp
enls_selectionInAnimation	An animation of appearing an icon inside selection view
enls_selectionOutAnimation	An animation of hiding an icon inside selection view
enls_selectionBackground	Selection background. Default #ff0099cc
enls_menu	An id of menu which will be used for getting title and icon items
enls_scrollMode	Scrolling mode. Can be infinite, finite, auto. Default infinite
android:background	View have transparent background by default. Use standard android:background attribute to change it. Default #00000000
enls_listBackground	Set list background. View have yellow list background by default #ffc829

To initialize items in widget and work with it you should setup adapter to it and add item click mListener:

LoopBarView loopBarView = findViewById(...);
categoriesAdapter = new SimpleCategoriesAdapter(MockedItemsFactory.getCategoryItems(getContext()));
loopBarView.setCategoriesAdapter(categoriesAdapter);
loopBarView.addOnItemClickListener(this);

Here SimpleCategoriesAdapter is used which required collection of ICategoryItem objects (to draw default view with icon and text).
Also you can setup adapter through:

• Menu via Java code (see example MenuLoopBarFragment):

        loopBarView.setCategoriesAdapterFromMenu(R.menu.loopbar);
        //or
        Menu menu = ...;
        loopBarView.setCategoriesAdapterFromMenu(menu);

or via XML:

        <com.cleveroad.loopbar.widget.LoopBarView
        ...
        app:enls_menu="@menu/loopbar"
        />

• ViewPager. Just set a viewPager into your LoopBar. If you want to show category icons, your ViewPager adapter must implement ILoopBarPagerAdapter interface (see example ViewPagerLoopBarFragment), otherwise the icons will not be shown:

    loopBarView.setupWithViewPager(viewPager);

To customize wrapped RecyclerView (control animations, decorators or add RecyclerView.OnScrollListener) you are able to use following methods:

method name	description
setItemAnimator(RecyclerView.ItemAnimator animator)	Sets the ItemAnimator to wrapped RecyclerView
isAnimating()	Returns true if wrapped RecyclerView is currently running some animations
addItemDecoration(RecyclerView.ItemDecoration decor)	Add an ItemDecoration to wrapped RecyclerView
addItemDecoration(RecyclerView.ItemDecoration decor, int index)	Add an ItemDecoration to wrapped RecyclerView
removeItemDecoration(RecyclerView.ItemDecoration decor)	Remove an ItemDecoration from wrapped RecyclerView
invalidateItemDecorations()	Invalidates all ItemDecorations in wrapped RecyclerView
addOnScrollListener(RecyclerView.OnScrollListener listener)	Add a OnScrollListener to wrapped RecyclerView
removeOnScrollListener(RecyclerView.OnScrollListener listener)	Remove a OnScrollListener from wrapped RecyclerView
clearOnScrollListeners()	Remove all secondary OnScrollListener from wrapped RecyclerView
setListBackgroundResource(int backgroundResource)	Set list background to a given resource
setListBackgroundColor(int color)	Set list background color
getListBackground()	Get list background drawable
setListBackground(Drawable background)	Set list background to a given Drawable
setListBackgroundTintList(ColorStateList tint)	Set tint to the list background drawable
getListBackgroundTintList()	Get tint applied to the list background drawable
setListBackgroundTintMode(PorterDuff.Mode tintMode)	Set blending mode used to apply the tint specified to the list background drawable
getListBackgroundTintMode()	Get blending mode used to apply the tint to the list background drawable

Changelog

See changelog history.

Support

---

If you have any other questions regarding the use of this library, please contact us for support at [e-mail] (email subject: "LoopBar. Support request.") Also pull requests are welcome.

#### License #### * * * The MIT License (MIT)

Copyright (c) 2016 Cleveroad Inc.

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.