Skip to content

Commit

Permalink
Update usage in README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
XenonChau committed May 13, 2017
1 parent e3c9087 commit 7d50d16
Showing 1 changed file with 43 additions and 0 deletions.
43 changes: 43 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,45 @@
# XCTextField

A general UITextField category for input checking.

Whatever in which way your textField was created, just add the following methods:

For configuration: `- configurationWithType:`

For check: `- inputCheckForceCorrect:`

## Usage:

1. Download zip or clone the repo.
2. Drag the folder `XCTextField` into your project.
3. `#import "UITextField+XCTextField.h"`
4. Have fun.

## Sample Code:

```objc
/**
some button action such as commit / login / register etc.
*/
- (void)checkButtonAction:(UIButton *)button {
for (UIView *subview in self.view.subviews) {
if ([subview isKindOfClass:[UITextField class]]) {
[(UITextField *)subview inputCheckForceCorrect:YES];
}
}
}
```

> `- (void)inputCheckForceCorrect:`
> param: `flag` if `YES` the first incorrect textField became first responder.
## Paraphrase:

- `XCTextFieldTypeDefault`: Style None.
- `XCTextFieldTypeCellphone`: PRC mainland Cellphone number style. `UIKeyboardTypePhonePad`.
- `XCTextFieldTypeEmail`: Email format should be "[email protected]". `UITextContentTypeEmailAddress`.
- `XCTextFieldTypePassword`: Security text. `UIKeyboardTypeASCIICapable`.
- `XCTextFieldTypeCAPTCHA`: //@todo:
- `XCTextFieldTypeCreditCard`: //@todo: Luhn algorithm
- `XCTextFieldTypeIDCard`: 18 digital PRC resident ID card number verify. The last character was calculated base on "ISO 7064:1983.MOD 11-2" algorithm.

0 comments on commit 7d50d16

Please sign in to comment.