Skip to content

Latest commit

 

History

History
247 lines (195 loc) · 8.52 KB

README.md

File metadata and controls

247 lines (195 loc) · 8.52 KB

Mijick Header

Mijick GitHub Mijick Twitter Mijick Mail Separator


CalendarView Logo

Calendar View

Create fully customisable calendar in no time. Keep your code clean

Try demo we prepared | Roadmap | Propose a new feature


SwiftUI logo Platforms: iOS, iPadOS, macOS, tvOS Current Version License: MIT

Made in Kraków Stargazers

Calendar Example 1 Calendar Example 2 Calendar Example 3 Calendar Example 4


CalendarView is a free and open-source library designed for SwiftUI that makes the process of creating calendars easier and much cleaner.

  • Improves code quality. Create a calendar using MCalendarView constructor and pass the selected date / range to it. Simple as never!
  • Customize calendar in no time. We know how important customisation is; that's why we give you the opportunity to design your calendar in any way you like.
  • Designed for SwiftUI. While developing the library, we have used the power of SwiftUI to give you powerful tool to speed up your implementation process.

Getting Started

✋ Requirements

Platforms Minimum Swift Version
iOS 14+ 5.0
iPadOS 14+ 5.0
macOS 11+ 5.0
watchOS 7+ 5.0

⏳ Installation

Swift Package Manager is a tool for automating the distribution of Swift code and is integrated into the Swift compiler.

Once you have your Swift package set up, adding CalendarView as a dependency is as easy as adding it to the dependencies value of your Package.swift.

dependencies: [
    .package(url: "https://github.com/Mijick/CalendarView.git", branch(“main”))
]

Cocoapods is a dependency manager for Swift and Objective-C Cocoa projects that helps to scale them elegantly.

Installation steps:

    pod init
  • Add CocoaPods dependency into your Podfile
    pod 'MijickCalendarView'
  • Install dependency and generate .xcworkspace file
    pod install
  • Use new XCode project file .xcworkspace

Usage

1. Call initialiser

To declare a CalendarView, call the constructor:

struct ContentView: View {
    @State private var selectedDate: Date? = nil
    @State private var selectedRange: MDateRange? = .init()

    var body: some View {
        MCalendarView(selectedDate: $selectedDate, selectedRange: $selectedRange)
    }
}

2. Customise Calendar

Your MCalendarView can be customised by calling configBuilder inside the initialiser:

struct ContentView: View {
    @State private var selectedDate: Date? = nil
    @State private var selectedRange: MDateRange? = .init()

    var body: some View {
        MCalendarView(selectedDate: nil, selectedRange: $selectedRange) {
            $0
                (...)
                .dayView(NewDayView.init)
                .firstWeekday(.wednesday)
                .monthLabelToDaysDistance(12)
                .weekdaysView(NewWeekdaysView.init)
                (...)
        }
    }
}

3. Customizing WeekdaysView / WeekdayLabel / MonthLabel / DayView

Each calendar element can be easily customised by creating your own view by inheriting the protocol (check Demo Project for more details).


Try our demo

See for yourself how does it work by cloning project we created

License

CalendarView is released under the MIT license. See LICENSE for details.



Our other open source SwiftUI libraries

PopupView - The most powerful popup library that allows you to present any popup
NavigationView - Easier and cleaner way of navigating through your app
GridView - Lay out your data with no effort
CameraView - The most powerful CameraController. Designed for SwiftUI
Timer - Modern API for Timer