Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ustwo/US2FormValidator

Form validation framework for iOS.
https://github.com/ustwo/US2FormValidator

Last synced: 3 months ago
JSON representation

Form validation framework for iOS.

Awesome Lists containing this project

README

        

![Import framework screen](https://github.com/ustwo/US2FormValidator/raw/master/Documentation/Images/Form Validator Sample Preview.png)

ustwo™ iOS Form Validator
=========================

[![Build Status](https://travis-ci.org/ustwo/US2FormValidator.png?branch=master)](https://travis-ci.org/ustwo/US2FormValidator)

This framework allows you to validate inputs of text fields and text views in a convenient way.

Features
--------

* Simply use US2ValidatorTextField instead of UITextField (US2ValidatorTextView instead of UITextView)
* Know what went wrong and where
* Create own conditions using regular expressions for example
* Create own validators which contain a collection of conditions

Installation
------------

### Clone the project

Clone the project from the link above.

### Import the framework project into your project

![Import framework screen](https://github.com/ustwo/US2FormValidator/raw/master/Documentation/Images/Import Framework.png)

### Set target dependencies

![Target dependencies screen](https://github.com/ustwo/US2FormValidator/raw/master/Documentation/Images/Target Dependencies.png)

### Add US2Localizable.strings to your projects Copy Bundle Resources

![Target dependencies screen](https://github.com/ustwo/US2FormValidator/raw/master/Documentation/Images/Bundle Resources.png)

Installation using CocoaPods
----------------------------

How to use CocoaPods? Go to:
https://github.com/CocoaPods/CocoaPods

Add the following line to your pod file:

pod 'US2FormValidator', '~> 1.1.2'

How-To
------

### Add a condition to validator

US2Validator *validator = [[US2Validator alloc] init];

US2ConditionAlphabetic *condition = [[US2ConditionAlphabetic alloc] init];
[validator addCondition:condition];
[condition release];

US2ConditionCollection *conditionCollection1 = [validator checkConditions:@"HelloWorld"];
US2ConditionCollection *conditionCollection2 = [validator checkConditions:@"Hello World 123"];

BOOL isValid = conditionCollection1 == nil; // isValid == YES
isValid = conditionCollection2 == nil; // isValid == NO

// What went wrong?
NSLog(@"conditionCollection2: %@", conditionCollection2);

### Add a validation text field

US2ValidatorTextField *firstNameTextField = [[US2ValidatorTextField alloc] init];
firstNameTextField.validator = [[[MyProjectValidatorName alloc] init] autorelease];
firstNameTextField.shouldAllowViolation = YES;
firstNameTextField.validateOnFocusLossOnly = YES;
firstNameTextField.placeholder = @"Enter first name";
firstNameTextField.validatorUIDelegate = self;
[_textUICollection addObject:firstNameTextField];
[firstNameTextField release];

### Create own condition

Create the interface.

#import
#import "US2Condition.h"


@interface MyProjectConditionName : US2Condition

@end

Create the implementation.

#import "MyProjectConditionName.h"


@implementation MyProjectConditionName

- (BOOL)check:(NSString *)string
{
if (nil == string)
string = [NSString string];

self.regexString = @"[a-zA-Z .-]";

return [super check:string];
}


#pragma mark - Allow violation

- (BOOL)shouldAllowViolation
{
return YES;
}


#pragma mark - Localization

- (NSString *)localizedViolationString
{
return @"Not a valid name";
}


@end

### Create own validator

Create the interface.

#import
#import "US2Validator.h"


#pragma mark - Validator interface

@interface MyProjectValidatorName : US2Validator
{
}


@end

Create the implementation.

#import "MyProjectValidatorName.h"
#import "MyProjectConditionName.h"
#import "US2ConditionRange.h"


@implementation MyProjectValidatorName


#pragma mark - Initialization

- (id)init
{
self = [super init];
if (self)
{
[self addCondition:[[[MyProjectConditionName alloc] init] autorelease]];

US2ConditionRange *rangeCondition = [[[US2ConditionRange alloc] init] autorelease];
rangeCondition.range = NSMakeRange(2, UINT16_MAX);
rangeCondition.shouldAllowViolation = YES;

[self addCondition:rangeCondition];
}

return self;
}


@end

[![githalytics.com alpha](https://cruel-carlota.pagodabox.com/5c7741973650e3249271c084dcfd36e2 "githalytics.com")](http://githalytics.com/ustwo/US2FormValidator)