CalendarKit is a fully customizable calendar library written in Swift. It was designed to look similar to iOS Calendar app out-of-the-box, but allow complete customization when needed. To make modifications easy, CalendarKit is composed of multiple small modules. They can be used together, or on their own.
You can try CalendarKit with CocoaPods. Just enter in Terminal:
pod try CalendarKit
CalendarKit is available through CocoaPods. To install it, add the following line to your Podfile:
pod 'CalendarKit'
To install Swift 3 version, add a version requirement to the Podfile:
pod 'CalendarKit', '0.1.22'
Subclass DayViewController and implement DayViewDataSource
protocol to show events.
CalendarKit requires DayViewDataSource
to return an array of objects conforming to EventDescriptor
protocol, specifying all the information needed to display a particular event:
// Return an array of EventDescriptors for particular date
override func eventsForDate(_ date: Date) -> [EventDescriptor] {
var models = // Get events (models) from the storage / API
var events = [Event]()
for model in models {
// Create new EventView
let event = Event()
// Specify StartDate and EndDate
event.startDate = model.startDate
event.endDate = model.endDate
// Add info: event title, subtitle, location to the array of Strings
var info = [model.title, model.location]
info.append("\(datePeriod.beginning!.format(with: "HH:mm")) - \(datePeriod.end!.format(with: "HH:mm"))")
// Set "text" value of event by formatting all the information needed for display
event.text = info.reduce("", {$0 + $1 + "\n"})
events.append(event)
}
return events
}
There is no need to do layout, CalendarKit will take care of it. CalendarKit also creates EventViews
for you and reuses them.
If needed, implement DayViewDelegate to handle user input
override func dayViewDidSelectEventView(_ eventview: EventView) {
print("Event has been selected: \(eventview.data)")
}
override func dayViewDidLongPressEventView(_ eventView: EventView) {
print("Event has been longPressed: \(eventView.data)")
}
CalendarKit supports localization and uses iOS default locale to display month and day names. First day of the week is also selected according to iOS locale. Here are few examples:
CalendarKit's look can be easily customized. The steps needed for customizations are as follows:
- Create a new
CalendarStyle
object (or copy existing one) - Change style by updating the properties.
- Invoke
updateStyle
method with the newCalendarStyle
.
let style = CalendarStyle()
style.backgroundColor = UIColor.black
dayView.updateStyle(style)
- iOS 9.0+
- Swift 4.1+
The list of features currently in development can be viewed at issues page.
Before contributing, it is highly recommended to review guidelines and code style.
Richard Topchii
CalendarKit is available under the MIT license. See the LICENSE file for more info.