SwiftUI 中缺少的优雅全屏日历
优雅日历
ElegantCalendar是用SwiftUI编写的高效且可自定义的全屏日历。
ElegantTimeline - Shows what's possible using ElegantCalendar
Comes with 8 default themes. You can also configure your own theme. Read more to find out.
Introduction
ElegantCalendar
is inspired by TimePage and is part of a larger repository of elegant demonstrations like this: TimePage Clone. It uses ElegantPages, another library I wrote specifically for paging so check that out :)
It is mainly meant to be used with apps that require the use of a calendar to function(like ElegantTimeline), not as a full screen date picker(the demo demonstrates how to do so if you really want to).
Features:
- Display months and years in a full screen vertical scrolling layout
- Custom layout system that allows virtually infinite date ranges with minimal increasing memory usage
- Customization of individual day views
- Customization of the calendar color scheme, light and dark
- Customization of the accessory view displayed when selecting a day
- Excluding certain days from being selectable on the calendar
- Scrolling to a particular day, month, or year with or without animation
- Built in button that scrolls back to today’s month or year
- Flexibility in either using the full calendar view that has both the monthly and yearly view or just one of the individual views
- Haptics when performing certain actions
- Intuitive navigation between the yearly and monthly view: swipe between views or tap on the month header to navigate to the yearly view
- Elegant default themes
Basic usage
Using is as easy as:ElegantCalendar
However, if you just want an individual view, not the entire calendar view, you can do either:
How it works
ElegantCalendarView
uses the ElegantHPages
view from ElegantPages
. Essentially, it's just a swipable that loads all the views immediately. And it's also for this reason that it is not recommended that should not be used as a date picker. Here's why.HStack
ElegantCalendarView
Let's first talk about the monthly calendar where you can swipe up and down to see the next/previous month. This view uses ElegantVList
and is really efficient memory and performance wise. When it comes to the yearly calendar, performance is just as amazing. However, the catch is that all the year views have to be loaded into memory and drawn onto the screen first. This takes a few seconds depending on your date range, the wider the longer. However, once this loading process is over, the calendar functions smoothly and elegantly.
So how can this be fixed? Either create a simpler yearly calendar that doesn't require as much CoreGraphics drawing as the current one or load the year views on demand. The problem with the second approach is that SwiftUI is just inefficient at making views, as it spends a LOT of CPU on rendering. Hopefully, in future iterations of SwiftUI, the rendering becomes smoother. As for the former approach, it seems the most feasible and I will consider implementing it if enough people display interest. Just make an issue about it so I can tell.
Customization
ElegantCalendarManager
configuration
: The configuration of the calendar view
initialMonth
: The initial month to display on the calendar. If not specified, automatically defaults to the first month.
datasource
: The datasource of the calendar
This allows you to customize the opacity of any given day, whether you want a day to be tappable or not, and the accessory view that shows when a day is tapped.
delegate
: The delegate of the calendar
This is just a convenience to handle the shortcomings of the wrapper which doesn't support . Conform to this if you need to do things when a month is displayed or date changes.@Published
didSet
theme
: The theme of various components of the calendar. Default is royal blue. Available for & & .ElegantCalendarView
YearlyCalendarView
MonthlyCalendarView
To configure your own theme, just pass in your color into the initializer. To have dynamic appearance, make sure your has both a light and dark appearance.CalendarTheme
Color
horizontal
or : The orientation of the calendar. The default is , as shown in the GIF. Available for & & .vertical
horizontal
ElegantCalendarView
YearlyCalendarView
MonthlyCalendarView
allowsHaptics
: Whether haptics is enabled or not. Default is enabled. Available for ElegantCalendarView
& MonthlyCalendarView
Users get haptics whenever they tap a day, scroll to a new month, or press the scroll back to today button.
frame
: Custom width for the monthly calendar view. Available for MonthlyCalendarView
Use Cases
The following aspects of can be used:ElegantCalendarManager
var currentMonth: Date
- The current month displayed on the calendar view.
var selectedDate: Date?
- The date selected on the calendar view, if any.
var isShowingYearView: Bool
- Whether the year view is showing. If false, the month view is showing.
func scrollToMonth(_ month: Date, animated: Bool = true)
- Scroll back to a certain month, animated or not. No date is selected in the process.
func scrollBackToToday(animated: Bool = true)
- Scroll back to today, animated or not. Today's date is selected in the process.
func scrollToDay(_ day: Date, animated: Bool = true)
- Scroll back to a certain date, animated or not. The date is selected in the process.
Demos
The demos shown in the GIF can be checked out on example repo.
Installation
ElegantCalendar
is available using the Swift Package Manager:
Using Xcode 11, go to and enter https://github.com/ThasianX/ElegantCalendarFile -> Swift Packages -> Add Package Dependency
If you are using , you can also add as a dependency easily.Package.swift
ElegantCalendar
Inside whatever app is using or your that uses as a dependency:ElegantCalendar
Swift Package
ElegantCalendar
- Scroll the project navigator down to the section. Inside , you'll see a directory called .
Swift Package Dependencies
ElegantCalendar
ElegantCalendar.xcassets
- After you've located it, open your project's settings and navigate to your target's build phases in a parallel window.
- Drag into your target's . Make sure that is unticked and is ticked. This step is crucial because uses custom icons, which will support in Swift 5.3.
ElegantCalendar.xcassets
Copy Bundle Resources
Copy items if needed
Create groups
ElegantCalendar
SPM
- This last step is for making sure that when others clone your repository, the assets will be available to them as well. Click the that has appeared in your project navigator and in the inspector on the right, select . Inside, make sure that is set to .
ElegantCalendar.xcassets
Identity and Type
Location
Relative to Build Products
If you don't know how to do this, refer to the .Demo
Requirements
- iOS 13.0+
- Xcode 11.0+
Contributing
If you find a bug, or would like to suggest a new feature or enhancement, it'd be nice if you could search the issue tracker first; while we don't mind duplicates, keeping issues unique helps us save time and considates effort. If you can't find your issue, feel free to file a new one.
Resources
Also, here's a dump of resources I found useful when working on this
License
This project is licensed under the MIT License - see the LICENSE file for details