Skip to content

Commit 9009771

Browse files
committed
Updated README
1 parent aff4958 commit 9009771

1 file changed

Lines changed: 82 additions & 3 deletions

File tree

README.md

Lines changed: 82 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,83 @@
1-
RAMCollectionViewFlemishBondLayout
2-
==================================
1+
#Introduction
32

4-
UICollectionViewLayout for displaying cells in groups (highlighting one of them).
3+
**RAMCollectionViewFlemishBondLayout** was written by **[Rafael Aguilar](https://twitter.com/rais38)** for **[Crows & Dogs](http://www.crowsanddogs.com)**.
4+
5+
`RAMCollectionViewFlemishBondLayout` is a `UICollectionViewLayout` subclass for displaying cells in groups (highlighting one of them) with optional header and footer views. Highlighted cell occupy much of the space and the remaining cells occupy space equally. See the example screenshots for what this looks like.
6+
7+
#Screenshots
8+
9+
<p align="center" >
10+
<img src="https://raw.github.com/TopicSo/RAMCollectionViewFlemishBondLayout/master/Screenshots/screenshot1.png" alt="Screenshot 1" title="Screenshot 1" height="600">
11+
</p>
12+
<p align="center" >
13+
<img src="https://raw.github.com/TopicSo/RAMCollectionViewFlemishBondLayout/master/Screenshots/screenshot2.png" alt="Screenshot 2" title="Screenshot 2" height="600">
14+
</p>
15+
16+
#Usage
17+
##Setup Instructions
18+
19+
###Cocoapods
20+
21+
[CocoaPods](http://cocoapods.org) is a dependency manager for Objective-C, which automates and simplifies the process of using 3rd-party libraries in your projects.
22+
23+
####Podfile
24+
25+
pod 'RAMCollectionViewFlemishBondLayout', '~> 1.0.0'
26+
27+
###Manual
28+
29+
Add `RAMCollectionViewFlemishBondLayout` folder to your project.
30+
31+
##Example
32+
33+
self.collectionViewLayout = [[RAMCollectionViewFlemishBondLayout alloc] init];
34+
self.collectionView.collectionViewLayout = self.collectionViewLayout;
35+
36+
##Properties
37+
38+
* `numberOfElements`: Number to be grouped cells (Default: 3).
39+
* `highlightedCellWidth`: Width of highlighted cell.
40+
* `highlightedCellHeight`: Height of highlighted cell.
41+
42+
##RAMCollectionViewFlemishBondLayoutDelegate
43+
44+
All are optional.
45+
46+
* `collectionView:layout:highlightedCellDirectionForGroup:atIndexPath:`: Ask the delegate the direction of the highlighted cell on a particular group. Available values: `RAMCollectionViewFlemishBondLayoutGroupDirectionLeft` & `RAMCollectionViewFlemishBondLayoutGroupDirectionRight`.
47+
* `collectionView:layout:estimatedSizeForHeaderInSection:`: Asks the delegate for the size of the header view in the specified section.
48+
* `collectionView:layout:estimatedSizeForFooterInSection:`: Asks the delegate for the size of the footer view in the specified section.
49+
50+
# Tasks List
51+
* Support for more than 1 section
52+
* Sticky header
53+
54+
# Requirements
55+
56+
Requires iOS 6.0+ and ARC.
57+
58+
# Contributing
59+
60+
Forks, patches and other feedback are welcome. [I just would love to know](mailto:rais38@gmail.com) if you're using it in any project.
61+
62+
# MIT License
63+
64+
This code is distributed under the terms and conditions of the MIT license.
65+
66+
Permission is hereby granted, free of charge, to any person obtaining a
67+
copy of this software and associated documentation files (the
68+
"Software"), to deal in the Software without restriction, including
69+
without limitation the rights to use, copy, modify, merge, publish,
70+
distribute, sublicense, and/or sell copies of the Software, and to
71+
permit persons to whom the Software is furnished to do so, subject to
72+
the following conditions:
73+
74+
The above copyright notice and this permission notice shall be included
75+
in all copies or substantial portions of the Software.
76+
77+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
78+
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
79+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
80+
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
81+
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
82+
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
83+
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

0 commit comments

Comments
 (0)