Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/JoaquimLey/faboptions

A multi-functional FAB component with customizable options
https://github.com/JoaquimLey/faboptions

android component fab faboptions library materialdesign materialup

Last synced: 3 months ago
JSON representation

A multi-functional FAB component with customizable options

Host: GitHub
URL: https://github.com/JoaquimLey/faboptions
Owner: JoaquimLey
License: apache-2.0
Created: 2016-11-23T18:24:38.000Z (almost 8 years ago)
Default Branch: development
Last Pushed: 2020-07-09T07:32:43.000Z (over 4 years ago)
Last Synced: 2024-08-02T01:25:12.707Z (3 months ago)
Topics: android, component, fab, faboptions, library, materialdesign, materialup
Language: Java
Homepage: http://joaquimley.com/
Size: 805 KB
Stars: 1,040
Watchers: 27
Forks: 140
Open Issues: 6
Metadata Files:
- Readme: README.MD
- License: LICENSE

Awesome Lists containing this project

README

![AppIcon](../development/sample/src/main/res/mipmap-xxhdpi/ic_launcher.png)

# FabOptions
[![Android Arsenal](https://img.shields.io/badge/Android%20Arsenal-FabOptions-brightgreen.svg?style=flat)](http://android-arsenal.com/details/1/4734)
[![MaterialUp](https://img.shields.io/badge/MaterialUp-FabOptions-blue.svg?style=flat)](https://material.uplabs.com/posts/faboptions)
[![Bintray](https://img.shields.io/badge/Bintray-v1.2.0-brightgreen.svg?style=flat)](https://bintray.com/leyopensource/FabOptions/com.github.joaquimley%3Afaboptions/1.1.2)
![minSdkVersion](https://img.shields.io/badge/minSdkVersion-14-green.svg?style=true)
![compileSdkVersion](https://img.shields.io/badge/compileSdkVersion-27-green.svg?style=true)

**Special thanks to [André Mion](https://github.com/andremion)** for the help provided on building this component.
Original concept by **Praveen Bisht** posted on [MaterialUp](https://www.uplabs.com/posts/options-floating-interaction), turned into code into open source library.

![Gif concept sample](../master/art/faboptions_materialup_demo.gif)

Android implementation

![Gif android sample](../master/art/faboptions_demo.gif)

## How to use
- Import gradle dependency:

dependencies {
compile 'com.github.joaquimley:faboptions:1.2.0'
}

- Add the component to your layout:

```xml

```

- Define a `menu.xml` file with your buttons information **e.g.**

```xml

```

**XML**:

- Bind the buttons menu by adding the **custom attribute** `app:button_menu="@menu/your_fab_buttons"` to your component XML.

**Programmatically**

- Bind the buttons menu on your FabOptions instance with FabOptions#setMenu(Menu).

```java
FabOptions fabOptions = (FabOptions) findViewById(R.id.fab_options);
fabOptions.setButtonsMenu(R.menu.your_fab_buttons);
```

**Listening for click events**

- Set your FabOptions instance click listener.

- Handle the click events for each button id defined on the `menu.xml`.

## Customizing

You can change the color of the component, both the FAB and the "background" individually, **unless specified** the background will **always** adopt the same value as the ```app:fab_color``` attribute (default is the theme's accent color).

```xml

```

You can also use **Java**

```java
fabOptions.setFabColor(R.color.fabOptionsFabColor);
fabOptions.setBackgroundColor(R.color.fabOptionsBackgroundColor);
```

*Note: One is not dependent on the other, you can set individually.*

**Changing button color**
```java
fabOptions.setButtonColor(R.id.faboptions_favorite, R.color.colorAccent)
```

This will return a boolean value if it's able to change the color.

### The sample is also available on the Playstore

[![Get it on Google Play](../master/art/google-play-badge.png)](https://play.google.com/store/apps/details?id=com.joaquimley.faboptions.sample)

**Issues:**
Fell free to open a new issue. Follow the [ISSUE_TEMPLATE.MD](../development/ISSUE_TEMPLATE.MD)

## [Changelog](https://github.com/JoaquimLey/faboptions/releases)

**1.2.0**
- Ability to open and close the component with new exposed `open()`/`close()` methods. - #35
- Change the background color `setBackgroundColor()` through `@ColorInt` - #41

**1.1.2**
- Fix a bug where buttons were clickable even when hidden - #25

**1.1.1**
- Fix a resurfaced issue with related to Snackbar behaviour - #8

**1.1.0**
- Backport to API 14 - #21
- Change button color at runtime with the new #setButtonColor(int) - #22
- Bug fix on Menu not displayed correctly - #17
- Customize both background + fab colors. - #16

**1.0.2**
- Fix layout measure
- The component now reacts when a snackbar dismissed by user - #8

**1.0.1**
- Fix slight vertical offset on the button's icon - #2

## Contributing

Contributions are always welcome!

Follow the "fork-and-pull" Git workflow.

1. **Fork** the repo on GitHub
2. **Clone** the project to your own machine
3. **Commit** changes to your own branch
4. **Merge** with current *development* branch
5. **Push** your work back up to your fork
7. Submit a **Pull request** your changes can be reviewed (please refere the issue if reported)

**Prevent** code-style related changes (at least run Ctrl+⌥+O, ⌥+⌘+L) before commiting.

### License

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied.
See the License for the specific language governing permissions and
limitations under the License.