Skip to content

Latest commit

 

History

History
63 lines (35 loc) · 1.96 KB

README.md

File metadata and controls

63 lines (35 loc) · 1.96 KB
Raw

Alt text

Version License Platform

Example

To run the example project, clone the repo, and run pod install from the Example directory first.

Installation

Shimmeraiser is available through CocoaPods. To install it, simply add the following line to your Podfile:

pod 'Shimmeraiser'

Using Shimmeraiser

Alt text

Shimmeraiser is actually 95%+ covered by tests

Alt text

Step 1: Create a Shimmerable Class.

This class corresponds to the respective layout you want to represent when loading the content. In this file you needs basically to import Shimmeraiser and add all CGRects provided by your UX team to a ShimmerBuilder object. You need to return a ShimmerSettings which you can use the default init or set your own parameters as the animation duration, if the animation is reversible, the size of the animated shadow, and the color.

Alt text

  • WELL DONE! Only few steps to finish your Shimmer :)
Step 2: Run your shimmer!

🔥🔥 Shimmeraiser is pretty simple! As Shimmer is static, you don't need even to initialize it. 🔥🔥

To show your own shimmer, just call on your UIViewController

Shimmer.show(MyCustomShimmer(), in: self)

and to hide, more simple

Shimmer.hide()

Done! A good experience was added to your application.

Author

Victor Panitz Magalhães, [email protected]

License

Shimmeraiser is available under the MIT license. See the LICENSE file for more info.