From 20f182f8ba682e6739c06209d5bd0319fca2e4bd Mon Sep 17 00:00:00 2001 From: Warren Moore Date: Tue, 18 Sep 2012 19:37:16 -0500 Subject: [PATCH] + Improved documentation with examples --- README.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/README.md b/README.md index 01ec324..aa17c00 100644 --- a/README.md +++ b/README.md @@ -8,14 +8,44 @@ 2. `UIAppearance` conformance to allow easy skinning of all elements 3. Dramatic presentation and dismissal animations (tumble, fade, zoom, etc.) +## Usage Examples + Showing an alert is as simple as creating an alert, adding a button, and calling `show`: AHAlertView *alert = [[AHAlertView alloc] initWithTitle:@"Hello, World!" message:@"I'm an alert view!"]; [alert setCancelButtonTitle:@"Dismiss" block:nil]; [alert show]; +If a total of two buttons are added, the alert view will lay them out side-by-side: + +![Two button side-by-side layout example](https://dl.dropbox.com/u/13103695/Screenshots/AHAlertView-TwoButtons.png) + + AHAlertView *alert = [[AHAlertView alloc] initWithTitle:@"Enter Password" message:@"This is a message that might prompt you to do something."]; + [alert setCancelButtonTitle:@"Cancel" block:nil]; + [alert addButtonWithTitle:@"OK" block:nil]; + [alert show]; + +You can use an alert view to prompt for user input, including secure text for password fields, etc.: + +![Secure text entry example](https://dl.dropbox.com/u/13103695/Screenshots/AHAlertView-SecureTextInput.png) + + AHAlertView *alert = [[AHAlertView alloc] initWithTitle:@"Enter Password" message:@"user@example.com"]; + alert.alertViewStyle = AHAlertViewStyleSecureTextInput; + [alert setCancelButtonTitle:@"Cancel" block:^{ + NSLog(@"User canceled the alert instead of entering their password."); + }]; + [alert addButtonWithTitle:@"OK" block:^{ + NSLog(@"User entered the password: %@", [alert textFieldAtIndex:0].text); + }]; + [alert show]; + You can use the block you pass in with the button title to perform any action, including setting a custom dismissal animation based on which button was touched: + + [alert setCancelButtonTitle:@"Cancel" block:^{ alert.dismissalStyle = AHAlertViewDismissalStyleTumble; }];