CycleMenu

Meet CycleMenu for Android by Cleveroad

What can be better than an eye-catching design in couple with reasonable features? While using this menu you do not need to worry about the lack of space for some useful features since the scroll type can be endless as well as basic. Choose an appropriate corner, customize your icons and here you go!

During its development, we have created a custom LayoutManager for the inner RecyclerView in order to display the elements in a circle with the possibility to scroll them.

In case you are in need of beautiful and functional app menu, you are welcome to use CycleMenu. Make your scroll last forever!

Setup and usage

To include this library to your project add dependency in build.gradle file:

    dependencies {
        implementation 'com.cleveroad:cycle-menu:1.0.2'
    }

Use the CycleMenu in layout file

<com.cleveroad.sy.cyclemenuwidget.CycleMenuWidget
        android:id="@+id/itemCycleMenuWidget"
        android:layout_width="match_parent"
        android:layout_height="match_parent"

        app:cm_autoMaxRadius="220dp"
        app:cm_autoMinRadius="10dp"
        app:cm_corner="right_top"
        app:cm_fixedRadius="200dp"
        app:cm_radius_scale_type="auto"
        app:cm_scroll_type="endless"
        app:cm_item_background_tint="#449955"
        app:cm_corner_image_src="@drawable/ic_corner_image"
        app:cm_ripple_color="#009933"
        />
/>

or programmatically

CycleMenuWidget cycleMenuWidget = new CycleMenuWidget(mContext);
cycleMenuWidget.setLayoutParams(new RelativeLayout.LayoutParams(ViewGroup.LayoutParams.WRAP_CONTENT, ViewGroup.LayoutParams.WRAP_CONTENT));
container.addView(cycleMenuWidget);

To set menu resources from xml resource or Collection use:

cycleMenuWidget.setMenuRes(R.menu.menu_items);
cycleMenuWidget.setMenuItems(Collection<CycleMenuItem> items);

You can setup any attribute from xml via method. Methods for setting radius scaling type:

void setScalingType(RADIUS_SCALING_TYPE scalingType)
void setAutoMinRadius(int autoMinRadius)
void setAutoMaxRadius(int autoMaxRadius)
void setFixedRadius(int fixedRadius)

If you choose to use RADIUS_SCALING_TYPE.AUTO then you need to setup autoMinRadius and autoMaxRadius. This values will be use to calculate radius of menu. If menu has small amount of items - the radius will be calculated to fit all items but not less then autoMinRadius. If there is a lot of items in the menu then radius will be equal autoMaxRadius. if you setup autoMaxRadius bigger then available space for the menu - radius will be reduced. If you choose to use RADIUS_SCALING_TYPE.FIXED the the menu radius will be equal to fixedRadius. But not bigger then available space for the menu.

To setup scroll type. The scroll type can be ENDLESS (infinite scrolling) ans BASIC (general scrolling).

void setScrollType(SCROLL scrollType)

To setup corner in which will be placed menu use:

void setCorner(CORNER corner)

And methods to setup UI:

void setItemsBackgroundTint(ColorStateList itemsBackgroundTint)
void setRippleColor(int rippleColor)
void setCornerImageDrawable(Drawable cornerImageDrawable)
void setCornerImageResource(@DrawableRes int drawableRes)
void setCornerImageBitmap(Bitmap bitmap)
void setCollapsedRadius(int collapsedRadius)
void setBackground(int backgroundColor)

For listening changing menu state use

setStateChangeListener(
    new OnStateChangedListener() {
        void onStateChanged(CycleMenuWidget.STATE state){};
        void onOpen(){};
        void onClose(){};
})

For listening menu items clicks use

setOnMenuItemClickListener(
    new OnMenuItemClickListener() {
        void onMenuItemClick(View view, int itemPosition) {}
})

For providing saving state listener use

setStateSaveListener(
    new StateSaveListener() {
        void saveState(int itemPosition, double lastItemAngleShift){}
});

Changelog

See changelog history.

Support

If you have any questions, issues or propositions, please create a new issue in this repository.

If you want to hire us, send an email to sales@cleveroad.com or fill the form on contact page

License