material-motion-archive / pop-swift Goto Github PK

View Code? Open in Web Editor NEW

4.0 4.0 1.0 169 KB

Archived February 16, 2017 :: POP plan types for Apple devices

License: Apache License 2.0

Ruby 7.01% Swift 85.32% Objective-C 7.68%

pop-swift's People

Contributors

Stargazers

Watchers

Forkers

carabina

pop-swift's Issues

Paused spring can be resumed mid-gesture with SpringTo

runtime.addPlan(SpringTo(property, foo_destination));
// Spring now active.

runtime.addPlan(PausesSpring(property, gesture));
gesture.setState(BEGAN); 
// Spring now paused.

runtime.addPlan(SpringTo(property, bar_destination));
// Spring now active - oops too early!

gesture.setState(RECOGNIZED);
// Spring should now be active.

Animation completion should assert if no token was found

We currently silently ignore animations that complete without a corresponding token. This situation should not happen, so we should use a stronger assertion of the token's existence.

This will also improve our testing coverage.

Build configuration into spring plan

Right now, there's a springTo and configureSpring. The need to configure a spring mid-flight feels hypothetical.

Can we reduce it to one plan: springTo(destination, config?)?

Create ConfigureSpring plan

Spec: https://material-motion.gitbooks.io/material-motion-starmap/content/specifications/motion_family/springs.html

Add README.md guide explaining how to animate custom properties

Cut the v1.0.0 release

This must be run by a @material-motion/core-team member.

mdm release cut

Write the README.md

Should include the following:

Installation steps. (Steal the ones from here).
Getting started example.

Assume that this repo is the entry-point for an application developer who has never used Material Motion before.

Document the tap-to-toggle demo in the catalog

Source code should include dense documentation explaining the material motion aspects of the code.

Implement VelocitySource

Spec: https://material-motion.github.io/material-motion/starmap/specifications/plans/VelocitySource

Support changing toValue of animations

This feature request is resulting from explorations found in https://github.com/material-motion/material-motion-catalog-swift/issues/1.

The creator of a POPAnimation object is unable to change the toValue on the object after committing it to a scheduler. This is because we copy the animation objects and pop does not appear, and rightfully so, to maintain a connection between these two instances.

One approach that will appear within the broader context of Material Motion is to configure existing pop animation objects when a new one with the same name is added to a target. This may be how pop already works if we use the key argument.

If this is not how POP works then we may need to implement the mapping of state ourselves. Specifically, we'll need to extract the various properties that may be set on the animation when a new one with the same name is committed.

Note: This functionality may be somewhat easier to build once performers support named plans.

Add a demo showing a meta plan that captures a complex POP animation

This demo should be a simplification of the tap-to-toggle demo in which we register a circular dimension plan that composes out to the necessary POP animations.

Publish the v1.0.0 release

Must be ran by a member of the @material-motion/core-team

mdm release publish 1.0.0

Rename the pod to MaterialMotionPopFamily

This maintains consistency with our other motion family pod names which follow a MateraiLmotion<name>Family pattern.

Create SpringAnimation plan

This should model POPSpringAnimation, but only exposing the properties that we support.

Is-active tokens should be acquired on pop_animationDidStart

pop_animationDidStart is invoked the moment a POP animation begins. This method can be called multiple times if the animation isn't removed on completion.

Should also implement a unit test for animations that aren't removed on completion.

Increase unit test coverage to 100%

It is 93% as of 4662c20.

Missing tests:

Committing a pop animation to a view.

Configuration should be a required property

As per discussion here: https://groups.google.com/forum/#!topic/material-motion/UTnXKlEYOOQ

Document the SpringTo plan

Support custom key path properties

We presently only support the properties explicitly listed in POPProperty. Ideally we'd support any key path.

Unsupported key paths should fall-through to a get/setValueForKeyPath read/writer, if possible

Write a usage guide in the README.md

Should show how to add a pop animation to a scheduler. Should also show how to emit pop animation objects from other performers (composition).

Move SpringTo to a SpringTo.swift file

This will make it easier to navigate the repo once we start adding more plan types.

Generate and publish documentation

jazzy
cd docs
git init
git add .
git commit -am "Initial commit of documentation"
git branch -m gh-pages
git remote add [email protected]:material-motion/material-motion-family-pop-swift.git
git push origin gh-pages

Make property a string like Core Animation in order to unify how properties work

We currently expose a POPProperty type that clearly shows which properties we support for pop's SpringTo implementation. This API is inflexible and makes it difficult to commit SpringTo values to the target directly using traditional setValueForKeyPath APIs.

Goal of this task is to explore a string-based property API that is a traditional key path. We'll need to map these key paths to internal POPProperties.

Tap to toggle example doesn't animate cornerRadius and bounds at same speed

This can create non-rounded artifacts while animating the circle between its two sizes. One solution here would be to associate the cornerRadius and bounds with a single property to which we add a SpringTo animation. This will require resolution of #19 first.