Skip to content

Latest commit

 

History

History
80 lines (52 loc) · 3.36 KB

README.md

File metadata and controls

80 lines (52 loc) · 3.36 KB

VENCalculatorInputView

Build Status

VENCalculatorInputView is the calculator keyboard that is used in the Venmo iOS app. Available for iOS 6 and beyond. Enjoy.

alt text

Installation

The easiest way to get started is to use CocoaPods. Just add the following line to your Podfile:

pod 'VENCalculatorInputView', '~> 1.5'

Sample Usage

You can choose to use just VENCalculatorInputView (only the keyboard) and define your own behavior or use VENCalculatorInputTextField (keyboard + text field with money calculation built in).

Using just the calculator keyboard

1. Set the input view.

Find the UITextField or UITextView that you want to display the keyboard and set its inputView to an instance of VENCalculatorInputView.

myTextField.inputView = [VENCalculatorInputView new];

This will have VENCalculatorInputView display when myTextField becomes firstResponder instead of the system keyboard.

2. Implement the <VENCalculatorInputViewDelegate> methods.

First, have a class implement the <VENCalculatorInputViewDelegate> protocol and set myTextField.inputView.delegate to an instance of that class.

Next, implement the delegate method that handles keyboard input:

- (void)calculatorInputView:(VENCalculatorInputView *)inputView didTapKey:(NSString *)key {
    NSLog(@"Just tapped key: %@", key);
    // Handle the input. Something like [myTextField insertText:key];
}

Finally, implement the delegate method that handles the backspace key:

- (void)calculatorInputViewDidTapBackspace:(VENCalculatorInputView *)calculatorInputView {
    NSLog(@"Just tapped backspace.");
    // Handle the backspace. Something like [myTextField deleteBackward];
}

Try it!

You can read more about custom keyboards in Apple’s documentation.

Using the calculator text field (optimized for money calculation)

All you need to do is use VENCalculatorInputTextField instead of UITextField and use it like normal text field. It will automagically handle the input and make calculations. Take a look at out our VENCalculatorInputViewSample project.

Localization

Different regions use different symbols as their decimal separator (e.g. ., ,). By default, VENCalculatorInputView and VENCalculatorInputTextField use the current locale of the device. You can change it by setting the locale property.

Testing

We’ve written some tests. You can run them by opening the project in Xcode and hitting Command-U.

Contributing

We’d love to see your ideas for improving this library! The best way to contribute is by submitting a pull request. We’ll do our best to respond to your patch as soon as possible. You can also submit a new GitHub issue if you find bugs or have questions. :octocat:

Please make sure to follow our general coding style and add test coverage for new features!