Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/mmick66/CalendarView

An Easy to Use Calendar for iOS (Swift 5.0)
https://github.com/mmick66/CalendarView

calendar calendar-component calendar-view calendarview date date-picker date-time datepicker datetime swift utc

Last synced: about 1 month ago
JSON representation

An Easy to Use Calendar for iOS (Swift 5.0)

Lists

README 

        
![Karmadust](https://github.com/Tobaloidee/CalendarView/blob/master/Assets/logotype.png)



[![Language](https://img.shields.io/badge/Swift-5.0-orange.svg?style=flat)](https://swift.org)

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

[![CocoaPods](https://img.shields.io/cocoapods/v/KDCalendar.svg?style=flat)](https://cocoapods.org/pods/KDCalendar)

[![Awesome](https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg)](https://github.com/vsouza/awesome-ios)

[![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)



This is an easy to use, "just drag and drop it in your code" type of calendar for iOS. It supports both **vertical** and **horizontal** scrolling, as well as native **calendar events**.



![Calendar Screenshot](https://github.com/mmick66/CalendarView/blob/master/Assets/screenshots.png)



# Requirements



* iOS 8.0+

* XCode 9.0+

* Swift 4.2



# Installation



#### CocoaPods



```

pod 'KDCalendar', '~> 1.8.9'

```



#### Carthage



Add this to your Cartfile, and then run `carthage update`:

```

github "mmick66/CalendarView" "master"

```



#### Swift Package Manager



Go to Project -> Swift Packages and add the repository:

```

https://github.com/mmick66/CalendarView.git

```



Add this to your Package.swift:

```

dependencies: [

    .Package(url: "https://github.com/mmick66/CalendarView")

]

```



#### Manual



Just the files from the **CalendarView/** subfolder to your project.



# Setup



The calendar is a `UIView` and can be added either programmatically or via a XIB/Storyboard. **If doing the latter, make sure that the Module is selected to be 'KDCalendar'**.



![IB Screenshot](https://github.com/mmick66/CalendarView/blob/master/Assets/Screenshot.png)



It needs a delegate and data source that comply with:



```Swift

protocol CalendarViewDataSource {

    func startDate() -> NSDate // UTC Date

    func endDate() -> NSDate   // UTC Date

}

protocol CalendarViewDelegate {

    func calendar(_ calendar : CalendarView, canSelectDate date : Date) -> Bool /* optional */

    func calendar(_ calendar : CalendarView, didScrollToMonth date : Date) -> Void

    func calendar(_ calendar : CalendarView, didSelectDate date : Date, withEvents events: [CalendarEvent]) -> Void

    func calendar(_ calendar : CalendarView, didDeselectDate date : Date) -> Void /* optional */

    func calendar(_ calendar : CalendarView, didLongPressDate date : Date, withEvents events: [CalendarEvent]?) -> Void /* optional */

}

```



The data source will provide the **start date** and the **end date** of the calendar. The methods have a default implementation that will return `Date()` resulting in a single-page calendar displaying the current month.



The delegate responds to events such as scrolling and the selection of specific dates.



Note: The dates should be in UTC (same as GMT)



# How to Use



You would want to implement the delegate functions inside your view controller as they appear in the example project.



Say you want to be able to scroll 3 months into the past, then:



```Swift

func startDate() -> Date {

    var dateComponents = DateComponents()

    dateComponents.month = -3

    let today = Date()

    let threeMonthsAgo = self.calendarView.calendar.date(byAdding: dateComponents, to: today)

    return threeMonthsAgo

}

```



You probably still want the calendar to open in today's date, so in this case do:



```Swift

override func viewDidAppear(_ animated: Bool) {

    super.viewDidAppear(animated)

    let today = Date()

    self.calendarView.setDisplayDate(today, animated: false)        

}

```



Say you want tomorrow to be selected for some reason:



```Swift

// can be in the viewDidAppear

let today = Date()

if let tomorrow = self.calendarView.calendar.date(byAdding: tomorrowComponents, to: today) {

  self.calendarView.selectDate(tomorrow)

}

```



### Selecting and Deselecting Dates



The calendar supports the selection of multiple dates. You can select a date either by clicking on a cell or by selecting it programmatically as:



```Swift

self.calendarView.selectDate(date)

```



Similarly you can deselect:



```Swift

self.calendarView.deselectDate(date)

```



You can get all the dates that were selected, either manually or programatically using:



```Swift

self.calendarView.selectedDates

```



### Layout



The calendar supports two basic layouts. Set the `direction` property to `.horizontal` or `.vertical`:



```Swift

calendarView.direction = .horizontal

```



### Styling



The look of this calendar can be set using the `CalendarView.Style` structure. There is an "out of the box" style that can be accessed statically through `CalendarView.Style.Default`. To change it, instantiatia a new Style object and set the variables in their desired value anywhere in your code.



```Swift

override func viewDidLoad() {



    super.viewDidLoad()



    let myStyle = CalendarView.Style()

    // set your values

    calendarView.style = myStyle

}

```



For more information have a look at our [wiki](https://github.com/mmick66/CalendarView/wiki/Styling).

#### Marking Weekends



Some calendars will want to display weekends as special and mark them with a different text color. To do that, first set the marksWeekends variable on the calendarView itself and (optionally) define the color to use.



```Swift

CalendarView.Style.cellTextColorWeekend = UIColor.red

calendarView.marksWeekends = true

```



![IB Screenshot](https://github.com/mmick66/CalendarView/blob/master/Assets/Screen%20Shot%20Mark%20Weekends.png)



The `CellShape` will define whether the dates are displayed in a circle or square with bevel or not.



#### Graying out days



If you want the days that lie outside of the rage set by `startDate` and `endDate`, you can set the color in:



```Swift

CalendarView.Style.cellColorOutOfRange = UIColor(white: 0.0, alpha: 0.5)

```



![IB Screenshot](https://github.com/mmick66/CalendarView/blob/master/Assets/Screen%20Shot%20Out%20of%20Range.png)



#### First Day of the Week



Depending on the culture weeks are considered to start either on a Monday or on a Sunday. To change the way the days are displayed use:



```Swift

CalendarView.Style.firstWeekday = .sunday

```



![IB Screenshot](https://github.com/mmick66/CalendarView/blob/master/Assets/Screen%20Shot%20First%20Day.png)



The calendar defaults to Monday which is standard in Europe.



#### Set locale of calendar



Set the locale for header labels of Weekdays and Month. Use:



```Swift

CalendarView.Style.locale = Locale(identifier: "en_US")

```



![IB Screenshot](https://github.com/mmick66/CalendarView/blob/master/Assets/Screen%20Shots%20Locale.png)



The locale default is Locale.current of your device.



#### Custom Headers



Depending on the language, you might experience problems displaying the month strings in the header. There is however a method you can implement that will return any string you wish according to the date passed.



```Swift

public protocol CalendarViewDataSource {

    /* other methods */

    func headerString(_ date: Date) -> String?

}

```



# Events



This component has the ability to sync events from the system's `EKEventStore`, which is shared with the native calendar provided in iOS. This ability is optional and (in order to keep the calendar's footprint low) needs to be activated seperatly via a custom flag in the build settings as shown below:



![Events Screenshot](https://github.com/mmick66/CalendarView/blob/master/Assets/Screen%20Shot%20Add%20Events.png)



In the "Build Settings," under the "Swift Compiler - Custom Flags" and "Active Compilation Conditions," simply add the `KDCALENDAR_EVENT_MANAGER_ENABLED` flag for both debug and release. The events will be enabled.



#### Loading Events



To load events from the system's calendar call the followint method:



```Swift

self.calendarView.loadEvents()

```



Optionally, a complete handler can be added in case an error is returned



```Swift

self.calendarView.loadEvents() { error in

    if error != nil {

        // handle error

    }

}

```



The code will pop up an alert view to ask the user if he will allow this app to access the calendar. If access is granted we can pass the events to the `CalendarView`, otherwise we get a nil and notify the app about the denial.



#### Creating (Adding) New Events



There is a function that allows you to add a new event in the calendar. It is currently restrictred to a single day (like the rest of the calendar)



```Swift

func addEvent(_ title: String, date: Date, duration hours: NSInteger = 1) -> Bool

```



To detect when the user wants to add a new date, the delegate can implement the `didLongPressDate` method will notify the controller for a long press and the `addEvent` function is usually used in conjuction with this delegate method.



Currently, the example implementation of this repo will open an alert view that will prompt the user for a title to the event and set it for the duration of an hour. Custom controls could be added to further refine the selection.



As with the loading of the events we need to give persmissions to the app.



## About Dates



Calculating dates can be somewhat complicated because while time is an absolute value, dates are a construct of culture: timezones are geopolitical areas and daylight savings times change according to government decision. The best way out of this is to calculate everything in UTC (same as GTM for what we are concerned) and so the `startDate` and `endDate` returned from the delegate should all be in UTC (+0000) time.



## Help Needed



If you want to contribute there are always some open issues marked as [enhancements](https://github.com/mmick66/CalendarView/issues?q=is%3Aissue+is%3Aopen+label%3Aenhancement) in the issues tab. Any help is welcome.