Skip to content

Latest commit

 

History

History
92 lines (62 loc) · 2.88 KB

README.md

File metadata and controls

92 lines (62 loc) · 2.88 KB
Raw

Chandelier

Android Arsenal Maven Central Travis

A nice swipe layout that provides new actions with a material design look and feel.

Demo Screen Capture

Demo Screen Capture

Installation

Step 1. Add the JitPack repository to your build file

allprojects {
  repositories {
    ...
    maven { url 'https://jitpack.io' }
  }
}

Step 2. Add the dependency

dependencies {
  implementation 'com.github.prolificinteractive:chandelier:${chandelierVersion}'
}

Usage

  1. Wrap your list around ChandelierLayout in your layouts or view hierarchy.
  2. Add a list of ActionItem using ChandelierLayout#populateActionItems() method.
  3. Set a OnActionSelectedListener to listen for selected action and update the view accordingly.

Or

1 Wrap your list around ChandelierLayout in your layouts or view hierarchy. 2. Create Objects that extend ActionItem and add them using ChandelierLayout#populateActionItems() method. 3. Override ActionItem#Execute() method to execute the action when selected.

Example:

  <com.prolificinteractive.chandelier.widget.ChandelierLayout
      android:id="@+id/chandelier_layout"
      android:layout_width="match_parent"
      android:layout_height="match_parent"
      app:al_background="?attr/colorPrimary"
      >
      
      <!-- Insert your list here -->
      <include layout="@layout/example_recycler_view" />
  
  </com.prolificinteractive.chandelier.widget.ChandelierLayout>

Customization

XML attributes:

  • al_background Set background color

  • al_elevation Set elevation

  • al_selector Set background selector

  • al_animate_to_start_duration Set the duration that the layout takes to get into its original position. Default is 300 Millisecond.

  • ai_margin Set action item margin

Make sure to check sample for more examples.

Contributing

Would you like to contribute? Fork us and send a pull request! Be sure to checkout our issues first.

License

Chandelier is Copyright (c) 2018 Prolific Interactive. It may be redistributed under the terms specified in the LICENSE file.

Maintainers

prolific

Chandelier is maintained and funded by Prolific Interactive. The names and logos are trademarks of Prolific Interactive.