Introduction

MSCollectionViewCalendarLayout was written by Eric Horacek for Monospace Ltd.

MSCollectionViewCalendarLayout is a UICollectionViewLayout subclass for displaying chronological data. It divides its cells into columns of days, with the size of each cell corresponding to its length. MSCollectionViewCalendarLayout is very similar to the "Week" view in the Apple Calendar/iCal app. See the example screenshots for what this looks like.

UICollectionView?

UICollectionView is awesome. If you're unfamiliar, read Mattt Thompson's excellent article about them on NSHipster. Everyone should use them (yes, even instead of good ol' UITableView). This is especially true now that iOS 6 adoption is over 85% (As of March, 2013). Also see Drop iOS 5: Only support iOS 6. It's the right thing to do.

Example

The example project queries the SeatGeek API for the next 1000 sport events near Denver, Colorado. It displays these events in a UICollectionView using MSCollectionViewCalendarLayout. It requires CocoaPods (For RestKit, Cupertino Yankee, and UIColor-Utilities). If you don't have CocoaPods installed, you can learn how to do so here.

To set it up, just run:

$ pod install

in the Example directory, and then build and run the Example target in the Example.xcworkspace that it creates.

Screenshots

Usage

##CocoaPods

Add MSCollectionViewCalendarLayout to your Podfile and run $ pod install.

Section Layouts

On the iPhone, MSCollectionViewCalendarLayout defaults to tiling its day sections vertically. The day column headers act as they do in a table view, sticking to the top until they're replaced by the next day's as your scroll. On the iPad, the day sections are tiled horizontally. This behavior is controlled by the sectionLayoutType property. Its values can be:

• MSSectionLayoutTypeHorizontalTile – Day sections tile vertically.
• MSSectionLayoutTypeVerticalTile – Day sections tile horizontally.

Collection View Elements

MSCollectionViewCalendarLayout has eight different elements that you should register UICollectionReusableView or UICollectionViewCell classes for. They are as follows:

• Event Cell (UICollectionViewCell) – Represents your events.
• Day Column Header (UICollectionReusableView) – Contains the day text, top aligned.
• Time Row Header (UICollectionReusableView) – Contains the time text, left aligned.
• Day Column Header Background (UICollectionReusableView) – Background of the day column header.
• Time Row Header Background (UICollectionReusableView) – Background of the time row header.
• Current Time Indicator (UICollectionReusableView) – Displayed over the time row header, aligned at the current time.
• Current Time Horizontal Gridline (UICollectionReusableView) – Displayed under the cells, aligned to the current time.
• Horizontal Gridilne (UICollectionReusableView) – Displayed under the cells, aligns with its corresponding time row header.

If you think there should be more of these, don't hesitate to add them in a pull request. To see how this is done, check the example.

Invalidating Layout

If you change the content of your MSCollectionViewCalendarLayout, make sure to call the invalidateLayoutCache method. This flushes the internal caches of your MSCollectionViewCalendarLayout, allowing the data to be repopulated correctly.

Can I call performBatchUpdates:completion: to make suff animate?

Don't do this. It doesn't work properly, and is a "bag of hurt".

Requirements

Requires iOS 6.0 and ARC.

Contributing

Forks, patches and other feedback are welcome.

License

Copyright (c) 2013 Monospace Ltd. All rights reserved.

This code is distributed under the terms and conditions of the MIT license.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.