Floating Action Button Library for Android

Min SDK   9
Latest Commit   2016-10-30 21:21:35
License   Apache-2.0

Github   https://github.com/Scalified/fab




ButtonProgressBar A Download Button ProgressBar, inspiration from Dribbble
JellyToggleButton Cute and colorful toggle button with 18 jelly types and 30 ease types.


Floating Action Button Library for Android

Build Status Maven Central Android Arsenal


This Library contains implementation of the Floating Action Button for Android.

Floating action buttons are used for a special type of promoted action. They are distinguished by a circled icon floating above the UI and have special motion behaviors related to morphing, launching, and the transferring anchor point.


The Library requires Android SDK version 9 (Gingerbread) and higher.

Gradle Dependency

dependencies {
	compile 'com.scalified:fab:1.1.3'

Action Button has a dependency on an external ViewMover library, which in turn has a transitive dependency on the UI Tools library. If any of these libraries are already used in the project they must be excluded as transitive dependencies

Activity Stream

Full ChangeLog

1.1.3 - current

  1. Fixed issue #28: move() method smearing on KitKat with snackbar:

    • A fix was made within the dependent ViewMover library. Only ActionButton dependency on ViewMover library was updated
  2. Changed the standard Android logging API to SLF4J Logging API

1.1.1 - previous

  1. Fixed issue #27: Icon is outside the circle:

    A call to Canvas.restore() without calling the Canvas.save() first resulted in the unpredictable behaviour. Added call to Canvas.save() before Canvas.restore() in the RippleEffectDrawer class

Features in the next versions:


Subscribe the ActionButton YouTube Channel

Button types

Floating action buttons come in 3 sizes:

  • DEFAULT (56dp) - used in most cases
  • MINI (40dp) - used to create visual continuity with other elements on the screen
  • BIG (72dp) - additional button size, useful for large screens (not covered by Material Design)
Default Mini Big

Color palette

The Library contains all of the colors 500 and 900 of the Material Color Palette.

Colors 500 are used for the NORMAL button state while 900 ones for the PRESSED state:

Green 500 Amber 500 Blue 500
Green 500 Amber Color Blue Grey


Shadow enabled by default and has standard settings according to Material Design Guidelines. These settings are suitable in most cases. However, shadow can be modified in three ways: radius, X- or Y-axis offset and color.

Default Radius X- and Y- axis offset
Default Shadow Shadow Radius Shadow Offset


Stroke is disabled by default. Stroke can be modified in two ways: width and color.

Thin Medium Thick
Thin Stroke Medium Stroke Thick Stroke


Shadow Responsive Effect

Shadow Responsive Effect means that shadow is changed in response to the user input. Shadow Responsive Effect enabled by default.

Ripple Effect

A touch Ripple Effect indicates where and when a touch occurs within the ActionButton and acknowledges that the touch input was received. Ripple Effect disabled by default.

Shadow Responsive Effect Ripple Effect
Shadow Responsive Effect Ripple Effect


ActionButton can be moved in any direction. ViewMover Library is used for performing the ActionButton moving

Left-Right Move Up-Down Move
Left-Right Move Up-Down Move


The Library has several predefined animations:

Fade In - Fade Out Roll From Down - Roll To Down Jump From Down - Jump To Down
Fade In Fade Out Roll From Down Roll To Down Jump From Down - Jump To Down
Scale In - Scale Out Roll From Right - Roll To Right Jump From Right - Jump To Right
Scale In Scale Out Roll From Right Roll To Right Jump From Right Jump To Right



Declaration inside XML resource

ActionButton button can be declared in the XML resource. For instance, using RelativeLayout:

// And then find it within the content view:
ActionButton actionButton = (ActionButton) findViewById(R.id.action_button);

There are no required configuration parameters for it. All of the configuration parameters are optional.


Context context = getContext();
ActionButton actionButton = new ActionButton(context);
// And then add it to the content view

Button actions

Showing and Hiding

Action Button can be shown, hidden or completely dismissed:

actionButton.show();    // shows the button if it is hidden and plays the show animation if set
actionButton.hide();    // hides the button if it is shown and plays the hide animation if set
actionButton.dismiss(); // completely dismisses the button and plays the hide animation if set

After dismissal the button is completely removed from its parent view, so any calls to show() etc. won't be processed.

The current status of the button can be checked with the help of:

// To check whether button is shown (inherited from android.view.View class):
boolean shown = actionButton.isShown();

// To check whether button is hidden:
boolean hidden = actionButton.isHidden();

// To check whether button is dismissed:
boolean dismissed = actionButton.isDismissed();

Playing animations

There are some cases when you need to force playing the animation without calling the show(), hide() or dismiss() methods. For instance, when your button appears within layout in the Activity for the first time. In such cases animations can be played apart from showing, hiding, or dismissing the button:

actionButton.playShowAnimation();   // plays the show animation
actionButton.playHideAnimation();   // plays the hide animation

Animations are played only if set. By default animations are not set.

The best way to play the animation with the Activity launching is to override the onWindowFocusChanged(boolean) and call either playShowAnimation() or playHideAnimation() within it

Moving ActionButton

ActionButton can be moved within its parent container. While moving, translate animation is used. There are methods for moving ActionButton in 4 standard directions:

// Initialize the moving distance
int distance = 100.0f // in density-independent pixels

// Move ActionButton left

// Move ActionButton up

// Move ActionButton right

// Move ActionButton down

The above methods will cover the most cases, however movement can also be customized in more advanced way:

// Initialize the moving parameters
int xAxisDelta = 100.0f // in density-independent pixels
int yAxisDelta = 100.0f // in density-independent pixels
long animationDuration = 500L
Interpolator animationInterpolator = new AccelerateInterpolator();

// Create the moving parameters instance
MovingParams params = new MovingParams(getContext(), xAxisDelta, yAxisDelta, animationDuration, animationInterpolator);

// Move the ActionButton

ViewMover Library is used for performing the ActionButton moving.

For API lower than Jelly Bean (version code 16) moving is guaranteed to work as expected with FrameLayout and RelativeLayout. Working as expected with other layouts not guaranteed


Button types

There are three types of Action Button, which you can work with:

  • DEFAULT (56dp)
  • MINI (40dp)
  • BIG (72dp)

By default the button type is set to DEFAULT.

To work with button types use:

// To set the button type:

// To get the button type:
ActionButton.Type type = actionButton.getType();

Button size

To work with ActionButton size use:

// To get the ActionButton size
float size = actionButton.getSize();

// To set the ActionButton size
actionButton.setSize(60.0f); // in density-independent pixels

Changing the default size of the button breaks the rules of Material Design

Setting the button size explicitly means, that button types with its default sizes are completely ignored. Do not use this method, unless you know what you are doing