This repo houses the JavaScript implementation of Material Motion. For more information about the project as a whole, check the Starmap.

• To make gestural interactions as easy to reuse across applications as UI components already are.

• To enable the motions and gestures described in the Material Spec to be easily implemented by application authors in the JS ecosystem.

• To make prototyping new animated experiences simpler.

• To yield a system that feels robust by default. Fragile interactions erode user trust in the overall system: “should I enter my password in a glitchy app?”

• To allow interactions to be inspected and tweaked with visual tools.

• To allow interactions to be easily ported across platforms.

• To allow authors to write views in terms of URLs, and have the system guide the transitions between them.

  • Note: This is an eventual goal. In the near term, Material Motion is focused specifically on aiding the creation of reusable gestural interactions.

This repo houses all the packages that comprise the Material Motion implementation for JavaScript. They are available in packages:

• core houses the core implementation of Material Motion; including MotionObservable, and ReactiveProperty. To use it in an application, you'll also need an adapter such as material-motion-views-dom or material-motion-views-react. This package is published on NPM as material-motion.

• views-dom houses the adapter that supports using Material Motion in the DOM with connectInteractionToElements().

• views-react houses the adapter that supports using Material Motion in React with createMotionComponent().

Want to contribute? Awesome - thanks for helping!

To get started, just run these commands:

git clone git@github.com:material-motion/material-motion-js.git
cd material-motion-js
yarn
$( yarn bin )/lerna bootstrap

They will check out the repo, install the dependencies for each package, and link the packages to one another. Then, find the package you want to work on in packages and start coding!

Apache 2.0