https://github.com/zendesk/android-floating-action-button

Floating Action Button for Android based on Material Design specification
https://github.com/zendesk/android-floating-action-button

Last synced: about 1 year ago
JSON representation

Floating Action Button for Android based on Material Design specification

• Host: GitHub
• URL: https://github.com/zendesk/android-floating-action-button
• Owner: zendesk
• License: apache-2.0
• Created: 2014-09-19T06:49:21.000Z (almost 12 years ago)
• Default Branch: master
• Last Pushed: 2023-01-02T13:49:03.000Z (over 3 years ago)
• Last Synced: 2025-03-13T08:04:13.664Z (over 1 year ago)
• Language: Java
• Size: 592 KB
• Stars: 6,381
• Watchers: 326
• Forks: 1,453
• Open Issues: 157
• Metadata Files:
  • Readme: README.md
  • Changelog: changelog.md
  • License: LICENSE

Awesome Lists containing this project

README

          
FloatingActionButton

====================

Yet another library for drawing [Material Design promoted actions](http://www.google.com/design/spec/patterns/promoted-actions.html).

Features

========

* Support for normal `56dp` and mini `40dp` buttons.

  ![Demo](screenshots/buttons.png)

* Customizable background colors for normal and pressed states and icon drawable.

  ![Demo](screenshots/custom.png)

* Convenience `AddFloatingActionButton` class with plus icon drawn in code.

* `FloatingActionsMenu` which can be expanded/collapsed to reveal multiple actions.

  ![Demo](screenshots/menu.gif)

* Optional labels for buttons in `FloatingActionsMenu`.

  ![Demo](screenshots/labels.png)

Usage

=====

Just add the dependency to your `build.gradle`:

```groovy

dependencies {

    compile 'com.getbase:floatingactionbutton:1.10.1'

}

```

To see how the buttons are added to your xml layouts, check the sample project.

Caveats

=======

The API is **extremely** limited at the moment. It solves few select use cases in the app I'm working on.

Unlike some other FloatingActionButton libraries this library doesn't implement "quick return" pattern, i.e. hiding the button on scrolling down and showing it on scrolling up. That's intentional, I think that should be responsibility of another component, not the button itself.

This library is `minSdkVersion=14` and if that changes, the version number will be increased, not decreased. It means that Honeycomb, Gingerbread or - gods forbid - Froyo, won't ever be supported. I won't even consider merging pull requests fully implementing support for older versions. We need to move on as Android community and focus on delivering value for 95% of users of modern Android OS instead of jumping through burning hoops to support ancient devices with ancient OS.

If you **really** require support for older Android versions, [str4d](https://github.com/str4d) maintains [a version of this library with `minSdkVersion=4`](https://github.com/str4d/android-floating-action-button).

Credits

=======

I used [FloatingActionButton](https://github.com/makovkastar/FloatingActionButton) library by [Oleksandr Melnykov](https://github.com/makovkastar) as a base for development.

## Copyright and license

Copyright 2014 Zendesk

Licensed under the [Apache License, Version 2.0](LICENSE)