https://github.com/nambicompany/expandable-fab

A highly customizable 'speed dial' FloatingActionButton implementation.
https://github.com/nambicompany/expandable-fab

android android-library android-ui expandablefab-widget floating-action-button floatingactionbutton kotlin kotlin-android kotlin-library material-design speed-dial widget

Last synced: 29 days ago
JSON representation

A highly customizable 'speed dial' FloatingActionButton implementation.

• Host: GitHub
• URL: https://github.com/nambicompany/expandable-fab
• Owner: nambicompany
• License: mit
• Created: 2020-08-04T04:26:36.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2021-10-21T08:16:37.000Z (over 4 years ago)
• Last Synced: 2023-11-07T15:25:13.009Z (over 2 years ago)
• Topics: android, android-library, android-ui, expandablefab-widget, floating-action-button, floatingactionbutton, kotlin, kotlin-android, kotlin-library, material-design, speed-dial, widget
• Language: Kotlin
• Homepage: https://nambicompany.github.io/expandable-fab/
• Size: 8.46 MB
• Stars: 199
• Watchers: 3
• Forks: 21
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
# ExpandableFab

[![Maven Central](https://img.shields.io/maven-central/v/com.nambimobile.widgets/expandable-fab)](https://search.maven.org/artifact/com.nambimobile.widgets/expandable-fab)

[![minSdkVersion](https://img.shields.io/badge/minSdk-15-blue)](/library/build.gradle)

[![Library License](https://img.shields.io/github/license/nambicompany/expandable-fab)](LICENSE.txt)

[![expandable-fab website](https://img.shields.io/badge/docs%20%2F%20website-github.io-blue)](https://nambicompany.github.io/expandable-fab/)

[![The Nambi Company website](https://img.shields.io/badge/visit%20us-nambi.io-blue)](http://www.nambi.io)

A highly customizable Android widget that displays the available actions of a UI via an expandable set of floating action buttons - with optional labels and fluid animations.

Designed to be screen orientation aware, so it can display different elements from portrait to landscape.

## Examples

A working Android app filled with some common use cases and customizations of the ExpandableFab widget can be found and built under [examples](/examples). Below are a few gifs of the widget in use (this isn't an exhaustive list - the ExpandableFab can do so much more!).

![gif of regular ExpandableFab in use](docs/gallery/expandable_fab.gif)

![gif showing custom properties](docs/gallery/highly_customizable.gif)

![gif of using custom sizes](docs/gallery/custom_sizes.gif)

![gif of using multiple ExpandableFabs](docs/gallery/multiple_expandable_fabs.gif)

![gif showing compatibility with BottomAppBar](docs/gallery/bottom_app_bar_compatibility.gif)

![gif showing compatibility with Snackbar](docs/gallery/snackbar_compatibility.gif)

## Usage

Consider reading our Medium articles on [what the ExpandableFab is](https://uxdesign.cc/a-modern-take-on-the-expandable-floating-action-button-for-android-aka-speed-dial-4146e63c658c) and [how to use it](https://uxdesign.cc/how-to-use-the-expandable-floating-action-button-9c6fdedc4169) if you prefer a more in-depth walkthrough.

Otherwise, simply include the ExpandableFab widget in your project via Gradle (replace X.X.X with the latest version shown here [![Maven Central](https://img.shields.io/maven-central/v/com.nambimobile.widgets/expandable-fab)](https://search.maven.org/artifact/com.nambimobile.widgets/expandable-fab)):

```groovy

implementation 'com.nambimobile.widgets:expandable-fab:X.X.X'

```

or Maven:

```xml

  com.nambimobile.widgets

  expandable-fab

  X.X.X

  aar

```

Then easily add some of the ExpandableFab widget views to your layout like so:

```xml

  

            

  

  

  

  

  

  

  

            

```

### Usage Notes

* Make sure to include the `xmlns:app="http://schemas.android.com/apk/res-auto` namespace in each layout file that uses the ExpandableFab widget in order to have access to custom properties.

* Setting ExpandableFabLayout's width and height to match_parent will not impede the viewability, clickability or focusability of any other views in your layout (and is needed for children like `Overlay` who may need the ability to use the full screen).

* Defining separate widgets for portrait and landscape orientations is not necessary and was done above simply to showcase the widget's orientation awareness. By default, if you only define one widget, it will automatically be used for both portrait and landscape orientations.

* Every property in every View within the ExpandableFab widget can be accessed or set programmatically *and* via XML layout files.

* None of the customizable properties for the widget Views were set in the example above, so they will all assume their default values automatically.

    * See the [library website](https://nambicompany.github.io/expandable-fab/) for a full list of every customizable property for each View, the full Kotlin/Java Docs and many more helpful notes and tips on using the ExpandableFab.

## ChangeLog

Please see [CHANGELOG.md](/CHANGELOG.md) for a complete account of all changes in each release of this library.

## Contributing

Please see [CONTRIBUTING.md](/CONTRIBUTING.md) for information about contributing to this library.

## License

```

MIT License

Copyright (c) 2020 Kelvin Abumere and The Nambi Company

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.

```