Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/simonberner/calendar-widget
Swift Calendar Widget - Core Data
https://github.com/simonberner/calendar-widget
appintents coredata swift swiftui widgetkit
Last synced: about 2 months ago
JSON representation
Swift Calendar Widget - Core Data
- Host: GitHub
- URL: https://github.com/simonberner/calendar-widget
- Owner: simonberner
- License: mit
- Created: 2022-12-13T14:00:26.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-06T21:04:10.000Z (11 months ago)
- Last Synced: 2024-02-06T22:24:33.104Z (11 months ago)
- Topics: appintents, coredata, swift, swiftui, widgetkit
- Language: Swift
- Homepage:
- Size: 5.88 MB
- Stars: 6
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Calendar Widget - Core Data
This App shows how one can migrate an existing App which is using a Core Data App container, to an App with a Widget Extension and a shared Core Data
container for both parts in place.
---
## Contents
* [Functionality](#functionality)
* [Definitions](#definitions)
* [Tech Stack](#tech-stack)
* [Frameworks](#frameworks)
* [Device Compatibility](#device-compatibility)
* [Screenshots](#screenshots)
* [Learnings](#learnings)
* [Testing](#testing)
* [Code Comments](#code-comments)
* [Pull Requests](#pull-requests)
* [Credits](#credits)
---
## Functionality
### App
- In the calendar view the user can define/select days of study in the current month.
- The streak view shows the user for how many days they have studied in a row. As streak days count only those days, where the user has studied for at least the current or past day (from the current day) descending.
### Widget Extension
- The Widget updates in real time to the changes made in the App and automatically at the end of each day.
- As it is a medium sized Widget, there are two touch targets on it. One that deep links into the StreakView and the other into the CalendarView of the App.
## Definitions
- [First day of the week](https://www.timeanddate.com/calendar/days/first-day-of-the-week.html) is Monday.
## Tech Stack
- Xcode 15.2
- Swift 5.9.2
## Frameworks
- SwiftUI
- WidgetKit
- CoreData
## Device Compatibility
- iPhone iOS 17.2+
- iPad iOS 17.2+
## Screenshots
| Calendar View | Streak View | Widget View |
| :---: | :---: | :---: |
| 
| 
| 
|
| Lock Screen Widgets |
| :---: |
| 
|
## Learnings
### Widget
- In a Widget we should NOT make async network calls (according to Apple), because of that we can't use the property wrapper '@FetchRequest' in a Widget.
#### Touch Targets (Deep linking into the App)
- Deep linking from the Widget into the App can be made by wrapping a view with ```Link()```. This is only available on a medium and a large Widget. We can not have more than one touch targets on a small widget. The only touch target on a small widget is the whole widget.
- On a small widget, we would use the view modifier ```.widgetURL()```
- SwiftCalendarApp: here we have to tag the views for deep-linking
### Calendar
- [The first day of the week](https://www.timeanddate.com/calendar/days/first-day-of-the-week.html) depends on where you are in the world.
- Calendar.Component.weekday -> The weekday units are the numbers 1 through N (where for the Gregorian calendar N=7 and 1 is Sunday).
### Core Data
- [Core Data](https://en.wikipedia.org/wiki/Core_Data) is a persistence framework.
- [SQLite](https://www.sqlite.org) is the CoreData database engine
- An AppGroup allows us to share one or more CoreData containers among multiple apps.
- If you already have an existing App with a CoreData container in place, you have to do a data migration to share that container with
another App, Widget Extension or App Clip.
### SwiftData
- [SwiftData](https://codewithchris.com/swift-data/)
- Same as CoreData, SwifttData uses SQLite as its database engine.
### SwiftUI Preview
- The benefit of having previews is to help you building your UI quickly.
- Don't invest too much time in maintaining your previews.
- It probably doesn't make sense to fetch some data in the preview code.
### How to make code available or unavailable for different platform versions
- [@available and #available](https://www.avanderlee.com/swift/available-deprecated-renamed/#the-difference-between-available-and-available)
- @available: is used when a class or method shall only be [made available](https://www.avanderlee.com/swift/available-deprecated-renamed/#setting-the-availability-for-a-class-or-method) to specific iOS versions.
- #available: is used to execute pieces of code in your flow (if #available(...) else {}) only for specific iOS versions.
- There are also attributes values for: deprecated, obsoleted, renamed, unavailable
### Other cool stuff
- [A Tour through Swift Attributes - Marco Eidinger](https://watch.softinio.com/w/d6jiJFm5hEFrzmKw9kdgXC)
- [Create your own Xcode code snippets](https://www.youtube.com/watch?v=GaV8iLGeVrc)
## Testing
I use the [Arrange, Act and Assert Pattern](https://automationpanda.com/2020/07/07/arrange-act-assert-a-pattern-for-writing-good-tests/) for Unit Testing.
## Code Comments
I like putting in the effort of adding comments to my code, [here is why](https://www.youtube.com/watch?v=1NEa-OcsTow).
## Pull Requests
When I create PRs I stick to [this guideline](https://www.youtube.com/watch?v=_sfzAOfY8uc).
## Credits
🙏🏽 Sean Allen
Made with a 🙂 Simon Berner