TouchInstinct
/
TableKit
312
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

bump readme

This commit is contained in:
Max Sokolov 2016-05-15 18:08:51 +03:00
parent ae2707920f
commit a41222300f
2 changed files with 25 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
README.md
View File

@ -24,11 +24,11 @@ Tablet is a super lightweight yet powerful generic library that handles a comple
- [x] Extensibility
- [x] Tests
That's almost all you need in your controller to build a bunch of cells in a section:
That's almost all you need to build a bunch of cells in a section:
```swift
let builder = TableRowBuilder<String, MyTableViewCell>(items: ["1", "2", "3", "4", "5"])
```
Tablet respects cells reusability feature and built with performace in mind. See the Usage section to learn more.
Tablet relies on <a href="https://developer.apple.com/library/ios/documentation/UserExperience/Conceptual/AutolayoutPG/WorkingwithSelf-SizingTableViewCells.html">self-sizing table view cells</a>, respects cells reusability feature and also built with performace in mind. You don't have to worry about anything, just create your cells, setup autolayout constraints and be happy. See the Usage section to learn more.
## Requirements
@ -57,26 +57,6 @@ $ pod install
## Usage
### Very basic
You may want to setup a very basic table view, without any custom cells. In that case simply use the `TableBaseRowBuilder`.
```swift
import Tablet
let rowBuilder = TableBaseRowBuilder<User, UITableViewCell>(items: [user1, user2, user3], id: "reusable_id")
.action(.configure) { (data) in
data.cell?.textLabel?.text = data.item.username
data.cell?.detailTextLabel?.text = data.item.isActive ? "Active" : "Inactive"
}
let sectionBuilder = TableSectionBuilder(headerTitle: "Users", footerTitle: nil, rows: [rowBuilder])
director = TableDirector(tableView: tableView)
director += sectionBuilder
```
### Type-safe configurable cells
Let's say you want to put your cell configuration logic into cell itself. Say you want to pass your view model (or even model) to your cell.
@ -89,6 +69,7 @@ class MyTableViewCell : UITableViewCell, ConfigurableCell {
typealias T = User
// this method is not required to be implemented if your cell's id equals to class name
static func reusableIdentifier() -> String {
return "reusable_id"
}
@ -116,6 +97,26 @@ director = TableDirector(tableView: tableView)
tableDirector += TableSectionBuilder(rows: [rowBuilder])
```
### Very basic table view
You may want to setup a very basic table view, without any custom cells. In that case simply use the `TableBaseRowBuilder`.
```swift
import Tablet
let rowBuilder = TableBaseRowBuilder<User, UITableViewCell>(items: [user1, user2, user3], id: "reusable_id")
.action(.configure) { (data) in
data.cell?.textLabel?.text = data.item.username
data.cell?.detailTextLabel?.text = data.item.isActive ? "Active" : "Inactive"
}
let sectionBuilder = TableSectionBuilder(headerTitle: "Users", footerTitle: nil, rows: [rowBuilder])
director = TableDirector(tableView: tableView)
director += sectionBuilder
```
### Cell actions
Tablet provides a chaining approach to handle actions from your cells:

4
Tablet.podspec
View File

@ -4,7 +4,7 @@ Pod::Spec.new do |s|
s.version = '0.5.0'
s.homepage = 'https://github.com/maxsokolov/tablet'
s.homepage = 'https://github.com/maxsokolov/Tablet.swift'
s.summary = 'Powerful type-safe tool for UITableView. Swift 2.2 is required.'
s.author = { 'Max Sokolov' => 'i@maxsokolov.net' }
@ -13,5 +13,5 @@ Pod::Spec.new do |s|
s.ios.deployment_target = '8.0'
s.source_files = 'Tablet/*.swift'
s.source = { :git => 'https://github.com/maxsokolov/tablet.git', :tag => s.version }
s.source = { :git => 'https://github.com/maxsokolov/Tablet.swift.git', :tag => s.version }
end