diff --git a/README.md b/README.md index 099bfc9..fe9c7a6 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,27 @@ -NRTextTransitions -================= +#NRTextTransitions -#Basic, block based, text transitions +##Basic, block based, text transitions NRTextTransitions is a category in UIView that makes easier handling animated text transitions for UILabel, UITextView and UITextField. As the standard +[UIView animateWithDuration:animations:] is not able to animate non-animatable properties, and text, font and textColor properties of UILabel, UITextView and UITextField, are non-animatable, you need to use CATransition to do so with animation. NRTextTransitions uses a similar API to the standard UIView class methods, encapsulating the changes passed in the `animations` parameter block. In order to apply the transitions to the objects mentioned in this block, you **MUST** create an array, add the objects to this array, and pass it in the 'textObjects' parameter. -#Example \ No newline at end of file +##Example + +``` + exampleLabel.text = @"I'm the old text!"; + exampleLabel.backgroundColor = [UIColor whiteColor]; + + [UIView animateTextTransitionForObjects:@[exampleLabel] withDuration:0.75 delay:0 animations:^{ + exampleLabel.text = @"And I'm animated!"; + } completion:^{ + exampleLabel.backgroundColor = [UIColor colorWithWhite:0.8 alpha:0.5]; + }]; +``` + +##Installation + +You have two options: + +* Use CocoaPods - Search for NRTextInstallation in CocoaPods +* Copy the files "UIView+NRTextTransitions.h/m" and "NRTextTransitionCompletionManager.h/m" \ No newline at end of file