在iOS開發中,開發"表單"
介面,欄位稍微多一點的一般都用UITableView來做,而XLForm
就是這樣一個框架,它是建立動態表格檢視最牛逼的iOS庫, 用它實現表單功能,非常簡單,省心省力。但是很可惜,搜尋了很多文章都只是翻譯官方文件,很多人在使用該庫的時候可能都被官方文件帶走遠了,不知道如何具體使用。正好最近也要用到這個庫,所以寫個入門使用文章供大家參考。
一、 匯入專案
使用CocoaPods或者手動匯入庫檔案,本人選擇直接匯入專案原始檔的方式。
二、改造表單ViewController
讓ViewController
繼承自XLFormViewController
,並重寫下面的兩個方法
@interface OneViewController : XLFormViewController
@end
@implementation OneViewController
- (instancetype)initWithNibName:(NSString *)nibNameOrNil bundle:(NSBundle *)nibBundleOrNil {
self = [super initWithNibName:nibNameOrNil bundle:nibBundleOrNil];
if (self){
[self initializeForm];
}
return self;
}
- (id)initWithCoder:(NSCoder *)aDecoder {
self = [super initWithCoder:aDecoder];
if (self){
[self initializeForm];
}
return self;
}
@end
複製程式碼
三、構造表單
- (void)initializeForm {
// 設定是否顯示Cell之間分界線
//self.tableView.separatorStyle = UITableViewCellSeparatorStyleNone;
// 設定Section的高度
self.tableView.sectionHeaderHeight = 30;
XLFormDescriptor * form;//form,一個表單只有一個
XLFormSectionDescriptor * section;//section,一個表單可能有多個
XLFormRowDescriptor * row; //row,每個section可能有多個row
// Form
form = [XLFormDescriptor formDescriptor];
// First section
section = [XLFormSectionDescriptor formSection];
section.title = @"使用者";
[form addFormSection:section];
// 普通文字
row = [XLFormRowDescriptor formRowDescriptorWithTag:@"username" rowType:XLFormRowDescriptorTypeText];
// 設定placeholder
[row.cellConfig setObject:@"使用者名稱" forKey:@"textField.placeholder"];
// 設定文字顏色
[row.cellConfig setObject:[UIColor redColor] forKey:@"textField.textColor"];
[section addFormRow:row];
// 密碼
row = [XLFormRowDescriptor formRowDescriptorWithTag:@"password" rowType:XLFormRowDescriptorTypePassword];
// 設定placeholder的顏色
NSAttributedString *attrString = [[NSAttributedString alloc] initWithString:@"密碼" attributes:
@{NSForegroundColorAttributeName:[UIColor greenColor],
}];
[row.cellConfig setObject:attrString forKey:@"textField.attributedPlaceholder"];
[section addFormRow:row];
// Second Section
section = [XLFormSectionDescriptor formSection];
section.title = @"日期";
[form addFormSection:section];
// 日期選擇器
row = [XLFormRowDescriptor formRowDescriptorWithTag:@"birthday" rowType:XLFormRowDescriptorTypeDate title:@"出生日期"];
row.value = [NSDate dateWithTimeIntervalSinceNow:60*60*24];
[section addFormRow:row];
// Third Section
section = [XLFormSectionDescriptor formSection];
section.title = @"頭像";
[form addFormSection:section];
// 圖片選擇
row = [XLFormRowDescriptor formRowDescriptorWithTag:@"userpic" rowType:XLFormRowDescriptorTypeImage];
[section addFormRow:row];
// Fourth Section
section = [XLFormSectionDescriptor formSection];
section.title = @"選擇器";
[form addFormSection:section];
// 選擇器
row = [XLFormRowDescriptor formRowDescriptorWithTag:@"sex" rowType:XLFormRowDescriptorTypeSelectorPush];
row.noValueDisplayText = @"暫無";
row.selectorTitle = @"性別選擇";
row.selectorOptions = @[@"男",@"女",@"其他"];
row.title = @"性別";
[row.cellConfigForSelector setObject:[UIColor redColor] forKey:@"textLabel.textColor"];
[row.cellConfigForSelector setObject:[UIColor greenColor] forKey:@"detailTextLabel.textColor"];
[section addFormRow:row];
// Fifth Section
section = [XLFormSectionDescriptor formSection];
section.title = @"加固";
[form addFormSection:section];
// 開關
row = [XLFormRowDescriptor formRowDescriptorWithTag:@"enforce" rowType:XLFormRowDescriptorTypeBooleanSwitch title:@"加固"];
[section addFormRow:row];
// Sixth Section
section = [XLFormSectionDescriptor formSection];
[form addFormSection:section];
// 按鈕
row = [XLFormRowDescriptor formRowDescriptorWithTag:@"conform" rowType:XLFormRowDescriptorTypeButton];
row.title = @"確定";
[section addFormRow:row];
self.form = form;
}
-(void)didSelectFormRow:(XLFormRowDescriptor *)formRow{
// 判斷是不是點選了確定按鈕
if([formRow.tag isEqualToString:@"conform"] && formRow.rowType == XLFormRowDescriptorTypeButton){
//獲取表單所有到的值
NSDictionary *values = [self formValues];
NSLog(@"%@", values);
}
[super didSelectFormRow:formRow];
}
//重寫改該方法 上面的方法就不會呼叫了
//-(void)tableView:(UITableView *)tableView didSelectRowAtIndexPath:(NSIndexPath *)indexPath{
//
// NSLog(@"%s", __func__);
//
//}
@end
複製程式碼
四、效果圖
五、總結
前面兩步是官方文件中可以找到的,也很簡單,關鍵在於initializeForm
方法中具體構造表單的過程,這裡有必要強調幾點:
XLFormViewController
實現了UITableViewDataSource, UITableViewDelegate
,並且持有一個UITableView
,這個從該類的宣告可以看出來,所以UITableView 、UITableViewDataSource, UITableViewDelegate
中的方法都可以正常使用。
@interface XLFormViewController : UIViewController<UITableViewDataSource, UITableViewDelegate, XLFormDescriptorDelegate, UITextFieldDelegate, UITextViewDelegate, XLFormViewControllerDelegate>
複製程式碼
XLForm
將表單抽象為Form
,Section
,Row
三個層次,分別對應三個類
XLFormDescriptor * form;//form,一個表單只有一個
XLFormSectionDescriptor * section;//section,一個表單可能有多個
XLFormRowDescriptor * row; //row,每個section可能有多個row
複製程式碼
-
每個表單中的具體資訊最後都落腳到
XLFormRowDescriptor
中,通過它可以配置不同樣式的表單項,通過建構函式的rowType
指定具體的表單型別,該框架提供了非常豐富的rowType
,具體可以參考官方文件說明。 -
更細化配置表單項就需要藉助於
XLFormRowDescriptor
中的屬性進行配置,常用的有
@property (nonatomic, readonly, nonnull) NSMutableDictionary * cellConfig;
@property (nonatomic, readonly, nonnull) NSMutableDictionary * cellConfigForSelector;
複製程式碼
這個配置的時候,往往有同學不知道具體如何才能設定屬性,比如怎麼設定表單輸入框的placeholder
?更進一步如何設定placeholder
的顏色。其實它用到了KVC
,因為它們兩個都是UITextField
類中的屬性,那麼直接進入UITextField
查詢,發現如下資訊:
@property(nullable, nonatomic,copy) NSString *placeholder;
@property(nullable, nonatomic,copy) NSAttributedString *attributedPlaceholder NS_AVAILABLE_IOS(6_0);
複製程式碼
那麼設定起來就是
[row.cellConfig setObject:@"使用者名稱" forKey:@"textField.placeholder"];
[row.cellConfig setObject:attrString forKey:@"textField.attributedPlaceholder"];
複製程式碼
注意這裡的key的寫法,就是KVC
的寫法。其他的屬性依此類推。
- 如何獲取設定好的表單的值?其實非常簡單,該框架提供一個方法
formValues
,它的返回型別是一個NSDictionary
,其中key
就是XLFormRowDescriptor
設定時的Tag
。可以直接在控制器中呼叫該方法獲取表單值,上面的效果圖設定後的表單資訊如下: