/Simple-Android-Ripple

A Framer Studio module for adding Android Material Design Touch Ripples to any layer

Primary LanguageJavaScript

Simple-Android-Ripple

A Framer Studio module for adding touch ripple animations to any layer

Installation

  1. First, download the Pointer Module by Jordan Dobson. This module is required.
  2. Download the androidRipple.coffee file.
  3. Create a new Framer project and add both androidRipple.coffee and Pointer.coffee to your /modules folder.
  4. Add Android = require 'androidRipple' at the top of your document.

Sample Project can be found here

More info about modules for Framer Studio: FramerJS Docs - Modules

TextLayer

How to use this module

You only need one line of code to make Simple Android Ripples work. It looks a little something like this:

    layerName.on(Events.Click, Android.Ripple)

Replace layerName with the name of the layer you wish to add a touch ripple to when clicked.

Simple yet powerful customization

This module can accept any Event to fire the ripple. Click is the most commonly used event, but you can also use any of these here.


That's it! the ripple layers will automatically animate in and out for you. When the layers animate out, they will be destroyed for you. Simple.