Skip to content

OBCalendar is designed for simplicity and customization, it allows you to build beautiful and functional calendar interfaces effortlessly.

License

Notifications You must be signed in to change notification settings

oBilet/OBCalendar

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

76 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

OBCalendar

  • OBCalendar is a SwiftUI-based calendar library designed to allow you to easily create your own custom calendars. With this structure, you can customize the days, months, and years. Additionally, you can change the localization of the calendar and display days within specific ranges.
  • Users set the startDate and endDate in OBCalendar, and the range is created automatically.

Documentation and Tutorial

Example Designs

Requirements

  • iOS 14+
  • Swift 5.10+

Installation

To integrate OBCalendar into your project using Swift Package Manager, follow these steps:

  • Open your Xcode project.

  • Go to File > Add Packages.

  • In the search bar, enter the following URL :

    https://github.com/oBilet/OBCalendar.git
    
  • Choose the package version or branch and click Add Package.

Note

For better performance, use lazyDays: true and lazyMonths: true. If you are using programmatic scroll, set lazyYears: false because subviews need to be loaded into memory once for ScrollViewProxy to recognize their id values.

Usage

  • You can create OBCalendar specifying startDate (default is now) and DrawingRange (day, month or year from startDate) (default drawingRange is .year(1)).

  • Modifiers are optional and you can choose to use baseView or use the packed views (daysView, monthsView) inside the modifiers or you can return your custom view.

  • The first model consists of CalendarModel.Year, CalendarModel.Month and CalendarModel.Day and a view is created for each day using this model in the first block.

  • Modifiers should be written in this order: dayModifier -> monthModifier -> yearModifier

  • baseView in the modifier closures is the default view that has its own custom modification over the previous modifier method's return type, like having a header in months for example.

  • daysView in the monthModifier and monthsView in the yearModifier are the untouched pack of views that will have the modifications from previous modifiers.

  • Every modifier has its own related data type packed as a tuple in the closure parameter list. Default name is "model" and it has CalendarModel.Year, CalendarModel.Month and CalendarModel.Month.

  • The models provided to the closures are: Day + Month + Year for dayModifier, Month +Year for month modifier and only Year for yearModifier.

  • You can fully customize the view for each day, month, and year using dayModifier, monthModifier and yearModifier which do take ViewBuilder blocks.

  • This structure provides a seamless and dynamic user experience.

  • If you'd like to create the calendar from scratch, you can use the base version of it as well. You can customize it even further by setting sart and end dates to generating and providing your own date array for custom layouts.

Default:

// 1 year of drawing range
OBCalendar(drawingRange: .year(1))

// 3 months of drawing range
OBCalendar(drawingRange: .month(3))

// 60 days of drawing range
OBCalendar(drawingRange: .day(60))

Double selection example:

OBCalendar()
   .dayModifier { baseView, model in
      let date = model.day.date
      let targetView = baseView
         .onTapGesture {
            if firstSelectedDate == nil {
               firstSelectedDate = date
            } else if secondSelectedDate == nil {
               secondSelectedDate = date
            } else {
               secondSelectedDate = nil
               firstSelectedDate = date
            }
         }
   
      if date == firstSelectedDate {
         targetView
            .background(firstSelectedBackground)
      } else if date == secondSelectedDate {
         targetView
            .background(secondSelectedBackground)
      } else if isBetweenSelected(date: date) { //date > firstSelectedDate && date < secondSelectedDate
         targetView
            .background(betweenSelectedBackground)
      } else {
         targetView
      }
   }

Horizontal Scroll:

GeometryReader { geometry in
      OBCalendar(
          monthScrollAxis: .horizontal,
          yearScrollAxis: .horizontal
      )
      .monthModifier { baseView, daysView, model in
          baseView
              .padding()
              .frame(width: geometry.size.width)
      }
}

DayModifier:

 OBCalendar()
      .dayModifier { baseView, model in
          baseView
              .background(Color.blue)
              .padding(2)
              .foregroundColor(.white)
      }

MonthModifier:

OBCalendar()
      .monthModifier{ baseView, daysView, model in
          VStack {
              Text("Modified Months")
              daysView
          }
          .padding()
      }

Modified Day + Modified Month:

OBCalendar()
      .dayModifier { baseView, model in
          baseView
              .foregroundColor(Color(.red))
      }
      .monthModifier { baseView, daysView, model in
          VStack {
              Text("Modified Months")
              daysView
          }
          .padding()
      }

BaseCalendar

let today = Date()
let twoYearsLater = calendar.date(byAdding: .year, value: 2, to: today)!

OBBaseCalendar(startDate: today, endDate: twoYearsLater) { model, scrollProxy in
    // day view goes here
    let day = model.day
    Text("\(day.day)")
} monthContent: { model, scrollProxy, daysView in
    // month view goes here
    daysView
} yearContent: { model, scrollProxy, monthsView in
    // year view goes here
    monthsView
}

BaseCalendar + Custom layouts

//Implement your own layout
let years = [CalendarModel.Year]() 

// Or use default layout
let defaultLayout = CalendarModelBuilder.defaultLayout(
      calendar: .current,
      startDate: Date(),
      endDate: Date().addingTimeInterval(3600 * 24 * 365)
)

OBBaseCalendar(years: years) { model, scrollProxy in
    // day view goes here
    let day = model.day
    Text("\(day.day)")
} monthContent: { model, scrollProxy, daysView in
    // month view goes here
    daysView
} yearContent: { model, scrollProxy, monthsView in
    // year view goes here
    monthsView
}

Feel free to explore the SwiftUI-powered flexibility of OBCalendar to meet your custom calendar needs!

About

OBCalendar is designed for simplicity and customization, it allows you to build beautiful and functional calendar interfaces effortlessly.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages