📅 Fully customizable calendar for iOS
Clone or download
Latest commit cb67736 Oct 1, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
CalendarKitDemo class -> AnyObject Sep 24, 2018
Pod Initial commit Oct 19, 2015
Source class -> AnyObject Sep 24, 2018
.gitignore Initial commit Oct 19, 2015
.slather.yml Initial commit Oct 19, 2015
.swift-version Update Swift version Oct 1, 2018
.travis.yml Update travis.yml Sep 24, 2017
CONTRIBUTING.md Update CONTRIBUTING.md Apr 4, 2018
CalendarKit.podspec Version update Oct 1, 2018
ISSUE_TEMPLATE.md Create ISSUE_TEMPLATE.md Dec 25, 2017
LICENSE.md Update info Jan 25, 2017
README.md Update README.md Oct 1, 2018

README.md

CalendarKit CI Status Version License Platform Apps Using Downloads stars

CalendarKit

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.

Demo

You can try CalendarKit with CocoaPods. Just enter in Terminal:

pod try CalendarKit

Watch demo video

Try it live in your browser

Installation

CalendarKit is available through CocoaPods. To install it, add the following line to your Podfile:

pod 'CalendarKit'

Usage

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)")
}

Localization

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:

GermanNorwegianFinnish

Styles

CalendarKit's look can be easily customized. The steps needed for customizations are as follows:

  1. Create a new CalendarStyle object (or copy existing one)
  2. Change style by updating the properties.
  3. Invoke updateStyle method with the new CalendarStyle.
let style = CalendarStyle()
style.backgroundColor = UIColor.black
dayView.updateStyle(style)

Light theme Dark theme

Requirements

  • iOS 9.0+
  • Swift 4.2+

Dependencies

  • Neon is used for declarative layout
  • DateTools is used for date manipulation

Contributing

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.

Author

Richard Topchii

License

CalendarKit is available under the MIT license. See the LICENSE file for more info.