Ecosyste.ms: Awesome

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

https://github.com/Clans/FloatingActionButton

Android Floating Action Button based on Material Design specification
https://github.com/Clans/FloatingActionButton

android floatingactionbutton

Last synced: 21 days ago
JSON representation

Android Floating Action Button based on Material Design specification

Lists

README 

        
# WARNING! FURTHER DEVELOPMENT AND SUPPORT IS DISCONTINUED.

# FloatingActionButton

[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.github.clans/fab/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.github.clans/fab) [![Android Arsenal](https://img.shields.io/badge/Android%20Arsenal-Clans%2FFloatingActionButton-blue.svg?style=flat)](http://android-arsenal.com/details/1/1684)



Yet another implementation of [Floating Action Button](http://www.google.com/design/spec/components/buttons.html#buttons-floating-action-button) for Android with lots of features.



# Requirements

The library requires Android **API Level 14+**.



# Demo

Watch a short **[Demo Video](https://youtu.be/XngUY3PN1IQ)** on YouTube or try it using **[Android simulator in the browser](https://appetize.io/app/ffreudbwmyedw5trzhyjknd2jg)** on Appetize.io.  

Sample APK can be found in **[Releases](https://github.com/Clans/FloatingActionButton/releases)** section.



# Screenshots

![Main screen](/screenshots/main_screen.png) ![Menu closed](/screenshots/menu_closed.png) ![Menu default opened](/screenshots/menu_default_opened.png) ![Menu custom opened](/screenshots/menu_custom_opened.png) ![Menu mini opened](/screenshots/menu_mini_opened.png) ![Menu right opened](/screenshots/menu_right_opened.png) ![Menu down opened](/screenshots/menu_down_opened.png) ![Progress background](/screenshots/progress_background.png) ![Progress no background](/screenshots/progress_no_background.png)



# Features

- Ripple effect on Android Lollipop devices

- Option to set custom **normal**/**pressed**/**ripple** colors

- Option to set custom shadow color and offsets

- Option to disable shadow for buttons and (or) labels

- Option to set custom animations

- Option to set custom icon drawable

- Support for **normal** `56dp` and **mini** `40dp` button sizes

- Custom FloatingActionMenu icon animations

- Option to expand menu up and down

- Option to show labels to the left and to the right of the menu

- Option to show circle progress on `FloactinActionButton`

- Option to add button to the `FloatingActionMenu` programmatically

- Option to dim the `FloatinActionMenu`'s background

- *Option to remove all buttons from the `FloatingActionMenu`*

- *Option to set a label for the `FloatingActionMenu`'s button*



# Usage

Add a dependency to your `build.gradle`:

```

dependencies {

    compile 'com.github.clans:fab:1.6.4'

}

```

Add the `com.github.clans.fab.FloatingActionButton` to your layout XML file.

```XML



    



    



```

You can set an icon for the **FloatingActionButton** using `android:src` xml attribute. Use drawables of size `24dp` as specified by [guidlines](http://www.google.com/design/spec/components/buttons.html#buttons-floating-action-button). Icons of desired size can be generated with [Android Asset Studio](http://romannurik.github.io/AndroidAssetStudio/icons-generic.html).



### Floating action button

Here are all the **FloatingActionButton**'s xml attributes with their **default values** which means that you don't have to set all of them:

```XML



```

All of these **FloatingActionButton**'s attributes has their corresponding getters and setters. So you can set them **programmatically**.



### Floating action menu

Here are all the **FloatingActionMenu**'s xml attributes with their **default values** which means that you don't have to set all of them:

```XML



        



    

```



If you're using custom style for labels - other labels attributes will be ignored.



Labels shadow preferences depends on their corresponding **FloatingActionButtons**' shadow preferences.



For more usage examples check the **sample** project.



# Changelog

Please see the [Changelog](https://github.com/Clans/FloatingActionButton/wiki/Changelog) page to see what's recently changed.



# Credits

I used [android-floating-action-button](https://github.com/futuresimple/android-floating-action-button) library by Jerzy Chalupski as a base for development.



# License

```

Copyright 2015 Dmytro Tarianyk



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.

```