Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hyperoslo/Brick
:droplet: A generic view model for both basic and complex scenarios
https://github.com/hyperoslo/Brick
Last synced: about 1 month ago
JSON representation
:droplet: A generic view model for both basic and complex scenarios
- Host: GitHub
- URL: https://github.com/hyperoslo/Brick
- Owner: hyperoslo
- License: other
- Created: 2016-04-04T14:52:13.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-01-13T09:09:34.000Z (over 7 years ago)
- Last Synced: 2024-08-02T15:51:46.720Z (about 2 months ago)
- Language: Swift
- Homepage: http://hyper.no
- Size: 373 KB
- Stars: 59
- Watchers: 12
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-ios - Brick - A generic view model for both basic and complex scenarios. (Data Structures / Algorithms / Getting Started)
- awesome-ios-star - Brick - A generic view model for both basic and complex scenarios. (Data Structures / Algorithms / Getting Started)
README
# Brick
[](https://travis-ci.org/hyperoslo/Brick)
[](http://cocoadocs.org/docsets/Brick)
[](https://github.com/Carthage/Carthage)
[](http://cocoadocs.org/docsets/Brick)
[](http://cocoadocs.org/docsets/Brick)
[](http://cocoadocs.org/docsets/Brick)
## Description
Brick is a generic view model for both basic and complex scenarios.
Mapping a basic table view cells is as easy as pie, if you have more properties, you can use the `meta` dictionary to add all additional properties that you might need. It also supports relations so that you can nest view models inside of view models.
```swift
public struct Item: Mappable {
public var index = 0
public var title = ""
public var subtitle = ""
public var text = ""
public var image = ""
public var kind = ""
public var action: String?
public var size = CGSize(width: 0, height: 0)
public var meta = [String : AnyObject]()
}
```
- **.index**
Calculated value to determine the index it has inside of the component.
- **.title**
The headline for your data, in a `UITableViewCell` it is normally used for `textLabel.text` but you are free to use it as you like.
- **.subtitle**
Same as for the title, in a `UITableViewCell` it is normally used for `detailTextLabel.text`.
- **.text**
This is an optional property that can be used for larger amount of text needed to describe your `Item`
- **.image**
Can be either a URL string or a local string, you can easily determine if it should use a local or remote asset in your view.
- **.kind**
Is used for the `reuseIdentifier` of your `UITableViewCell` or `UICollectionViewCell`.
- **.action**
Action identifier for you to parse and process when a user taps on a list item. We recommend [Compass](https://github.com/hyperoslo/Compass) as centralized navigation system.
- **.size**
Can either inherit from the `UITableViewCell`/`UICollectionViewCell`, or be manually set by the height calculations inside of your view.
- **.meta**
This is used for extra data that you might need access to inside of your view, it can be a hex color, a unique identifer or additional images for your view.
## Usage
```swift
let item = Item(
title: "John Hyperseed",
subtitle: "Build machine",
meta: [
"operatingSystem" : "OS X",
"xcodeVersion" : 7.3
])
print(item.meta("operatingSystem", "")) // prints "OS X"
print(item.meta("xcodeVersion", 0.0)) // prints 7.3
```
## Installation
**Brick** is available through [CocoaPods](http://cocoapods.org). To install
it, simply add the following line to your Podfile:
```ruby
pod 'Brick'
```
**Brick** is also available through [Carthage](https://github.com/Carthage/Carthage).
To install just write into your Cartfile:
```ruby
github "hyperoslo/Brick"
```
## Author
Hyper Interaktiv AS, [email protected]
## Contributing
We would love you to contribute to **Brick**, check the [CONTRIBUTING](https://github.com/hyperoslo/Brick/blob/master/CONTRIBUTING.md) file for more info.
## License
**Brick** is available under the MIT license. See the [LICENSE](https://github.com/hyperoslo/Brick/blob/master/LICENSE.md) file for more info.