Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/RamonGilabert/Walker

Each step you take reveals a new horizon. You have taken the first step today.
https://github.com/RamonGilabert/Walker

Last synced: 3 months ago
JSON representation

Each step you take reveals a new horizon. You have taken the first step today.

Awesome Lists containing this project

README

        

![Walker](https://github.com/RamonGilabert/Walker/blob/master/Resources/header-image.png)

[![Carthage](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)
[![Version](https://img.shields.io/cocoapods/v/Walker.svg?style=flat)](http://cocoadocs.org/docsets/Walker)
[![License](https://img.shields.io/cocoapods/l/Walker.svg?style=flat)](http://cocoadocs.org/docsets/Walker)
[![Platform](https://img.shields.io/cocoapods/p/Walker.svg?style=flat)](http://cocoadocs.org/docsets/Walker)
[![Documentation](https://img.shields.io/cocoapods/metrics/doc-percent/Walker.svg?style=flat)](http://cocoadocs.org/docsets/Walker)
![Swift](https://img.shields.io/badge/%20in-swift%203.0-orange.svg)

## The story

Seeing the animations behind Paper, or the transitions behind Mail, being in a world of flat design and transitions, user interaction, app behavior and responsiveness are key, we need good and fast animations to delight our users in every tap, every scroll, every moment that they spend in our app.

After lots of apps, designs and animations, after trying some of the most famous web frameworks and after I learnt FramerJS, which has one of the most beautiful springs I've seen. I'm building a collection of my knowledge, as I said when I was learning iOS development I would do, let me present **Walker** to you, an animation engine and library.

**Walker** has a bohemian companion that wanders with him, **[Morgan](https://github.com/RamonGilabert/Morgan)**, a set of animations that will make your life easier when developing iOS apps. Note that Morgan is unfinished and always improving.

## Code

**Walker** has different types of use cases and behaviors, you can either have a chain of animations with different blocks and callbacks, or reuse animations and apply them in different cases.

```swift
animate(view) {
$0.alpha = 1
}.then {
print("First animation done")
}.chain {
$0.width = 300
}.finally {
print("Animations done")
}
```

Inside every animation there are different curves, the basic ones, which are Linear, Ease, EaseIn, EaseOut and EaseInOut, a custom Cubic Bezier and a Spring animation.

#### Cubic Bezier

Considering Linear, Ease, EaseIn, EaseOut and EaseInOut cubic animations, the following animation will just have the Bezier one, even though everything is called the same way.

```swift
animate(view, curve: .Bezier(1, 0.4, 1, 0.4)) {
$0.x = 100
}
```

![Bezier](https://github.com/RamonGilabert/Walker/blob/master/Resources/bezier.gif)

#### Springs

Springs are the most beautiful animations in the spectrum, taking inspiration of the curve used in FramerJS, you'll have a look alike feel that you are going to be able to configure like the following set.

```swift
spring(view, spring: 200, friction: 10, mass: 10) {
$0.x = 40
}
```

![Spring](https://github.com/RamonGilabert/Walker/blob/master/Resources/spring.gif)

#### Chains

As stated in the first example, you can chain animations, but not only animations with the same curve, every block has an independent status, so you'll be able to chain springs and bezier animations, being notified when everything finishes if you want.

```swift
spring(view, spring: 200, friction: 10, mass: 10) {
$0.x = 100
}.chain {
$0.x = 0
}
```

![Chain](https://github.com/RamonGilabert/Walker/blob/master/Resources/chain.gif)

#### Create your own

It wouldn't be a good animation engine if you couldn't reuse animations, there's a component inside the engine called Still, this one will talk to the background motor and will provide you with a `CAKeyframeAnimation`, just by calling this:

```swift
let animation = Still.bezier(.PositionX, curve: .Bezier(1, 0.4, 1, 0.4))
```

Still can have, as the engine above, Cubic Bezier and Spring animations inside, each one configured differently. Note also that this will provide a layer animation.

Finally, this animation won't be tight to a final value or to any view, so you can reuse it across by distilling it:

```swift
distill((animation: animation, final: 100), view: view)
```

Distill works with as many animations at a time as you want.

![Bezier](https://github.com/RamonGilabert/Walker/blob/master/Resources/bezier.gif)

#### More questions?

Have more questions and want to see more implementation in detail? We have a [demo](https://github.com/RamonGilabert/Walker/tree/master/Demo/Walker) for you. Inside it you'll find some different animations applied into different views, you can check the file right [here](https://github.com/RamonGilabert/Walker/blob/master/Demo/Walker/Walker/ViewController.swift#L51). If you still have something unclear, don't hesitate to [contact me](mailto:[email protected]) or [open an issue](https://github.com/RamonGilabert/Walker/issues).

## Installation

**Walker** is available through [CocoaPods](http://cocoapods.org). To install
it, simply add the following line to your Podfile:

```ruby
pod 'Walker'
```

**Walker** is also available through [Carthage](https://github.com/Carthage/Carthage). To install just write into your Cartfile:

```ruby
github 'RamonGilabert/Walker'
```

## Upcoming features

Check out the [ROADMAP](https://github.com/RamonGilabert/Walker/blob/master/ROADMAP.md) file to see the upcoming features that we are thinking to implement and don't hesitate to [open an issue](https://github.com/RamonGilabert/Walker/issues) or make a PR with a proposal in the roadmap.

## Author

Ramon Gilabert with ♥️

## Contribute

We would love you to contribute to **Walker**, check the [CONTRIBUTING](https://github.com/RamonGilabert/Walker/blob/master/CONTRIBUTING.md) file for more info.

## License

**Walker** is available under the MIT license. See the [LICENSE](https://github.com/RamonGilabert/Walker/blob/master/LICENSE.md) file for more info.