CircleMenu

Table of Contents

1. Setup
2. Examples
3. Documentation
4. Origin & Attribution
5. Notice
6. License

1. Setup 🛠️

First, add the JitPack repository to your build file.

repositories {
	...
	maven { url 'https://jitpack.io' }
}

Second, add this project as a dependency.

dependencies {
	...
	implementation 'com.github.leeeeeeelo:circlemenu:1.0.0'
}

2. Examples 👀

⭕ Simple Circle Menu:

⭕ Circle Menu With Bottom App Bar:

⭕ Corner Circle Menu:

3. Documentation 📔

Add to your layout xml file the below:

<com.leeeeeeelo.circlemenu.CircleMenu  
	android:id="@+id/circleMenu"
	android:layout_width="wrap_content"
	android:layout_height="wrap_content"
	app:buttonColors="@array/colors"
	app:buttonIcons="@array/icons" />  

Handling menu items clicks:

val circleMenu = findViewById<CircleMenu>(R.id.circleMenu)  
circleMenu.setOnItemClickListener { buttonIndex -> }  

You can use open(boolean animate), close(boolean animate) and toggle(boolean animate) methods, to open and close menu programmatically:

circleMenu.open(true)  

Set EventListener for handling open/close actions

circleMenu.setOnItemClickListener { buttonIndex -> }  
  
circleMenu.onMenuOpenAnimationStart { }  
  
circleMenu.onMenuOpenAnimationEnd { }  
  
circleMenu.onMenuCloseAnimationStart { }  
  
circleMenu.onMenuCloseAnimationEnd { }  
  
circleMenu.onButtonClickAnimationStart { buttonIndex -> }  
  
circleMenu.onButtonClickAnimationEnd { buttonIndex -> }  

Update Circle Menu visibility

circleMenu.visibility = View.GONE

Apply animations on Circle Menu

circleMenu.startAnimation(animation)  

Below are the Circle Menu attributes:

• buttonIcons (required) - Array of icons of menu buttons
• buttonColors (required) - Array of background colors of menu buttons
• iconsColor - Array of color of buttons icons
• visibility - Circle Menu visibility

- `startAngle` - Start circle angle - `maxAngle` - Maximum degree of the menu arc - `distance` - Distance between center menu and buttons (radius) - `centerButtonColor` - Background color of center menu button - `centerButtonIconColor` - Icon background color of center menu button
- `menuIcon` - Center button icon type. One of `hamburger` or `plus` - `openOnStart` - Bool to open the menu when the screen starts - `showSelectAnimation` - Bool to display animation when clicking on a button or closing the menu

4. Origin & Attribution 📜

This project is a fork of Circle Menu, created by ImangazalievM and licensed under the MIT License.

I was looking for a menu library myself when I stumbled upon Circle Menu by ImangazalievM. However it was retired, not up to date and had some bugs. This library is a result of a fork from the original library with the addition of some work of my own to improve it and keep it up to date. All the credits goes to ImangazalievM for the original amazing work !

Changes in this Fork

• Updated Gradle
• Updated Java version
• Updated minSDK and targetSDK
• Fixed bugs
• Added visibility support
• Added animation support
• Released via JitPack

5. Notice ⚠️

This product includes software developed by ImangazalievM.

6. License 📄

This library is licensed under the MIT License. See the MIT License license for more details.

Copyright 2024 Elias Sayegh

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.